https://github.com/activitysim/sharrow
numba for ActivitySim-style spec files
https://github.com/activitysim/sharrow
Last synced: 7 months ago
JSON representation
numba for ActivitySim-style spec files
- Host: GitHub
- URL: https://github.com/activitysim/sharrow
- Owner: ActivitySim
- License: bsd-3-clause
- Created: 2021-12-26T01:09:20.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-18T18:13:24.000Z (8 months ago)
- Last Synced: 2025-08-18T20:23:39.800Z (8 months ago)
- Language: Python
- Homepage: https://activitysim.github.io/sharrow
- Size: 10.9 MB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sharrow
numba for ActivitySim-style spec files
## Building a Wheel
To build a wheel for sharrow, you need to have `build` installed. You can
install it with `python -m pip install build`.
Then run the builder:
```shell
python -m build .
```
## Building the documentation
Building the documentation for sharrow requires JupyterBook.
```shell
jupyterbook build docs
```
## Developer Note
This repository's continuous integration testing will use `ruff` to check code
quality. There is a pre-commit hook that will run `ruff` on all staged files
to ensure that they pass the quality checks. To install and use this hook,
run the following commands:
```shell
python -m pip install pre-commit # if needed
pre-commit install
```
Then, when you try to make a commit, your code will be checked locally to ensure
that your code passes the quality checks. If you want to run the checks manually,
you can do so with the following command:
```shell
pre-commit run --all-files
```
If you don't use `pre-commit`, a service will run the checks for you when you
open a pull request, and make fixes to your code when possible.