For local development you can clone the repository, update the
dependencies and install in a virtual environment with
git clone https://github.com/openclimatedata/pyhector.git --recursive cd pyhector python3 -m venv venv ./venv/bin/pip install --editable .
To update pyhector and all submodules you can run
git pull --recurse-submodules git submodule update --init --recursive ./venv/bin/pip install --editable .
Tests can be run locally with
python setup.py test
Updating the Hector model version used¶
The Hector model source code is included in the pyhector repository as a submodule. To update its version do the following:
If you didn’t clone pyhector recursively:
git submodule update --init
Go into the
hectorfolder and checkout the version to be used (replace
VERSIONTAGaccording to the corresponding version tag):
cd hector git checkout VERSIONTAG
Commit the updated submodule to pyhector:
cd .. git add hector git commit -m
Please do not forget to run the tests with the new version.
How to contribute¶
We welcome contributions to and questions about pyhector. Please report issues or discuss feature requests on pyhector’s issue tracker.
You can also contact the pyhector authors via email (see their websites in the README).
Please also check the Hector repository, documentation and issue tracker as pyhector is only a thin interface around the Hector model: