Whenever you encounter a 🐛 bug or have 🎉 feature request,
report this via Github issues <https://github.com/IRLL/HierarchyCraft/issues>_.
We are happy to receive contributions in the form of pull requests via Github.
Feel free to fork the repository, implement your changes and create a merge request to the master branch.
- Clone the repository
git clone https://github.com/IRLL/HierarchyCraft.git- Install
uv
uv is a rust-based extremely fast package management tool
that we use for developement.
See uv installation instructions.
- Install all dependencies in a virtual environment using uv
Install hcraft as an editable package with dev requirements and all other extra requirements using uv:
uv sync --extra gym --extra gui --extra planning --extra htmlvis- Check installation
Check installation by running (fast) tests, remove the marker flag to run even slow tests:
pytest -m "not slow"