🐾 Tempawral

Tempawral is a time-resolved retrieval code designed for the analysis of time-series emission spectra from variable brown dwarfs and giant planets.

This repository provides a demonstration run of Tempawral using a simulated dataset. Tempawral is built upon brewster_v2 (currently under development and available at: https://github.com/fwang23nh/brewster_v2). Future updates to Tempawral will be implemented once a stable version of brewster_v2 is released.

What's needed to run the code:

• Everything in this repository
• Line lists
• Clouds (.mieff files)
• gFortran compiler (https://gcc.gnu.org/wiki/GFortranBinaries or https://hpc.sourceforge.net)

Current Installation Process for Tempawral (Brewster_v2)

1. If you do not have a fortran compiler on your machine, get the proper version of the gfortran compiler from https://gcc.gnu.org/wiki/GFortranBinaries or https://hpc.sourceforge.net.
2. Git clone or fork the directory and place wherever your code lives. (If you plan to make any changes to the code you might like to incorporate into the master branch via a pull request, you should probably fork it.)
3. To keep various package versions clean and organized, you should create a Python 3 environment, ideally Python <=3.11, as that is the version that will be needed to run the code on a cluster. (See list of packages needed in requirements.txt)
4. You will need to get access to the Linelist and Clouds folders that are shared via Dropbox. Place the Clouds and Linelists folders at the same level as this repository:

|-- Clouds/
|-- Linelists/
|--brewster_v2/
   |-- README.md
   |-- data/
|--tempawral/
      

5. Build the code by running ./build in the terminal in the brewster_v2 directory. If you get an error or this is not a fresh build, run make clean before rebuilding the code. This will create ciamod and forwardmodel (which show up as missing imports in brewster.py and testkit.py), as well as various .o, .mod, and .so files.
6. To test that everything is properly installed, run the check_brewster_v2.py file, by typing python check_brewster_v2.py in the terminal making sure you are in the brewster working directory.

Please post any problems to the issue tracker.