Provide tools to plot parameter scan results that are wrapped up in a high-dimensional numpy array
- repository: https://github.com/benmaier/parmscan/
- documentation: http://parmscan.benmaier.org/
pip install parmscan
parmscan was developed and tested for
- Python 3.7
- Python 3.8
So far, the package's functionality was tested on Mac OS X and CentOS only.
parmscan directly depends on the following packages which will be installed by pip during the installation process
numpy>=1.17
The full documentation is available at parmscan.benmaier.org.
Changes are logged in a separate file.
This project is licensed under the MIT License. Note that this excludes any images/pictures/figures shown here or in the documentation.
If you want to contribute to this project, please make sure to read the code of conduct and the contributing guidelines. In case you're wondering about what to contribute, we're always collecting ideas of what we want to implement next in the outlook notes.
Fork this repository, clone it, and install it in dev mode.
git clone git@github.com:YOURUSERNAME/parmscan.git
makeIf you want to upload to PyPI, first convert the new README.md to README.rst
make readmeIt will give you warnings about bad .rst-syntax. Fix those errors in README.rst. Then wrap the whole thing
make pypiIt will probably give you more warnings about .rst-syntax. Fix those until the warnings disappear. Then do
make upload