diff --git a/README.md b/README.md index 211ecc5..b736107 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ Code for producing fast simulations of the SZ effect for galaxy halos of varying z, $M_{200}$, based on average thermal pressure profile fits from [Battaglia et al. 2012](https://ui.adsabs.harvard.edu/abs/2012ApJ...758...75B/abstract). Simulated submaps can include tSZ signal from these halos, simulated CMB, instrument beam convolution and white noise. -## Installation +## Quickstart + +### Installation We provide an environment specification file for `conda` or `mamba` users at `environment.yml`. With `conda`, an environment is created by `conda env create -f environment.yml`. With `micromamba` the `env` is omitted and a new environment is instead created with `micromamba create -f environment.yml`. @@ -10,7 +12,7 @@ The simulated CMB signal relies on `camb` and utilities for saving rely on `h5py From the top-level directory, you can do `pip install .` -## Usage +### Usage The usage of this code is documented in `notebooks/demo_simulation.ipynb`. A detailed walkthrough of the functions available in this code is in `notebooks/demo_full_pipeline.ipynb`. @@ -18,6 +20,22 @@ A full list of potential inputs is documented in `settings/config.yaml` and you `dm_halo_dist.py` generates a z, $M_{200}$ array. The functions in `make_sz_cluster.py` create pressure profiles, Compton-y, and SZ signal maps from these halos of various z, $M_{200}$ and produce the final simulated submaps. These submaps contain simulated CMB and simple instrument beam convolution from `simtools.py` and white noise from `noise.py`. Plotting tools are provided in `visualization.py`. +### Example + +Let's say you wanted to produce 100 mock halos distributed across the redshift range 0.2