| Name | exosim JSON |
| Version |
2.1.0
JSON |
| download |
| home_page | https://github.com/arielmission-space/ExoSim2-public |
| Summary | 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. |
| upload_time | 2025-07-16 16:28:46 |
| maintainer | None |
| docs_url | None |
| author | L. V. Mugnai |
| requires_python | <4.0,>=3.12 |
| license | BSD-3-Clause |
| keywords |
exoplanets
simulation
astronomy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ExoSim 2
[](https://github.com/arielmission-space/ExoSim2.0/actions/workflows/build.yml)
[](https://github.com/arielmission-space/ExoSim2.0/actions/workflows/ci_linux.yml)
[](https://codecov.io/gh/arielmission-space/ExoSim2-public)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://pepy.tech/project/exosim)
[](https://exosim2-public.readthedocs.io/en/latest/?badge=latest)
[](https://ascl.net/2503.031)
[](https://doi.org/10.1007/s10686-024-09976-2)
[](https://arxiv.org/abs/2501.12809)
[](https://emac.gsfc.nasa.gov?cid=2504-003)
## Introduction <a name="introduction"></a>
ExoSim 2 is the next generation of the Exoplanet Observation Simulator [ExoSim](https://github.com/ExoSim/ExoSimPublic) 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](#exosim-2)
- [Introduction ](#introduction-)
- [Table of contents](#table-of-contents)
- [How to install ](#how-to-install-)
- [Install from PyPI ](#install-from-pypi-)
- [Install from source code ](#install-from-source-code-)
- [Test your installation ](#test-your-installation-)
- [Documentation ](#documentation-)
- [Build the html documentation ](#build-the-html-documentation-)
- [Build the pdf documentation ](#build-the-pdf-documentation--)
- [How to contribute ](#how-to-contribute-)
- [How to cite](#how-to-cite)
## How to install <a name="how-to-install"></a>
### Install from PyPI <a name="install-from-source-code"></a>
ExoSim 2 is available on PyPI and can be installed via pip as
pip install exosim
### Install from source code <a name="install-from-source-code"></a>
ExoSim 2 is compatible (tested) with Python 3.12 and 3.13
To install from source, clone the [repository](https://github.com/arielmission-space/ExoSim2-public/) and move inside the directory.
Then use `pip` as
pip install .
#### Test your installation <a name="test-your-installation"></a>
If you have installed ExoSim from source-code, to test your ExoSim2 installation simply run from the main ExoSim2 folder
pip install poetry
poetry run python -m unittest discover -s tests -t tests
## Documentation <a name="documentation"></a>
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 `poetry`:
pip install poetry
poetry install --with dev
### Build the html documentation <a name="build-the-html-documentation"></a>
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 <a name="build-the-pdf-documentation"></a>
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](https://www.sphinx-doc.org/en/master/usage/configuration.html#latex-options).
## How to contribute <a name="how-to-contribute"></a>
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).](https://link.springer.com/article/10.1007/s10686-024-09976-2)
Raw data
{
"_id": null,
"home_page": "https://github.com/arielmission-space/ExoSim2-public",
"name": "exosim",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "exoplanets, simulation, astronomy",
"author": "L. V. Mugnai",
"author_email": "lorenzo.mugnai@uniroma1.it",
"download_url": "https://files.pythonhosted.org/packages/b1/eb/f3b3843da120f40d65c9bc74dfb7a6e86f75b1bc6e52eac81512e2137fd6/exosim-2.1.0.tar.gz",
"platform": null,
"description": "# ExoSim 2\n\n\n[](https://github.com/arielmission-space/ExoSim2.0/actions/workflows/build.yml)\n[](https://github.com/arielmission-space/ExoSim2.0/actions/workflows/ci_linux.yml)\n[](https://codecov.io/gh/arielmission-space/ExoSim2-public)\n[](https://opensource.org/licenses/BSD-3-Clause)\n\n\n[](https://pepy.tech/project/exosim)\n[](https://exosim2-public.readthedocs.io/en/latest/?badge=latest)\n[](https://ascl.net/2503.031)\n[](https://doi.org/10.1007/s10686-024-09976-2)\n[](https://arxiv.org/abs/2501.12809)\n[](https://emac.gsfc.nasa.gov?cid=2504-003)\n\n\n## Introduction <a name=\"introduction\"></a>\n\nExoSim 2 is the next generation of the Exoplanet Observation Simulator [ExoSim](https://github.com/ExoSim/ExoSimPublic) 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.\n\n\n## Table of contents\n\n- [ExoSim 2](#exosim-2)\n - [Introduction ](#introduction-)\n - [Table of contents](#table-of-contents)\n - [How to install ](#how-to-install-)\n - [Install from PyPI ](#install-from-pypi-)\n - [Install from source code ](#install-from-source-code-)\n - [Test your installation ](#test-your-installation-)\n - [Documentation ](#documentation-)\n - [Build the html documentation ](#build-the-html-documentation-)\n - [Build the pdf documentation ](#build-the-pdf-documentation--)\n - [How to contribute ](#how-to-contribute-)\n - [How to cite](#how-to-cite)\n\n## How to install <a name=\"how-to-install\"></a>\n\n### Install from PyPI <a name=\"install-from-source-code\"></a>\n\nExoSim 2 is available on PyPI and can be installed via pip as\n\n pip install exosim\n\n\n### Install from source code <a name=\"install-from-source-code\"></a>\n\nExoSim 2 is compatible (tested) with Python 3.12 and 3.13\n\nTo install from source, clone the [repository](https://github.com/arielmission-space/ExoSim2-public/) and move inside the directory.\n\nThen use `pip` as\n\n pip install .\n\n\n#### Test your installation <a name=\"test-your-installation\"></a>\n\n\nIf you have installed ExoSim from source-code, to test your ExoSim2 installation simply run from the main ExoSim2 folder\n\n pip install poetry\n poetry run python -m unittest discover -s tests -t tests\n\n## Documentation <a name=\"documentation\"></a>\n\nExoSim2 comes with an extensive documentation, which can be built using Sphinx.\nThe documentation includes a tutorial, a user guide and a reference guide.\n\nTo build the documentation, install the needed packages first via `poetry`:\n\n pip install poetry\n poetry install --with dev\n\n\n### Build the html documentation <a name=\"build-the-html-documentation\"></a>\n\nTo build the html documentation, move into the `docs` directory and run\n\n make html\n\nThe documentation will be produced into the `build/html` directory inside `docs`.\nOpen `index.html` to read the documentation.\n\n### Build the pdf documentation <a name=\"build-the-pdf-documentation\"></a>\n\nTo build the pdf, move into the `docs` directory and run\n\n make latexpdf\n\nThe documentation will be produced into the `build/latex` directory inside `docs`.\nOpen `exosim2.pdf` to read the documentation.\n\nHere is reported the use of `pdflatex`, if have another compiler for LaTex, please refer to [sphinx documentation](https://www.sphinx-doc.org/en/master/usage/configuration.html#latex-options).\n\n## How to contribute <a name=\"how-to-contribute\"></a>\n\nYou 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`.\n\n## How to cite\n\nIf you use ExoSim 2 in your research, please cite the following paper:\n\n[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).](https://link.springer.com/article/10.1007/s10686-024-09976-2)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "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.",
"version": "2.1.0",
"project_urls": {
"Documentation": "https://exosim2-public.readthedocs.io/en/latest/",
"Homepage": "https://github.com/arielmission-space/ExoSim2-public",
"Repository": "https://github.com/arielmission-space/ExoSim2-public"
},
"split_keywords": [
"exoplanets",
" simulation",
" astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "154c49d51c53987592fb818667e02d3b4afdf2af77dcd9ae3a9cb1381c886d0a",
"md5": "2b14cf1589d7ad5e50be98b1bb5cc3ef",
"sha256": "17faa8ce0b89882513e1254e026890ad98de4e3b74c767c0489668c5502f7519"
},
"downloads": -1,
"filename": "exosim-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b14cf1589d7ad5e50be98b1bb5cc3ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 1708417,
"upload_time": "2025-07-16T16:28:44",
"upload_time_iso_8601": "2025-07-16T16:28:44.978847Z",
"url": "https://files.pythonhosted.org/packages/15/4c/49d51c53987592fb818667e02d3b4afdf2af77dcd9ae3a9cb1381c886d0a/exosim-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1ebf3b3843da120f40d65c9bc74dfb7a6e86f75b1bc6e52eac81512e2137fd6",
"md5": "02b524dd62835bc546c582d24103009d",
"sha256": "8e2390ca90cdba19e9f1874327f75caa16f5df9d49d7edea8542e3fcd4d09e29"
},
"downloads": -1,
"filename": "exosim-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "02b524dd62835bc546c582d24103009d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 1632378,
"upload_time": "2025-07-16T16:28:46",
"upload_time_iso_8601": "2025-07-16T16:28:46.222330Z",
"url": "https://files.pythonhosted.org/packages/b1/eb/f3b3843da120f40d65c9bc74dfb7a6e86f75b1bc6e52eac81512e2137fd6/exosim-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 16:28:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arielmission-space",
"github_project": "ExoSim2-public",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "exosim"
}
