Installation

Installation#

  1. Clone the repository from GitHub

    git clone --recurse-submodules git@github.com:CROCODILE-CESM/CrocoDash.git
    
  2. Create the environment (called CrocoDash by default) using the provided environment.yml file

    conda env create -f environment.yml # Use Mamba if you have it installed! It's faster.
    
  3. Activate the environment!

    conda activate CrocoDash
    pytest tests/test_installation.py # If you'd like, run this to see if the package is installed correctly
    
  4. Check out the demos!

    import CrocoDash as cd