GitHub

Getting started

This page outlines requirements and installation steps for the code. Currently, GNU/Linux and MacOS (including ARM) are supported.

Software requirements

  • gfortran
  • netcdf
  • netcdf-fortran
  • make
  • wget
  • unzip
Warning

Do not install Julia using your system package manager. Install only from julialang.org as below.

Installation

Follow the steps below in order to setup the code.

  1. Install Julia's package manager: curl -fsSL https://install.julialang.org | sh
  2. Switch to Julia 1.11: juliaup add 1.11 && juliaup default 1.11
  3. Download AGNI: git clone https://github.com/nichollsh/AGNI.git
  4. Change directory: cd AGNI
  5. Setup SOCRATES by doing either ONE of the following...
    • Follow the instructions on the SOCRATES GitHub page
    • Run ./src/get_socrates.sh
  6. Finally, install AGNI: ./src/get_agni.sh

AGNI is now installed as a package into the Julia environment of the AGNI directory. This will also have downloaded some basic input data and run the tests.

Warning

The RAD_DIR environment variable must be set to your SOCRATES path whenever AGNI is being used. This is so that AGNI can locate the SOCRATES libraries.

Tip

Visit the Troubleshooting page if you encounter any problems. This page can usually resolve your problem.

Testing

If you want to run the tests manually, simply use the script in the test/ folder...

julia test/runtests.jl

This will print information on whether tests passed or failed.

Updating

It's important that you keep AGNI up to date, especially if you are using as part of the PROTEUS framework. Use this script to automatically pull changes from GitHub and download any required data files.

./src/get_agni.sh

Your first model run

The environment variable RAD_DIR must point to the SOCRATES installation directory. The best way to do this is to add RAD_DIR=path/to/socrates/folder/ to your shell rc file (e.g. ~/.bashrc).

Then run AGNI with the default configuration file:

./agni.jl

You should see the following output:

[ INFO  ] Using configuration 'Default'
[ INFO  ] Setting-up a new atmosphere struct
[ INFO  ] Loading thermodyamic data
[ INFO  ] Inserting stellar spectrum and Rayleigh coefficients
[ INFO  ] Allocating atmosphere with composition:
[ INFO  ]       1 H2O     1.00e+00 (EOS_AQUA)
[ INFO  ] Setting T(p): dry, sat
[ INFO  ] Solving with 'none'
[ INFO  ]     done
[ INFO  ] Total RT evalulations: 2
[ INFO  ] Writing results
[ INFO  ] Plotting results
[ INFO  ] Deallocating memory
[ INFO  ] Model runtime: 16.60 seconds

The line following "Allocating atmosphere with composition" is a table of gases, their volume mixing ratios, and flags. In this case there is only one gas.

Potential flags for each species are:

  • EOS_[XX] - using the [XX] equation of state (e.g. ideal gas, AQUA)
  • NO_OPACITY - no opacity data available, but can contribute to the thermodynamics
  • NO_THERMO - no thermodynamic data available, so will be treated as a diatomic ideal gas
  • COND - this gas is allowed to condense

Output files are written to the directory specified in the configuration file (default: out/). See Example outputs for illustrative results, and How-to guides for next steps such as configuring the model for your own science case.