ExoRad 2.0
ExoRad 2.0: The generic point source radiometric model - Published in JOSS (2023)
Science Score: 98.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 10 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org, zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
ExoRad, the generic point source radiometric model.
Basic Info
- Host: GitHub
- Owner: ExObsSim
- License: other
- Language: Python
- Default Branch: master
- Homepage: https://exorad2-public.readthedocs.io/en/latest/
- Size: 22.1 MB
Statistics
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 0
- Releases: 32
Metadata Files
README.md
ExoRad 2.0: The generic point source radiometric model
ExoRad, the generic point source radiometric model, interfaces with any instrument to provide an estimate of several Payload performance metrics.
As an example, for each target and for each photometric and spectroscopic channel, ExoRad provides estimates of:
1) signals in pixels 2) saturation times 3) read noise 4) photon noise 5) dark current noise 6) zodiacal bkg 7) inner sanctum 8) sky foreground
Cite
If you use this software please cite: Mugnai et al., (2023). ExoRad 2.0: The generic point source radiometric model. Journal of Open Source Software, 8(89), 5348, (doi: 10.21105/joss.05348)
Installation
Installing from PyPi
You can install it by doing
pip install exorad
Installing from source
Clone the directory using:
git clone https://github.com/ExObsSim/ExoRad2-public
Move into the ExoRad2 folder.
ExoRad uses Poetry for dependency management and package installation. If you haven't installed Poetry yet, you can do so by running the following command:
pip install poetry
For more details, refer to the official Poetry documentation.
Once Poetry is installed, you can proceed with installing ExoRad:
poetry install
Run
Once Exorad is installed in your system you can run it from console.
Run exorad --help to read the list of accepted keywords.
An example to ExoRad is provide in the ExoRad2/examples folder. From the ExoRad2 directory you can try
exorad -p examples/payload_example.xml -t examples/test_target.csv -o example_run/test.h5
The code output will appear in a directory called example_run
Documentation
The full documentation is available here
Or you can build the documentation yourself using sphinx . To install it run
pip install sphinx sphinx_rtd_theme
From the ExoRad2/docs folder running
cd docs
make html
Then you will find the html version of the documentation in ExoRad2/docs/build/html/index.html.
Owner
- Name: ExObsSim
- Login: ExObsSim
- Kind: organization
- Repositories: 2
- Profile: https://github.com/ExObsSim
JOSS Publication
ExoRad 2.0: The generic point source radiometric model
Authors
Dipartimento di Fisica, La Sapienza Università di Roma, Piazzale Aldo Moro 2, 00185 Roma, Italy, INAF – Osservatorio Astronomico di Palermo, Piazza del Parlamento 1, I-90134 Palermo, Italy, Department of Physics and Astronomy, University College London, Gower Street, London, WC1E 6BT, UK
Dipartimento di Fisica, La Sapienza Università di Roma, Piazzale Aldo Moro 2, 00185 Roma, Italy
Dipartimento di Fisica, La Sapienza Università di Roma, Piazzale Aldo Moro 2, 00185 Roma, Italy
Editor
Dan Foreman-Mackey
Tags
astronomy instrumentation exoplanets instrument simulators Simulated scienceCitation (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
title: "ExoRad 2.0: The generic point source radiometric model"
doi: 10.21105/joss.05348
date-released: 2023-09-26
GitHub Events
Total
- Watch event: 4
Last Year
- Watch event: 4
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Lorenzo Mugnai | l****9@g****m | 85 |
| Derik K | d****k | 1 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 1
- Total pull requests: 3
- Average time to close issues: 14 days
- Average time to close pull requests: about 7 hours
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 1.0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- skendrew (1)
Pull Request Authors
- LJBMyco (1)
- derikk (1)
- dfm (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 30 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 24
- Total maintainers: 1
pypi.org: exorad
The generic point source radiometric model
- Homepage: https://github.com/ExObsSim/ExoRad2-public
- Documentation: https://exorad2-public.readthedocs.io/en/latest/
- License: BSD-3-Clause
-
Latest release: 2.1.127
published over 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite