Installation

If this is your first time running civet, you’ll need to clone the repository and install it.

I like to keep my repositories in the same place so they’re easy to find, so below I’m making a directory in my home directory (~) called repositories and moving into it with cd.

  1. Clone the civet repository with git clone https://github.com/artic-network/civet.git && cd civet
  2. conda env create -f environment.yml
  3. conda activate civet
  4. pip install .
  1. Clone the civet repository with git clone https://github.com/artic-network/civet.git && cd civet
  2. conda env create -f environment.yml
  3. conda activate civet
  4. pip install .

Dependencies If Not Installing Using the Conda Environment

Note: Note: we recommend using civet in the conda environment specified in the environment.yml file as per the instructions above. If you can't use conda for some reason, dependency details can be found in the environment.yml file.

Check the install worked

Type (in the civet environment):

civet -v
civet --art

You should see the version of civet and the civet logo printed printed respectively.

Troubleshooting install

Next: Updating