Installation

Dependencies

1. Install conda Python package manager (pick one from the following installers)

   • Anaconda (comprehensive, more popular);

   • Miniconda (compact, more system-friendly).

2. Set up NASA EARTHDATA

   • Register an account at https://urs.earthdata.nasa.gov.

   • After registration, please specify environment variable EARTHDATA_USERNAME and EARTHDATA_PASSWORD (assume you had a username of abc with password of 123).

     For example, if you are using bash shell, add the following line to the shell source file (e.g., ~/.bashrc):

     export EARTHDATA_USERNAME="abc"
     export EARTHDATA_PASSWORD="123"
     

   • Request a token (instructions here) for your EARTHDATA account and assign it to environment variable EARTHDATA_TOKEN.

     For example, if you are using bash shell, add the following line to the shell source file (e.g., ~/.bashrc):

     export EARTHDATA_TOKEN="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
     

3. Install MCARaTS through the official installation guide (or a step-by-step informal installation guide)

   • After installation, please specify environment variable MCARATS_V010_EXE.

     For example, if you are using bash shell, add the following line to the shell source file (e.g., ~/.bashrc):

     export MCARATS_V010_EXE="/system/path/to/mcarats-0.10.4/src/mcarats"
     

   • When the installation processes are complete, er3t.rtm.mca can be used to perform IPA/3D radiance/irradiance simulation (details see examples/00_er3t_mca.py).

   Tip

   If you encountered any error, please feel free to reach out at Discord SUPPORT/mcarats for community support.

4. (optional) Install libRadtran through the official installation guide (or a step-by-step informal installation guide)

   • After installation, please specify environment variable LIBRADTRAN_V2_DIR for the directory that contains compiled libRadtran (the directory should contain bin/, lib/, src/ etc.).

     For example, if you are using bash shell, add the following line to the shell source file (e.g., ~/.bashrc):

     export LIBRADTRAN_V2_DIR="/system/path/to/libradtran/v2.0.1"
     

   • When the installation processes are complete, er3t.rtm.lrt can be used to perform IPA radiance/irradiance simulation (details see examples/00_er3t_lrt.py).

   Tip

   If you encountered any error, please feel free to reach out at Discord SUPPORT/libradtran for community support.

5. (optional) Install SHDOM

   Unavailable yet (under development)

EaR³T Python Package - er3t

Warning

You will need to have the dependency steps 1 and 2 completed for accessing/processing satellite data.

Warning

You will need to have the dependency steps 1 and 3 completed for running radiative transfer simulations.

1. Open a terminal, type in the following

   git clone https://github.com/hong-chen/er3t.git
   

2. Under newly cloned er3t/, where it contains er3t-env.yml, type in the following

   conda env create -f er3t-env.yml
   conda activate er3t
   

   • A Python package version reference list (available to Mac and Linux users) is provided for diagnosing dependency version conflicts.

3. Under newly cloned er3t/, where it contains install.sh, type in the following

   bash install.sh
   

   • If install.sh fails to download the data from Google Drive for any reason, you can download the required data manually from here.

     After you download the file (er3t-data.tar.gz), put it under er3t/, where it contains install.sh, then run the command bash install.sh through a terminal again.

Tip

If you encountered any error, please feel free to reach out at Discord SUPPORT/installation for community support.