Building Covalent from Source#
To download and install Covalent from source, follow the steps below.
$ cd <project_directory> $ git clone firstname.lastname@example.org:AgnostiqHQ/covalent.git
where <project_directory> is the directory you choose to contain the project.
All file paths hereafter are relative to <project_directory>.
covalent/requirements.txt. Make sure you have them installed:
$ cd covalent $ pip install -r requirements.txt
$ cd covalent # Build the dashboard $ python setup.py webapp # Install using pip (-e is for developer mode) $ pip install -e .
Building the Documentation#
Optionally, you can build the documentation locally. Follow these steps:
covalent/doc/requirements.txt. Make sure you have them installed:
$ cd covalent/doc $ pip install -r requirements.txt
$ cd covalent $ python setup.py docs
The script builds the documentation in
covalent/doc/build/html. View the local documentation landing page in your browser at
Validating the Installation#
Optionally, validate the installation.
$ python -c "import covalent"