INSTALL FROM GITHUB (recommended method)

  1. Create a free GitHub account
  2. Send your username to DA team to have access to ORCHIDAS private repository
  3. Create a personal access token following the explanations: link
  4. Run the command providing your username and token:
git clone https://github.com/vbast/ORCHIDAS [target_folder]
Username: YOUR_USERNAME
Password: YOUR_TOKEN

The latest ORCHIDAS version can also be downloaded directly from the ORCHIDAS repository by clicking "<> Code" -> "Download ZIP", which is equivalent to this link: ORCHIDAS-main.zip

INSTALL FROM ARCHIVE (tagged versions only)

Download and unzip the tool archive in a directory: orchidas.1.0.zip

REQUIREMENTS

To use the tool only the common python libraries are needed that are normally available in most python installations (numpy, netCDF4, matplotlib, pandas, scipy). Although, the ORCHIDAS should run under any python version (from python3 and python2 families), always give a preference to the most recent version due to dependencies to other libraries that can be outdated. In further examples (see section Launch) the recommended python modules are given for different machines.

The Morris sensitivity analysis uses additional python library "SALib". If it is not installed in the standard python compilation, it can be installed manually with the command:

pip install SALib

In the old ORCHIDAS versions it was also necessary to load all modules needed for the correct functionality of the ORCHIDEE model. The appropriate list of modules can be normally found in the machine-dependent file located in the model installation folder at: modispl/config/ORCHIDEE_OL/ARCH/XXX.env. However, starting from the ORCHIDAS version 4.1 all required libraries are loaded automatically by the tool.