Allagash
A spatial optimization library for covering problems. Full documentation is available here
Installing with conda
To install with geopandas run:
conda install -c conda-forge allagash geopandas
To install with arcgis run:
conda install -c conda-forge -c esri allagash arcgis
To install without a spatial library run:
conda install -c conda-forge allagash
Installing with pip
To install with geopandas run:
pip install allagash[geopandas]
To install with arcgis run:
pip install allagash[arcgis]
To install without a spatial library run:
pip install allagash
Running Locally
- Clone the repo
git clone git@github.com:apulverizer/allagash.git - Create the conda environment
conda env create --file environment.yml - Activate the new environment
conda activate allagash - Install pre-commit hooks
pre-commit install - Install allagash locally
pip install -e . --no-deps - Launch jupyter notebook
jupyter notebook
You should now be able to run the example notebooks.
You can choose to install and use another solver that is supported by Pulp:
- GLPK (included in conda environment)
- COIN-OR CBC
- CPLEX
- Gurobi
Running Tests Locally
- Run tests
pytest --nbval
Building Documentation
- From the repo directory run
sphinx-build -b html ./src-doc ./docs -a
This will deploy html documentation to the docs folder.
Running with Docker
You can build the local docker image that includes Allagash, Python, Jupyter, GLPK, and COIN-OR CBC.
- Builder the docker image
docker build . -t apulverizer/allagash:latest - Launch Jupyter notebook
docker run -i -t --user=allagash -p 8888:8888 apulverizer/allagash:latest /bin/bash -c "jupyter notebook --ip='*' --port=8888 --no-browser"
You should now be able to run the example notebooks.
You can test the notebooks as well by running docker run --user=allagash apulverizer/allagash:latest /bin/bash -c "py.test --nbval"
If you'd like to mount a directory of local data/files into the container, you can add -v <your-local-dir>:/home/allagash/<dir-name> when running docker run
Running Tests with Docker
You can build a docker container that will run the tests (mounted into the container)
docker build . --file build.Dockerfile --tag apulverizer/allagash:builddocker run --user=allagash -v $PWD/tests:/home/allagash/tests -v $PWD/src-doc:/home/allagash/src-doc apulverizer/allagash:build /bin/bash -c "py.test --nbval"
Metadata
Release files for Allagash 0.4.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| Allagash-0.4.3.tar.gz | 8.5 kB | Without provenance | Details for Allagash-0.4.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| Allagash-0.4.3-py3-none-any.whl | Python 3 | none | any | Details for Allagash-0.4.3-py3-none-any.whl |
Total release size: 17.6 kB
Release files / Allagash-0.4.3.tar.gz
| Download URL | Allagash-0.4.3.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
065b9b845180db59c03a72ff6f381361378e30907502c01191474e43116c2648
|
|
BLAKE2b-256 checksum How to use checksums |
5dd6c57695fec0ceb38f060ba9b02e94ea560e8822a8d933372a44d1d8ef16c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / Allagash-0.4.3-py3-none-any.whl
| Download URL | Allagash-0.4.3-py3-none-any.whl |
|---|---|
| Size | 9.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d605cfb2a6ed3534a93e0e069cd542ee95d5cb2bf72e3f9f2580f34151dbe77a
|
|
BLAKE2b-256 checksum How to use checksums |
b329c76ddde54db3b81f7cd46ebf1af1569a6aee7cfea8dc8fbfbe20c1f662a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Security for Allagash 0.4.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.