scisample

scisample is a Python 3 package that implements a number of parameter sampling methods for scientific computing. Specifications for sampling are written in the YAML markup language.

Installation with a python virtual environment

1. cd into the top level scisample directory
2. python3 -m venv venv_scisample
3. source venv_sci_sample/bin/activate
4. pip install --upgrade pip
5. pip install -r requirements.txt
6. pip install -e .

Documentation

1. cd docs into the top level scisample directory
2. make <documentation type>, where includes 'html', 'latexpdf', 'text', etc.

Testing

1. cd into the top level scisample directory
2. pytest tests
3. pytest --cov=scisample --cov-report=html tests/

Community

scisample is an open source project. Questions, discussion, and contributions are welcome. Contributions can be anything from new packages to bugfixes, documentation, or even new core features.

Contributing

Contributing to scisample is relatively easy. Just send us a pull request. When you send your request, make develop the destination branch on the scisample repository.

Your PR must pass scisamples's unit tests and documentation tests, and must pass most flake8 and pylint tests. We enforce these guidelines with our CI process. Please see CONTRIBUTING.md for more information.

Code of Conduct

Please note that scisample has a Code of Conduct. By participating in the scisample community, you agree to abide by its rules.

Authors

Current authors of scisample include Brian Daub, Chris Krenn, Cody Raskin, & Jessica Semler.

License

scisample is distributed under the the MIT license.

All new contributions must be made under the MIT license.

Please see LICENSE and NOTICE for details.

SPDX-License-Identifier: MIT

LLNL-CODE-815909