Skip to content

Commit

Permalink
move figspec and latex utils, update readme and pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
wpbonelli committed Jan 9, 2024
1 parent 3129417 commit 3a1b36b
Show file tree
Hide file tree
Showing 8 changed files with 677 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,13 @@ Python development tools for MODFLOW 6.

## Use cases

This is a small toolkit for developing MODFLOW 6, FloPy, and related projects. It includes standalone utilities and optional [Pytest](https://github.com/pytest-dev/pytest) extensions.
This is a small toolkit for developing MODFLOW 6, FloPy, and related projects. It includes standalone utilities and optional [Pytest](https://github.com/pytest-dev/pytest) and [Matplotlib](https://matplotlib.org/stable/) extensions.

The former include a very minimal GitHub API client for retrieving release information and downloading assets, a `ZipFile` subclass that [preserves file permissions](https://stackoverflow.com/questions/39296101/python-zipfile-removes-execute-permissions-from-binaries) (workaround for [Python #15795](https://bugs.python.org/issue15795)), and other release/distribution-related tools.
Utilities include:

* a minimal GitHub API client for retrieving release information and downloading assets
* a `ZipFile` subclass that [preserves file permissions](https://stackoverflow.com/questions/39296101/python-zipfile-removes-execute-permissions-from-binaries) (workaround for [Python #15795](https://bugs.python.org/issue15795))
* other release/distribution-related tools

Pytest features include:

Expand All @@ -46,6 +50,8 @@ Pytest features include:
- `MODFLOW-USGS/modflow6-testmodels`
- `MODFLOW-USGS/modflow6-largetestmodels`

Matplotlib styles are provided in the `modflow_devtools.figspecs` module.

## Requirements

Python3.8+, dependency-free, but pairs well with `pytest` and select plugins, e.g.
Expand Down
5 changes: 5 additions & 0 deletions autotest/test_figspec.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
from modflow_devtools.figspec import USGSFigure


def test_usgs_figure():
fig = USGSFigure()
Empty file added autotest/test_latex.py
Empty file.
Empty file added docs/md/figspec.md
Empty file.
Empty file added docs/md/latex.md
Empty file.
Loading

0 comments on commit 3a1b36b

Please sign in to comment.