Prerequisites

Installing Pixi

Pixi is a tool for managing conda environments and dependencies. To install Pixi, visit the Pixi website and follow the instructions specific to your operating system. The Pixi documentation is an extensive resource for learning how to use Pixi.

Running the following command in your terminal should verify installation.

$pixi --version
pixi 0.34.0

Cloning the Repository

To begin, clone the repository to your local machine using the following command:

$ git clone https://github.com/bhklab/handbook.git
Cloning into 'handbook'...
....
....
....
...
$ cd handbook

Installing Dependencies

Once you have cloned the repository, navigate to the project directory and install the dependencies:

$ pixi install
✔ The default environment has been installed.

This will install the dependencies specified in the pixi.toml file.

To add content to the handbook, see the Adding Content section.