This repository contains implementations of Bruggeman's analytical solutions in Python.
The philosphy behind this repository is to collect implementations of analytical solutions so they are readily available for use in projects or for benchmarking other computations or models.
Very much a work in progress.
Normal install:
pip install bruggeman
Development install:
pip install -e .
The documentation is available here.
To build the documentation locally:
- Install the optional documentation dependencies
pip install bruggeman[docs]
(orpip install -e ".[docs]"
). - Navigate to
docs/
- Enter the command
make html
. - The documenation is contained in the
docs/_build
folder. Openindex.html
in your browser to view the documentation.