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:
- signals in pixels
- saturation times
- read noise
- photon noise
- dark current noise
- zodiacal bkg
- inner sanctum
- 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.
1 maintainer
Metadata
1 maintainer
Release files for exorad 2.1.127
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| exorad-2.1.127.tar.gz | 1.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| exorad-2.1.127-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.1 MB
Release files / exorad-2.1.127.tar.gz
| Download URL | exorad-2.1.127.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d0b0efbb95af7543ff7b8f0080df6b0109c49533f77c605b4779031d71df2d76
|
|
BLAKE2b-256 checksum How to use checksums |
41b5a2a48de11102f3bba4a31adf11f7a400b7160de6865b7b220bd13d77c20c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
Release files / exorad-2.1.127-py3-none-any.whl
| Download URL | exorad-2.1.127-py3-none-any.whl |
|---|---|
| Size | 1.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa46bbbbbb6e5ab322aed128296df27c838aaad6a8773532f58ee5aa9029bd66
|
|
BLAKE2b-256 checksum How to use checksums |
80b2f5158ef1010b22b5186064466d1e02f416a16767f39cf7c83894320b8eb6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
