From 88119924ea0f1adc62dc46d5e13db25d19d337a4 Mon Sep 17 00:00:00 2001 From: Lanqing Yuan Date: Sun, 21 Apr 2024 20:07:48 -0500 Subject: [PATCH] Documents for `0.1.0` (#117) * doc * Update README.md * doc * doc --- README.md | 2 +- notebooks/README.md | 4 ++-- saltax/plugins/README.md | 8 +++++--- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2cebbd1..b7c0520 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # saltax -Salting `wfsim` into `strax` data, followed by comparison and analysis. See this [notes](https://xe1t-wiki.lngs.infn.it/doku.php?id=lanqing:ambience_interference_and_sprinkling#raw_records_simu) to see how it serves physics. +Salting `wfsim` or `fuse` into `strax` data, followed by comparison and analysis. See this [notes](https://xe1t-wiki.lngs.infn.it/doku.php?id=lanqing:ambience_interference_and_sprinkling#raw_records_simu) to see how it serves physics. ## Installation ``` diff --git a/notebooks/README.md b/notebooks/README.md index de03ea0..a06d3c0 100644 --- a/notebooks/README.md +++ b/notebooks/README.md @@ -2,7 +2,7 @@ These are notebooks for hopefully pedagogical purpose. Due to the sensitive information, all the outputs have been removed. ## `example_events.ipynb` -An example of using this framework to sprinkle events into real data, with followed analysis functions defined in this package. +An example of using this framework to sprinkle events into real data, with followed analysis functions defined in this package. This notebook is using the `wfsim` based method. ## `example_peaks.ipynb` -An example of using this framework to sprinkle single electron peaks (with realistic timestamps and XY information passing SE selection, based on bootstrapping data SEs) into real data, with followed analysis functions defined in this package. +An example of using this framework to sprinkle single electron peaks (with realistic timestamps and XY information passing SE selection, based on bootstrapping data SEs) into real data, with followed analysis functions defined in this package. This notebook is using the `wfsim` based method. diff --git a/saltax/plugins/README.md b/saltax/plugins/README.md index 49fee44..35784c1 100644 --- a/saltax/plugins/README.md +++ b/saltax/plugins/README.md @@ -1,11 +1,13 @@ # Plugins ## Scope -Modified `straxen` [data structure](https://straxen.readthedocs.io/en/latest/reference/datastructure_nT.html) up to `peaklets`. Everything above is designed to be exactly the same as `straxen`. +Modified `straxen` and `fuse` [data structure](https://straxen.readthedocs.io/en/latest/reference/datastructure_nT.html) up to `peaklets`. Everything above is designed to be exactly the same as `straxen`. ## Structure -- `s_raw_records.py`: Modified `raw_records` specifically for simulated `raw_records`, which determine chunking time range based on the ones' from `raw_reocrds` +- `f_raw_records.py`: `fuse` based plugins. Modified `ChunkCsvInput` from `fuse ` specifically for `raw_records_simu`, which determine chunking time range based on the ones' from `raw_reocrds` +- `s_raw_records.py`: `wfsim` based plugins. Modified `raw_records` specifically for `raw_records_simu`, which determine chunking time range based on the ones' from `raw_reocrds` - `records.py`: Modified `records`, which combines `raw_reords` and `raw_records_simu` together. The latter one's channel starts at constant variable `SCHANNEL_STARTS_AT`. - `peaklets.py`: Modified `peaklets`, which build peaks as there are `2*n_tpc_pmts` channels, but sum up per-channel information (`area_per_channel` and top-bottom specific fields) as if there are only `n_tpc_pmts`. ## Data Structure -image +image + Here the numbers are marking number of channels in the plugin.