exosim
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.
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: arxiv.org, springer.com -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.0%) to scientific vocabulary
Repository
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.
Basic Info
- Host: GitHub
- Owner: arielmission-space
- License: bsd-3-clause
- Language: Python
- Default Branch: main
- Homepage: http://exosim2-public.readthedocs.io/
- Size: 55.3 MB
Statistics
- Stars: 12
- Watchers: 6
- Forks: 0
- Open Issues: 0
- Releases: 6
Metadata Files
README.md
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 ExoSim2 installation simply run from the main ExoSim2 folder
pip install poetry
poetry run -m 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.
To build the documentation, install the needed packages first via poetry:
pip install poetry
poetry install --with dev
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 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:
Owner
- Name: arielmission-space
- Login: arielmission-space
- Kind: organization
- Repositories: 1
- Profile: https://github.com/arielmission-space
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Mugnai
given-names: Lorenzo V.
orcid: https://orcid.org/0000-0002-9007-9802
- family-names: Bocchieri
given-names: Andrea
orcid: http://orcid.org/0000-0002-8846-7961
- family-names: Pascale
given-names: Enzo
orcid: http://orcid.org/0000-0002-3242-8154
- family-names: Lorenzani
given-names: Andrea
- family-names: Papageorgiou
given-names: Andreas
title: "ExoSim 2: the new exoplanet observation simulator applied to the Ariel space mission"
doi: 10.1007/s10686-024-09976-2
date-released: 2025-01-24
CodeMeta (codemeta.json)
{
"@context": "https://w3id.org/codemeta/3.0",
"type": "SoftwareSourceCode",
"applicationCategory": "Astronomy",
"author": [
{
"id": "_:author_1",
"type": "Person",
"familyName": "Mugnai",
"givenName": "Lorenzo"
},
{
"id": "_:author_2",
"type": "Person",
"familyName": "Bocchieri",
"givenName": "Andrea"
},
{
"id": "_:author_3",
"type": "Person",
"familyName": "Pascale",
"givenName": "Enzo"
},
{
"id": "_:author_4",
"type": "Person",
"familyName": "Lorenzani",
"givenName": "Andrea"
},
{
"id": "_:author_5",
"type": "Person",
"familyName": "Papageorgiou",
"givenName": "Andreas"
}
],
"codeRepository": "https://github.com/arielmission-space/ExoSim2-public",
"description": "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.",
"downloadUrl": "https://pypi.org/project/exosim/",
"license": "https://spdx.org/licenses/BSD-3-Clause",
"name": "ExoSim2",
"programmingLanguage": "Python 3",
"version": "2.0.0",
"codemeta:contIntegration": {
"id": "https://app.codecov.io/gh/arielmission-space/ExoSim2-public"
},
"continuousIntegration": "https://app.codecov.io/gh/arielmission-space/ExoSim2-public",
"issueTracker": "https://github.com/arielmission-space/ExoSim2-public/issues",
"referencePublication": "https://link.springer.com/article/10.1007/s10686-024-09976-2"
}GitHub Events
Total
- Release event: 2
- Watch event: 10
- Push event: 17
- Create event: 1
Last Year
- Release event: 2
- Watch event: 10
- Push event: 17
- Create event: 1
Packages
- Total packages: 1
-
Total downloads:
- pypi 180 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 6
- Total maintainers: 1
pypi.org: exosim
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.
- Homepage: https://github.com/arielmission-space/ExoSim2-public
- Documentation: https://exosim2-public.readthedocs.io/en/latest/
- License: BSD-3-Clause
-
Latest release: 2.1.1
published 7 months ago