Skip to main content

The generic point source radiometric model

Project description

PyPI version GitHub release (latest by date) Downloads 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.78.tar.gz (47.1 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.78-py3-none-any.whl (59.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: exorad-2.1.78.tar.gz
  • Upload date:
  • Size: 47.1 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.78.tar.gz
Algorithm Hash digest
SHA256 6bd46a5cfaa12a7a568c106070b2cd6b896a5649e999e9c59d90390158f9f5e5
MD5 14e4ee87b84764d59031bfad3e5e5032
BLAKE2b-256 06d1031caea37ebc5c09a9b7f99bb1603bc6c4ad8b635e875e4bcdcdf0cb0449

See more details on using hashes here.

File details

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

File metadata

  • Download URL: exorad-2.1.78-py3-none-any.whl
  • Upload date:
  • Size: 59.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.78-py3-none-any.whl
Algorithm Hash digest
SHA256 e89f30bf80c3fd80ec986e61e7ca106b6275fbd4daad6fe02e95db0839e86376
MD5 18f7930bc73fcc738be4548190bedefd
BLAKE2b-256 b4dc826e08ccb8809449a7d63af46155ea61f1058e3ff0a77276b839e499d234

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