InstallationΒΆ

To develop and run tests on gilp, first download the source code in the desired directory.

git clone https://github.com/engri-1101/gilp.git

Next, cd into the gilp directory and create a Python virtual enviroment called env_name

1
2
cd gilp
python -m venv env_name

Activate the virtual enviroment.

source env_name/bin/activate

Run the following in the virtual enviroment. The -e flag lets you make adjustments to the source code and see changes without re-installing. The [dev] installs necessary dependencies for developing and testing.

pip install -e ".[dev]"
MAKE SURE THIS IS ACCURATE

To run tests and see coverage, run the following in the virtual enviroment.

1
2
coverage run -m pytest
coverage report --include=gilp/*

Next, we will provide an extensive overview of the gilp package and the contained modules.