Skip to main content

ExoSim 2

codecov License PyPI - Version GitHub tag (with filter) Downloads Documentation Status ascl.net DOI arXiv EMACS Ask DeepWiki GitDiagram

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: the canonical shared guide (agents.md standard), for any repository-aware agent.
  • 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.

MCP server integration

ExoSim 2 provides an optional Model Context Protocol (MCP) server that lets an MCP-compatible AI client interact with ExoSim in a controlled way:

  • Ask questions grounded in ExoSim documentation and source code (not guessing)
  • Validate configuration files
  • Run simulation pipelines
  • Inspect output files
  • Get customisation guidance

The MCP server is a wrapper around existing ExoSim APIs for AI tools. It does not add new scientific features to ExoSim.

Install with (the wheel ships the documentation, examples and reference configurations the server answers from, so no checkout is needed):

pip install "exosim[mcp]"

Start the server:

exosim-mcp

With execution enabled the server runs ExoSim recipes and configuration-referenced Python tasks on your machine; use exosim-mcp --no-exec for a question-and-validation-only server. The HTTP/SSE transports (--transport http|sse) have no authentication and bind to 127.0.0.1 by default. Semantic search is optional: pip install "exosim[mcp,mcp-embeddings]" and EXOSIM_MCP_RETRIEVAL=hybrid.

See docs/source/user/mcp.rst for client setup, the available tools, the safety model and the known limits.

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:

Mugnai, L.V., Bocchieri, A., Pascale, E. et al. ExoSim 2: the new exoplanet observation simulator applied to the Ariel space mission. Exp Astron 59, 9 (2025).

Metadata

Release files for exosim 2.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for exosim 2.3.0
File Size Uploaded Provenance Actions
exosim-2.3.0.tar.gz 2.5 MB With provenance Details for exosim-2.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for exosim 2.3.0
File Interpreter ABI Platform Actions
exosim-2.3.0-py3-none-any.whl Python 3 none any Details for exosim-2.3.0-py3-none-any.whl

Total release size: 5.3 MB

Release files / exosim-2.3.0.tar.gz

Download URL exosim-2.3.0.tar.gz
Size 2.5 MB
Tags Source
SHA-256 checksum
How to use checksums
6ad12e613c4975a3c9c06ea1ed501378cf89f1f549279384b365f82a737c2255
BLAKE2b-256 checksum
How to use checksums
2c5f807e22d4772988a567b52d65452173dc26d2b0f1c1e87f3b7d985d69cf16
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 18, 2026.

Transparency log

Release files / exosim-2.3.0-py3-none-any.whl

Download URL exosim-2.3.0-py3-none-any.whl
Size 2.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0cd748a9d2a8b6f6f0b2d4ab41b097eb3cc429bcbf6858e5a48b941e90147cff
BLAKE2b-256 checksum
How to use checksums
fe22ebf498ab726d33e1b29466ee08efe89c4b0a36a7c5dca8ad8b2b5cfe90fb
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 18, 2026.

Transparency log

Security for exosim 2.3.0

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.

Select from 2 files

Attestation for exosim-2.3.0.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 18, 2026.

Transparency log

A 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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page