https://github.com/cameronraysmith/thunderpath
☳ probabilistic modeling framework to define, experiment with, and critique models of stochastic dynamics in service of iterating through Box's loop ➰
https://github.com/cameronraysmith/thunderpath
Last synced: 11 months ago
JSON representation
☳ probabilistic modeling framework to define, experiment with, and critique models of stochastic dynamics in service of iterating through Box's loop ➰
- Host: GitHub
- URL: https://github.com/cameronraysmith/thunderpath
- Owner: cameronraysmith
- License: other
- Created: 2023-03-19T05:08:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-29T15:04:02.000Z (12 months ago)
- Last Synced: 2025-04-11T20:05:08.645Z (12 months ago)
- Language: Gherkin
- Homepage: https://cameronraysmith.net/thunderpath/
- Size: 74.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# thunderpath
Probabilistic modeling framework to define, experiment with, and critique models in service of iterating through Box's loop.
[](https://github.com/cameronraysmith/thunderpath/actions)
[](https://codecov.io/gh/cameronraysmith/thunderpath)
[](https://badge.fury.io/py/thunderpath)
---
**Documentation**: https://cameronraysmith.github.io/thunderpath/
**Source Code**: https://github.com/cameronraysmith/thunderpath
---
## Usage
[thunderpath](https://github.com/cameronraysmith/thunderpath) is pre-development. Please see the document outlining the [specification proposal](https://cameronraysmith.github.io/thunderpath/specification).
## Installation
```console
python -m pip install "thunderpath @ git+https://github.com/cameronraysmith/thunderpath.git@main"
```
## Development
### Setup environment
We use [hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system. It is often convenient to do this with [pipx](https://pypa.github.io/pipx/installation/).
### Run unit tests
You can run all the tests with:
```bash
hatch run test
```
### Format the code
Execute the following command to apply linting and check typing:
```bash
hatch run lint
```
### Publish a new version
You can check the current version with:
```bash
hatch version
```
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:
```bash
hatch run docs-serve
```
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.