Usage#
Above: The logo for frogr, designed with the PhyloPic CC0 1.0 Universal Public Domain image of bufo bufo (Linnaeus 1758). The name frogr comes as a nod to the 1997 Hasbro Interactive game Frogger: He’s Back!.
The following documentation assumes the user is familiar with TauREx 3.1, and has marginal familiarity with basic Python programming, the command line, and basic Anaconda Python editors. Documentation for TauREx 3.1 can be found here. For any issues with the use of frogr, please contact michellebieger@live.com.
There are two ways in which you can use frogr: either through passing a .par file through to TauREx 3.1, or with Python with a preferred code editor such as Jupyter Notebooks or the command line.
Par file use#
To use frogr when running a retrieval or forward model on command line, in a HPC server or similar, you can use the example .par file included in the Git repository of frogr, under the folder called input_examples. Note that when requesting to use frogr as your chemistry model, the following keywords are equally acceptable: “ATMO”, “atmo”,”frogr”.
Using with Python in a code editor#
If you have Git cloned the frogr directory, you will find a folder called input_examples, which provides a Jupyter Notebook tutorial in which frogr is first used as a forward model for an example hot Jupiter exoplanet, WASP-79b. This Notebook then subsequently demonstrates how to incorporate frogr in a trial retrieval, which can be run on a laptop. This syntax shown in the Notebook demonstrates how frogr can be used in Python.
What parameters can frogr contribute to TauREx 3.1?#
Chemical equilibrium#
The following parameters can be retrieved using ATMO:
Retrievable parameter |
Units |
|---|---|
Condensation of water |
Title |
Metallicity |
Solar metallicity units |
ATMO has the following molecules for which volume-mixing ratios can be calculated in the atmosphere: H, He, C, No, O, Na, K, Si, Ar, Ti, V, S, Cl, Mg, Al, Ca, Fe, Cr, Li, Cs, Rb, F, P.
Chemical disequilibrium#
The chemical disequilibrium code of ATMO cannot as yet be used with TauREx; however construction is ongoing and the next version of frogr will likely implement this functionality.
Reminder: please cite properly when using frogr#
Please cite the following if using frogr in your publication: