mathLab / ATHENA

ATHENA: Advanced Techniques for High dimensional parameter spaces to Enhance Numerical Analysis

Table of contents

• Description
• Dependencies and installation
  • Installing from source
• Documentation
• Testing
• Examples and Tutorials
• References
  • Recent works with ATHENA
• Authors and contributors
• How to contribute
  • Submitting a patch
• License

Description

ATHENA is a Python package for reduction in parameter spaces.

Dependencies and installation

ATHENA requires requires numpy, matplotlib, sphinx (for the documentation) and nose (for local test). The code is compatible with Python 3.6 and above. It can be installed directly from the source code.

Installing from source

To install the latest version of the package just type:

> pip install git+https://github.com/mathLab/ATHENA.git

The official distribution is on GitHub, and you can clone the repository using

> git clone https://github.com/mathLab/ATHENA

To install your own local branch you can use the setup.py file

> python setup.py install

To uninstall the package you have to rerun the installation and record the installed files in order to remove them:

> python setup.py install --record installed_files.txt
> cat installed_files.txt | xargs rm -rf

Documentation

ATHENA uses Sphinx for code documentation. You can view the documentation online here. To build the html version of the docs locally simply:

> cd docs
> make html

The generated html can be found in docs/build/html. Open up the index.html you find there to browse.

Testing

We are using Travis CI for continuous intergration testing. You can check out the current status here.

To run tests locally (nose is required):

> python test.py

Examples and Tutorials

You can find useful tutorials on how to use the package in the tutorials folder.

References

To implement the numerical methods present in this package we followed these works:

• Constantine. Active subspaces: Emerging ideas for dimension reduction in parameter studies. Volume 2 SIAM Spotlights, 2015. [DOI].
• Constantine et al. Python Active-subspaces Utility Library, Journal of Open Source Software, 1(5), 79, 2016. [DOI].

Recent works with ATHENA

Here there is a list of the scientific works involving ATHENA you can consult and/or cite. If you want to add one, please open a PR.

Authors and contributors

ATHENA is currently developed and mantained at SISSA mathLab by

• Marco Tezzele
• Francesco Romor

under the supervision of Prof. Gianluigi Rozza.

Contact us by email for further information or questions about ATHENA, or suggest pull requests. Contributions improving either the code or the documentation are welcome!

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Submitting a patch

1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

3. To ensure properly formatted code, please make sure to use 4 spaces to indent the code. The easy way is to run on your bash the provided script: ./code_formatter.sh. You should also run pylint over your code. It's not strictly necessary that your code be completely "lint-free", but this will help you find common style issues.

4. Any significant changes should almost always be accompanied by tests. The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it. We're using coveralls that is an invaluable tools for seeing which parts of your code aren't being exercised by your tests.

5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

6. Finally, push the commits to your fork and submit a pull request. Please, remember to rebase properly in order to maintain a clean, linear git history.

License

See the LICENSE file for license rights and limitations (MIT).