search

geo-fluid-dynamics / sapphire

An engine for constructing PDE-based simulations using Firedrake
MIT License
19 stars 5 forks source link

Document the sapphire package and Simulation class #78

Closed agzimmerman closed 4 years ago

agzimmerman commented 4 years ago

This adds docstrings for the sapphire package, the simulation module and its Simulation class, as well as for all methods of `Simulation.

Also type hinting was added in the simulation module.

There is a lot to squash away in here, because I tried cherry-picking something from the binary alloy branch and did it wrong. It probably would have been better to start over with a new branch, but since I am always squashing these PR's anyway, it doesn't really make a difference.