Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 3.82 KB

README.md

File metadata and controls

77 lines (54 loc) · 3.82 KB

Synthesizer

workflow Documentation Status Contributions welcome pre-commit Ruff License: GPLv3

Synthesizer is a python package for generating synthetic astrophysical observables. It is modular, flexible and fast.

Read the documentation here.

Getting Started

First clone the latest version of synthesizer

git clone https://github.com/flaresimulations/synthesizer.git

To install, enter the synthesizer directory and install with pip.

cd synthesizer
pip install .

We also provide optional dependency sets for development (dev), testing (test), and building the documentation (docs) should you ever needed them. To install all dependancies simply run the following (or delete as appropriate to get a specific subset):

pip install .[dev,test,docs]

Make sure you stay up to date with the latest versions through git:

git pull origin main

Contributing

Please see here for contribution guidelines.

Citation & Acknowledgement

A code paper is currently in preparation. For now please cite Vijayan et al. 2021 if you use the functionality for producing photometry, and Wilkins et al. 2020 if you use the line emission functionality.

@article{10.1093/mnras/staa3715,
  author = {Vijayan, Aswin P and Lovell, Christopher C and Wilkins, Stephen M and Thomas, Peter A and Barnes, David J and Irodotou, Dimitrios and Kuusisto, Jussi and Roper, William J},
  title = "{First Light And Reionization Epoch Simulations (FLARES) -- II: The photometric properties of high-redshift galaxies}",
  journal = {Monthly Notices of the Royal Astronomical Society},
  volume = {501},
  number = {3},
  pages = {3289-3308},
  year = {2020},
  month = {11},
  issn = {0035-8711},
  doi = {10.1093/mnras/staa3715},
  url = {https://doi.org/10.1093/mnras/staa3715},
  eprint = {https://academic.oup.com/mnras/article-pdf/501/3/3289/35651856/staa3715.pdf},
}

@article{10.1093/mnras/staa649,
  author = {Wilkins, Stephen M and Lovell, Christopher C and Fairhurst, Ciaran and Feng, Yu and Matteo, Tiziana Di and Croft, Rupert and Kuusisto, Jussi and Vijayan, Aswin P and Thomas, Peter},
  title = "{Nebular-line emission during the Epoch of Reionization}",
  journal = {Monthly Notices of the Royal Astronomical Society},
  volume = {493},
  number = {4},
  pages = {6079-6094},
  year = {2020},
  month = {03},
  issn = {0035-8711},
  doi = {10.1093/mnras/staa649},
  url = {https://doi.org/10.1093/mnras/staa649},
  eprint = {https://academic.oup.com/mnras/article-pdf/493/4/6079/32980291/staa649.pdf},
}

Licence

GNU General Public License v3.0