The generic point source radiometric model
Project description
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.
Then install
pip 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
