Skip to content

README.md

Latest commit

 

History

History
67 lines (54 loc) · 2.62 KB

README.md

File metadata and controls

67 lines (54 loc) · 2.62 KB

iSnobal- Conda Install

This folder contains conda environment files and a model development environment setup script.

Model execution environment

The following steps create a new environment to execute the iSnobal model. Note that environments are provided for both Linux and MacOS systems. For large iSnobal model runs, users are encouraged to use a Linux machine with adequate compute resources. The MacOS environment is provided primarily to allow users to run PySnobal (1-D point model) locally and/or conduct awsm runs for small domains and periods of time.

Set up a new conda environment

For Linux

  conda env create -f isnobal_linux.yaml

For MacOS

  ./install_isnobal_macOS.sh

Note: This environment has been configured to run on Macs with both M* (arm64) and Intel (x86-64) CPU architectures. This bash script handles installing the conda environment and configuring the environment target architecture, critical when installing on a newer Mac with an M* (arm64) chip.

Activate the environment

  conda activate isnobal

Quick test

With a successful setup from above, you should be able to execute

awsm --help

and get the help message for AWSM and how to execute the command.

All done!

Model development environment

Set up a conda environment with the steps shown above.

Run the install script

  ./install_isnobal_development.sh

The script takes a user-defined install location as the first argument. The default location is: $HOME/iSnobal if none is provided.

Releasing a new model version

Updating the conda environment.yaml to use a newer version of AWSM requires creating a new release on the AWSM GitHub repository. AWSM only depends on SMRF and any updates to the latter should be completed first before creating a new referenced release from AWSM to SMRF.

All other model dependencies (i.e., pySnobal, TopoCalc) are managed within SMRF. New releases of these dependencies should be handled there.

Once the release is published, update the - pip: section in the environment YAML that points to the GitHub URL. The URL has the form of:

    - git+https://github.com/iSnobal/awsm.git@_RELEASE_TAG_

The _RELEASE_TAG_ is a placeholder in this case and should be replaced with the actual release name.

Other environments

Basin Setup

Separate setup to run basin_setup to prepare a model domain.