thunderpath¶
Probabilistic modeling framework to define, experiment with, and critique models in service of iterating through Box's loop.
Documentation: https://cameronraysmith.github.io/thunderpath/
Source Code: https://github.com/cameronraysmith/thunderpath
Usage¶
thunderpath is pre-development. Please see the document outlining the specification proposal.
Installation¶
Development¶
Setup environment¶
We use hatch to manage the development environment and production build. Ensure it's installed on your system. It is often convenient to do this with pipx.
Run unit tests¶
You can run all the tests with:
Format the code¶
Execute the following command to apply linting and check typing:
Publish a new version¶
You can check the current version with:
You can bump the version, create a commit and associated tag with one command such as hatch version patch
or minor
or major
. Your git default text editor will open so you can add information about the release.
When you push the tag on github, the workflow will automatically publish it on PyPI and a github release will be created as draft.
Serve the documentation¶
You can serve the mkdocs documentation with:
It'll automatically watch for changes in your code.
License¶
This project is licensed under the terms of the GNU Affero 3.0-only license.