Installation

Installing Cloudy

sunbather has been developed and tested with Cloudy v17.02 and v23.01. Newer versions of Cloudy are likely also compatible with sunbather, but this has not been thoroughly tested. Therefore, we currently recommend using v23.01. Complete Cloudy download and installation instructions can be found here. In short, for most Unix systems, the steps are as follows:

1. Go to the v23 download page and download the "c23.01.tar.gz" file (or go to the v17 download page and download the "c17.02.tar.gz" file).
2. Extract it in a location where you want to install Cloudy.
3. cd into the /c23.01/source/ or /c17.02/source/ folder and compile the code by running make.
4. Quickly test the Cloudy installation: in the source folder, run ./cloudy.exe, type "test" and hit return twice. It should print "Cloudy exited OK" at the end.

If you have trouble installing Cloudy, we refer to the download instructions linked above, as well as the Cloudy help forum.

Installing sunbather

1. Clone sunbather from Github. The code runs entirely in Python. It was developed using Python 3.9.0 and the following packages are prerequisites: numpy (v1.24.3), pandas (v1.1.4), matplotlib (v3.7.1), scipy (v1.8.0), astropy (v5.3), p-winds (v1.3.4). sunbather also succesfully ran with the newest versions (as of Sep. 18, 2023) of these packages. We have however not yet thoroughly tested all of its functionality with these newer versions, so we currently cannot guarantee that it works, but feel free to try! In any case, we recommend making a Python virtual environment to run sunbather in.
2. Create a directory anywhere on your machine where the code will save all models/simulations/etc. This will be the "project" folder, and you can give it any name you like. This is to keep the output of sunbather separate from the sunbather source code.
3. Set an environmental variable $CLOUDY_PATH to your Cloudy installation base directory, and set $SUNBATHER_PROJECT_PATH to the "project" folder. We recommend setting these in your ~/.bashrc or ~/.zshrc file:

   export CLOUDY_PATH="/full/path/to/c23.01/"
   export SUNBATHER_PROJECT_PATH="/full/path/to/project/folder/"
   

4. Copy the /sunbather/planets.txt file to your project folder.
5. Copy the stellar spectra from /sunbather/stellar_SEDs/ to $CLOUDY_PATH/data/SED/ . These include the MUSCLES spectra.
6. Test your sunbather installation: run /sunbather/tests/test.py, which should print "Success". If the test fails, feel free to open an issue or contact [email protected] with your error.

Getting started

1. To get familiar with sunbather, we recommend you go through the Jupyter notebooks in the /sunbather/examples/ folder, where example use cases (such as creating atmospheric profiles, calculating transmission spectra and fitting observational data) are worked out and explained.
2. For more details on how to use the code, check out the Glossary and FAQ pages on this wiki. We specifically recommend you read the glossary sections "The planets.txt file" and "Stellar SED handling".