cmutel / gsa_framework

gsa_framework

Basic project description

Motivation for not just using SALib

Installation

Details on how to install the package

Contributing

Details on how to contribute

Developing

Tests require pytest and SALib.

TODO

1. Generate documentation using Sphinx: Numpy style docs: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html https://numpydoc.readthedocs.io/en/latest/format.html#documenting-classes https://docs.python-guide.org/writing/documentation/ https://www.python.org/dev/peps/pep-0257/

2. Implement parameterized LCA model based on presamples.

3. Run remotely.

4. Comment tests properly

Pre-commit hooks

Source: https://pre-commit.com/

1. pip or conda install pre-commit

2. Create .pre-commit-config.yaml and populate it with relevant repos

3. run pre-commit install to set up the git hook scripts

4. Update your hooks to the latest version automatically by running pre-commit autoupdate