Skip to main content

The generic point source radiometric model

Project description

PyPI version Documentation Status GitHub

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

Reports

The code is under development, so, please report any issue or inaccuracy to the developers to support the implementation.

Cite

ExoRad has been developed from ArielRad. If you use this software please cite: Mugnai et al, "ArielRad: the ARIEL radiometric model", 2020 (doi: 10.1007/s10686-020-09676-7)

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

exorad-2.1.70.tar.gz (45.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

exorad-2.1.70-py3-none-any.whl (58.9 kB view details)

Uploaded Python 3

File details

Details for the file exorad-2.1.70.tar.gz.

File metadata

  • Download URL: exorad-2.1.70.tar.gz
  • Upload date:
  • Size: 45.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for exorad-2.1.70.tar.gz
Algorithm Hash digest
SHA256 fee558f0451af9b62490a60aed44fb41781f6cd061be82b89bd9119ae6da55b9
MD5 32d8e8e8c1d651cdb164761a9cc1f304
BLAKE2b-256 6836bd3f8fa3163f217a0785326986a8123b530181e5ce5b90bd95bfaa15acc2

See more details on using hashes here.

File details

Details for the file exorad-2.1.70-py3-none-any.whl.

File metadata

  • Download URL: exorad-2.1.70-py3-none-any.whl
  • Upload date:
  • Size: 58.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for exorad-2.1.70-py3-none-any.whl
Algorithm Hash digest
SHA256 7b1009310583fc42135f414901d172b02b031fcb977f4063ed1f99444188e5e5
MD5 07e3b09b896f794e4d8d22c087e9b528
BLAKE2b-256 c90c5d417b0e37f06c0a44be929d87bab563e3d26a59f861795fd054b8108515

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page