Skip to content

Commit b33a10e

Browse files
committed
Update README
1 parent fb23ab7 commit b33a10e

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,7 @@ The software packages used are
2121
and [mappraiser](https://github.com/B3Dcmb/midapack/tree/gaps-maxL).
2222
They are provided as submodules in the `extern` folder so that the exact setup can be reproduced easily.
2323

24-
The simulation worfklow, `so_mappraiser.py`, is a modified version of a script in sotodlib and can be obtained by running the following command:
25-
```bash
26-
patch extern/sotodlib/sotodlib/toast/scripts/so_sim.py -o so_mappraiser.py < so_sim.patch
27-
```
24+
The simulation worfklow, `so_mappraiser.py`, is a modified version of the `toast_so_sim.py` script in sotodlib.
2825

2926
## Files in this directory
3027

@@ -34,6 +31,7 @@ Setup
3431

3532
* `get_defaults.sh` : Use `so_mappraiser.py` to generate a default parameter file for reference
3633
* `sat.toml` : Master parameter file for the `so_mappraiser.py` workflow
34+
* `sat.par`, `atm.par` : Sets of command line parameters for the workflow
3735
* `ffp10_lensed_scl_100_nside0512.fits` : Input map to be observed during simulation
3836

3937
Schedule files
@@ -48,6 +46,7 @@ Tests (laptop: truncated schedule, decimated focal plane)
4846
* `run.white.uniform.sh` : all detector _pairs_ have the same white noise level (but not detectors in a pair)
4947
* `run.white.variable.sh` : all detectors have different white noise levels
5048
* `run.one_over_f.sh` : all detectors have different 1/f noise parameters
49+
* `run.atm.sh` : in addition to variable instrumental noise, simulate atmosphere
5150
* `tests/syst` : Evaluate the impact of systematic effects on the pair-differencing approach
5251
* `run.atm.cache.sh` : simulate and cache the atmosphere simulation
5352
* `run.baseline.sh` : run the baseline configuration (ideal case)
@@ -56,16 +55,16 @@ Tests (laptop: truncated schedule, decimated focal plane)
5655
Execution (Jean-Zay: full schedule)
5756

5857
* `slurm/run.atm.cache.slurm` : Simulate and cache the atmosphere simulation
59-
* `slurm/run.baseline.slurm` : Run the baseline configuration (ideal case)
60-
* `slurm/run.gains.constant.slurm` : Run with gain errors which are the same for all detector pairs
61-
* `slurm/run.gains.random.slurm` : Run with Gaussian distributed gain errors
58+
* `slurm/get_sample_data.slurm` : Get sample observation data for testing
59+
* `slurm/opti/*`: Run the optimality tests
6260

6361
Post-processing
6462

65-
* `utils.py` : Some utility routines
66-
* `plot_maps.py` : Produce difference maps and histograms for a given run
67-
* `plot_maps_all.py` : Plot difference maps and histograms for all runs under a given directory
68-
* `spectrum.py` : Power spectrum routines
69-
* `get_mask_apo.py` : Create and save a mask (requires [NaMaster](https://namaster.readthedocs.io))
70-
* `compute_spectra.py` : Compute and save power spectra for all runs
63+
* `post/compute_spectra.py` : Compute and save power spectra for all runs
64+
* `post/get_input_spectra.py` : Compute and save power spectra of input map
65+
* `post/get_mask_apo.py` : Create and save a mask (requires [NaMaster](https://namaster.readthedocs.io))
66+
* `post/plot_maps_all.py` : Plot difference maps and histograms for all runs in a root directory
67+
* `post/plot_maps.py` : Produce difference maps and histograms for a given run
68+
* `post/plot_spectra.py` : Plot power spectra recursively for all runs in a root directory
69+
* `post/spectrum.py` : Power spectrum routines
7170
* `slurm/run.spectra.slurm` : Job script to compute power spectra

0 commit comments

Comments
 (0)