Classes for Gaussian Process Regression fitting of 1D data with errorbars.
Project description
GPR1D
Installing the GPR1D program
Author: Aaron Ho (01/06/2018)
Installation is mandatory for this package!
For first time users, it is strongly recommended to use the GUI developed for this Python package. To obtain the Python package dependencies needed to use this capability, install this package by using the following on the command line:
pip install [--user] -e GPR1D[guis]
Use the --user
flag if you do not have root access on the system
that you are working on. If you have already cloned the
repository, enter the top level of the repository directory and
use the following instead:
pip install [--user] -e .[guis]
Documentation
Documentation of the equations used in the algorithm, along with the available kernels and optimizers, can be found in docs/. Documentation of the GPR1D module can be found on GitLab pages
Using the GPR1D program
For those who wish to include the functionality of this package into their own Python scripts, a demo script is provided in scripts/. The basic syntax used to create kernels, select settings, and perform GPR fits are outlined there.
For any questions or to report bugs, please do so through the proper channels in the GitLab repository.
** IMPORTANT note for users! **
The following runtime warnings are common within this routine, but they are filtered out by default:
RuntimeWarning: overflow encountered in double_scalars
RuntimeWarning: invalid value encountered in true_divide
RuntimeWarning: invalid value encountered in sqrt
They normally occur when using the kernel restarts option (as in the demo) and do not necessarily mean that the resulting fit is poor.
Plotting the resulting fit and errors is the recommended way to check its quality. The log-marginal-likelihood metric can also be used, but is only valuable when comparing different fits of the same data, ie. its absolute value is meaningless.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for GPR1D-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e48012c9dd7ea076611ef0a84216a3f8196941926d6150304874a3330a17f97d |
|
MD5 | 1b659b7949d70807e78b5fa221e7f2ab |
|
BLAKE2b-256 | 24a82cfb5f5a8fbaf0e197f21dbad7d52b678aa8aa0b3fd09365c3c0fc1f4d66 |