This is a generic package to create finite element models. It is intended mostly for teaching and basic research.
To install the module you can run
python setup.py create_tables
python setup.py install
The documentation can be generated by running the following from the docs
directory:
make html
The documentation pages can then be found in docs/build/html
.
Code formatting is enforced using black. Please run the following before committing any change to the code base
black pfe
Static analysis is performed using prospector. To check for issues please run
prospector --with-tool pep257 pfe
A configuration file prospector.yaml
is provided in the main directory of the repository.
Some minor issues reported by prospector
can be ignored but please try to address the obvious
issues.