APOG_public/SP2XR
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
bertoz_b
2025-06-06 11:55:49 +02:00
parent 9e0e541c9a
commit 62d602a101
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,6 +1,6 @@
# SP2XR
This repository contains python functions and template scripts to analyze SP2-XR data with the Python library Dask.
This repository contains python functions and template scripts to analyze SP2-XR data with Python.
## Suggested structure for the data
@ -17,7 +17,7 @@ This repository contains python functions and template scripts to analyze SP2-XR
- **SP2XR_pbp_processed_1min**
Directory automatically generated by `resample_to_dt`. It contains files at the same process level of SP2XR_pbp_processed but at the specified time resolution.
# Suggested structure for the converted
# Suggested structure for the code
❔ Do you want to use git to track your analysis code?
- **Yes!**
1. Create a repository for the analysis of your specific dataset (from here on this is referred as main repository)
@ -49,3 +49,7 @@ The different blocks correspond to these actions:
5. From .sp2b to parquet. See notes below for the analysis of the raw traces. This block can usually be skipped.
6. Process the sp2b.parquet files
# Known bugs and missing features
1. Missing feature: Currently, the code doesn't take into account the sampling frequency, it assumes all BC and BC-free particles are recorded in the PbP file.
2. Bug: When calculating the distributions (histrograms) with time resolution different than 1s, the calculation is wrong! Currently, to have correctly calcualted distributions you have to process the data at 1s and then average at 1min.