exosim 2.0.0rc2

ExoSim 2 is the next generation of the Exoplanet Observation Simulator (ExoSim) tailored for spectro-photometric observations of transiting exoplanets from space, ground, and sub-orbital platforms. This software is a complete rewrite implemented in Python 3, embracing object-oriented design principles.

ExoSim 2.0

Introduction

ExoSim 2 is the next generation of the Exoplanet Observation Simulator ExoSim tailored for spectro-photometric observations of transiting exoplanets from space, ground, and sub-orbital platforms. This software is a complete rewrite implemented in Python 3, embracing object-oriented design principles, which allow users to replace each component with their functions when required.

Table of contents

• ExoSim 2.0
  • Introduction
  • Table of contents
  • How to install
    • Install from PyPI
    • Install from source code
      • Test your installation
  • Documentation
    • Build the html documentation
    • Build the pdf documentation
  • How to contribute
  • How to cite

How to install

Install from PyPI

ExoSim 2.0 is available on PyPI and can be installed via pip as

pip install exosim

Install from source code

ExoSim 2.0 is compatible (tested) with Python 3.8, 3.9 and 3.10

To install from source, clone the repository and move inside the directory.

Then use pip as

pip install .

Test your installation

If you have installed ExoSim from source-code, to test your ExoSim2 installation simply run from the main ExoSim2 folder

pip install -e ".[test]"
python -m unittest discover -s tests

Documentation

ExoSim2 comes with an extensive documentation, which can be built using Sphinx. The documentation includes a tutorial, a user guide and a reference guide.

To build the documentation, install the needed packages first via:

pip install -e ".[docs]"

Build the html documentation

To build the html documentation, move into the docs directory and run

make html

The documentation will be produced into the build/html directory inside docs. Open index.html to read the documentation.

Build the pdf documentation

To build the pdf, move into the docs directory and run

make latexpdf

The documentation will be produced into the build/latex directory inside docs. Open exosim2.pdf to read the documentation.

Here is reported the use of pdflatex, if have another compiler for LaTex, please refer to sphinx documentation.

How to contribute

You can contribute to ExoSim 2.0 by reporting bugs, suggesting new features, or contributing to the code itself. If you want to contribute to the code, please follow the steps described in the documentation under Developer guide/Contributing guidelines.

How to cite

A dedicated publication has been submitted and the relative information will be published soon. In the meanwhile, please, send an email to the developers.