Documents for 0.1.0 (#117)

* doc

* Update README.md

* doc

* doc

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
 ```

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.

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
-<img width="521" alt="image" src="https://github.com/FaroutYLq/saltax/assets/47046530/9c3ef86c-a171-4082-914a-98f6eee14a58">
+<img width="1700" alt="image" src="https://github.com/FaroutYLq/saltax/assets/47046530/5042d5cd-d42f-4a56-8904-b4911c5efe1c">
+
 
 Here the numbers are marking number of channels in the plugin.