Installation#

  1. Clone the repository

    git clone git@github.com:NatLabRockies/reVeal.git
    
  2. Move into the local repository

    cd reVeal
    
  3. Recommended: Setup virtual environment with conda/mamba:

    mamba env create -f environment.yml
    mamba activate reVeal
    

    Note: You may choose an alternative virtual environment solution; however, installation of dependencies is not guaranteed to work.

  4. Install reVeal:
    pip install .
    

Usage#

For details on usage of command line tools, see: Command Line Interfaces (CLIs).