A few geoscience analysis helper functions I use ad hoc for:
- Creating geodataframes from csv
- Reading a directory of rasters into rioxarray or vector data into geodataframes
- Sampling rioxarrays at point locations
- Clipping rioxarrays
- Plotting rioxarrays
- Extracting a band from a rioxarray
- Zonal statistics
- Simple in progress https://richardscottoz.github.io/richardutils/
To install the package, before or after changing its name, you can use pip install . or pip install -e . for an æeditableæ install (useful during development).
To build an sdist and wheel for pip to install (it can use either; wheels are the 'modern' way), you can do python -m build.
Note: building the project makes a file called src/richardutils/_version.py which must not be checked into version control, hence it is included in .gitignore.
As well as the Python package with its API, the package also implements a command line interface, or CLI, called richardcli using Python's script entry point. So after installing with pip, there is a command-line tool you can invoke with richardcli --help. The CLI is implemented with a popular tool called click.
You can also invoke the CLI by running the module with python -m richardutils, which relies on __main__.py. So many ways to run Python code!
These are implemented using pytest for both the module and the CLI. The installation also includes coverage for checking test coverage (how much of your code is run under testing). The pytest options are in pyproject.toml. Run tests with:
pytest
You can get an HTML report from Coverage with coverage html.
The docs are written in Markdown, with the top-level index written in RST. The documentation pages are built by Sphinx with the following commands:
cd docs
make html
The []myst-nb plugin](https://myst-nb.readthedocs.io/en/latest/) for Sphinx should allow you to mix RST, Markdown, and Jupyter Notebooks in your documentation.
This package uses the Furo theme, but it's easy enough to change options like this in docs/conf.py.
The documentation builds as a GitHub Action and is deployed here.
As a brief note: after the make html above, copy the files in the docs/_build/html folder created to the gh-pages branch root and commit.
The package uses GitHub Actions for the automation of continuous integration. There are 2 so-called workflows:
build_test.yml— build and test the distribution usingpytest.publish-docs.yml— build and publish the documentation to GitHub pages. Note that this requires you to enable GitHub package on your repo.