Installing canary

Note

canary requires Python 3.10+

Basic installation

1. Create and activate a python virtual environment.

   python3 -m venv venv
   source venv/bin/activate
   

2. Install via pip into the virtual environment

   python3 -m pip install "canary-wm git+ssh://git@github.com/sandialabs/canary"
   

Editable installation

An “editable installation” installs package dependencies, metadata, and wrappers for console scripts, but not the package itself. Instead, custom import hooks are generated to import your package from its source directory. By default, the editable installation clones the source into $VIRTUAL_ENV/src.

1. Create and activate a python virtual environment.

   python3 -m venv venv
   source venv/bin/activate
   

2. Install via pip into the virtual environment with the -e flag

   python3 -m pip install -e git+ssh://git@github.com/sandialabs/canary#egg=canary
   

Alternatively, the package can be installed from a source checkout:

1. Create and activate a python virtual environment.

   python3 -m venv venv
   source venv/bin/activate
   

2. Clone the source code:

   git clone git@github.com:sandialabs/canary
   

3. Install via pip into the virtual environment with the -e flag

   cd canary
   python3 -m pip install -e .