Metadata-Version: 2.1
Name: exorad
Version: 2.1.68
Summary: The generic point source radiometric model
Home-page: https://github.com/ExObsSim/ExoRad2-public
Author: Lorenzo V. Mugnai, Enzo Pascale
Author-email: lorenzo.mugnai@uniroma1.it
License: BSD-3-Clause
Description: [![Documentation Status](https://readthedocs.org/projects/exorad2-public/badge/?version=latest)](https://exorad2-public.readthedocs.io/en/latest/?badge=latest)
        
        # 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](https://link.springer.com/article/10.1007%2Fs10686-020-09676-7))
        
        ## Installation
        To install ExoRad download the git archive and from the `ExoRad` folder run
        
            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 `ExoRad/examples` folder. From the `Exorad` 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 documentation is available [here](https://exorad2-public.readthedocs.io/en/latest/) 
        
        Or you can build the documentation yourself using `sphinx` . To install it run
            
            pip install sphinx sphinx_rtd_theme
            
        From the `Exorad/docs` folder running
            
            cd docs
            make html
        
        Then you will find the html version of the documentation in `Exorad/doc/build/html/index.html`.
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Provides: exorad
Requires-Python: >=3.8
Description-Content-Type: text/markdown
