https://github.com/ucl/emul
Python implementation of Gaussian process emulators
https://github.com/ucl/emul
Last synced: 25 days ago
JSON representation
Python implementation of Gaussian process emulators
- Host: GitHub
- URL: https://github.com/ucl/emul
- Owner: UCL
- License: mit
- Created: 2023-12-22T13:21:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-22T11:57:26.000Z (about 1 year ago)
- Last Synced: 2024-04-16T19:02:40.347Z (about 1 year ago)
- Language: Python
- Size: 9.77 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# emul
[](https://github.com/pre-commit/pre-commit)
[![Tests status][tests-badge]][tests-link]
[![Linting status][linting-badge]][linting-link]
[![Licence][licence-badge]](./LICENCE.md)
[tests-badge]: https://github.com/UCL/emul/actions/workflows/tests.yml/badge.svg
[tests-link]: https://github.com/UCL/emul/actions/workflows/tests.yml
[linting-badge]: https://github.com/UCL/emul/actions/workflows/linting.yml/badge.svg
[linting-link]: https://github.com/UCL/emul/actions/workflows/linting.yml
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/emul
[conda-link]: https://github.com/conda-forge/emul-feedstock
[pypi-link]: https://pypi.org/project/emul/
[pypi-platforms]: https://img.shields.io/pypi/pyversions/emul
[pypi-version]: https://img.shields.io/pypi/v/emul
[licence-badge]: https://img.shields.io/badge/License-MIT-yellow.svg
Python implementations of Gaussian process emulators.
This project is developed in collaboration with the [Centre for Advanced Research Computing](https://ucl.ac.uk/arc), University College London.
## About
### Project Team
- Matt Graham ([matt-graham](https://github.com/matt-graham))
### Research Software Engineering Contact
Centre for Advanced Research Computing, University College London
([[email protected]](mailto:[email protected]))
## Getting Started
### Prerequisites
`emul` requires Python 3.10–3.12.
### Installation
We recommend installing in a project specific virtual environment created using a environment management tool such as [Mamba](https://mamba.readthedocs.io/en/latest/user_guide/mamba.html) or [Conda](https://conda.io/projects/conda/en/latest/). To install the latest development version of `emul` using `pip` in the currently active environment run
```sh
pip install git+https://github.com/UCL/emul.git
```
Alternatively create a local clone of the repository with
```sh
git clone https://github.com/UCL/emul.git
```
and then install in editable mode by running
```sh
pip install -e .
```
### Running locally
How to run the application on your local system.
### Running tests
Tests can be run across all compatible Python versions in isolated environments using
[`tox`](https://tox.wiki/en/latest/) by running
```sh
tox
```
To run tests manually in a Python environment with `pytest` installed run
```sh
pytest tests
```
again from the root of the repository.
## Acknowledgements
This work was funded by a grant from the ExCALIBUR programme.