ExoSim 2
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
How to install
Install from PyPI
ExoSim 2 is available on PyPI and can be installed via pip as
pip install exosim
Install from source code
ExoSim 2 is compatible (tested) with Python 3.12 and 3.13
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 ExoSim 2 installation simply run from the main ExoSim 2 folder:
uv sync --dev
uv run pytest 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. The published documentation is at https://exosim2-public.readthedocs.io/.
An AI-generated overview of the codebase is also available on DeepWiki, and an interactive architecture diagram on GitDiagram. Both are generated automatically from the code and may be out of date or inaccurate: the documentation is the reference.
To build the documentation, install the needed packages first via uv:
uv sync --extra dev,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.
Agentic support for AI assistants
ExoSim 2 includes repository-local guidance for LLM and coding-agent tools. These files help assistants answer questions, choose the correct pipeline, and set up parameters from local evidence instead of guessing scientific defaults.
The support includes:
AGENTS.md: canonical shared guide for OpenCode, Warp and generic repository-aware agents.CLAUDE.md: Claude Code entry point.WARP.md: Warp compatibility entry point..github/copilot-instructions.mdand.github/instructions/: GitHub Copilot repository and path-specific instructions.docs/ai-agents/codebase-map.md: source, documentation, examples and validation map.docs/ai-agents/parameter-setup-guide.md: XML/YAML parameter setup workflow, including__ConfigPath__,<config>includes and unit handling.docs/ai-agents/agent-playbooks.md: reusable roles for parameter setup, pipeline selection, scientific review and developer maintenance.
The rendered documentation page is docs/source/agentic_support.rst.
How to contribute
You can contribute to ExoSim 2 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
If you use ExoSim 2 in your research, please cite the following paper:
Metadata
Release files for exosim 2.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| exosim-2.2.3.tar.gz | 1.7 MB | With provenance | Details for exosim-2.2.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| exosim-2.2.3-py3-none-any.whl | Python 3 | none | any | Details for exosim-2.2.3-py3-none-any.whl |
Total release size: 3.5 MB
Release files / exosim-2.2.3.tar.gz
| Download URL | exosim-2.2.3.tar.gz |
|---|---|
| Size | 1.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
986ce27a63b58995efe36708552c05925454231219c1dbe54db0f84659b38f16
|
|
BLAKE2b-256 checksum How to use checksums |
c34ced2a217201531b8dae85dc9a340cb45b1c8f0e19440b3f28b9be35fb286c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.
Transparency logRelease files / exosim-2.2.3-py3-none-any.whl
| Download URL | exosim-2.2.3-py3-none-any.whl |
|---|---|
| Size | 1.8 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3f1a02e8b5301a9db1ffe78ec8170d089961f0356ff2f90b402d5c28abd6cfe7
|
|
BLAKE2b-256 checksum How to use checksums |
e6dfa640919b2c4d4bb10206981b6b368e1ffb0dc87b44e43c8b336d2a7a6b6e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.
Transparency logSecurity for exosim 2.2.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for exosim-2.2.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 13, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.