Welcome to SynthPop's documentation!
====================================

**SynthPop** is an object-oriented, modular Python framework 
for generating synthetic population models. 
It generates a star catalog following the specified model and configuration.

Acknowledge Synthpop 
--------------------
If you think SynthPop was useful for you work, please cite `Klüter & Huston et al. (2025) <https://ui.adsabs.harvard.edu/abs/2024arXiv241118821K/abstract>`_. 
Please also include citations for key components of the generation process. 
These includes, but is not limited, to the used model, isochrone system and extinction map.

Getting in touch
-----------------
If users encounter any issues while using SynthPop during the development/implementation of new submodules or models, 
they can reach out to the development team through the GitHub issue tracker. 
We welcome any feedback, bug reports, or feature requests that can help improve Synthpop.


Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   usage
   configuration
   output
   models
   modules
   changelog
   contributors