Skip to main content

gpCAM is a code for autonomous data acquisition

Project description

gpCAM

PyPI Documentation Status gpCAM CI Codecov PyPI - License DOI

gpCAM is an API and software designed to make autonomous data acquisition and analysis for experiments and simulations faster, simpler and more widely available. The tool is based on a flexible and powerful Gaussian process regression at the core. The flexibility stems from the modular design of gpCAM which allows the user to implement and import their own Python functions to customize and control almost every aspect of the software. That makes it possible to easily tune the algorithm to account for various kinds of physics and other domain knowledge, and to identify and find interesting features. A specialized function optimizer in gpCAM can take advantage of HPC architectures for fast analysis time and reactive autonomous data acquisition.

Usage

The following demonstrates a simple usage of the gpCAM API (see interactive demo).

from gpcam.autonomous_experimenter import AutonomousExperimenterGP
import numpy as np

def instrument(data):
    for entry in data:
        entry["value"] = np.sin(np.linalg.norm(entry["position"]))
    return data

##set up your parameter space
parameters = np.array([[3.0,45.8],
                       [4.0,47.0]])

##set up some hyperparameters, if you have no idea, set them to 1 and make the training bounds large
init_hyperparameters = np.array([1,1,1])
hyperparameter_bounds =  np.array([[0.01,100],[0.01,100.0],[0.01,100]])

##let's initialize the autonomous experimenter ...
my_ae = AutonomousExperimenterGP(parameters, init_hyperparameters,
                                 hyperparameter_bounds,instrument_func = instrument,  
                                 init_dataset_size=10)
#...train...
my_ae.train()

#...and run. That's it. You successfully executed an autonomous experiment.
my_ae.go(N = 100)

Credits

Main Developer: Marcus Noack (MarcusNoack@lbl.gov) Many people from across the DOE national labs (especially BNL) have given insights that led to the code in it's current form. See AUTHORS for more details on that.

======= History

6.0.0 (2020-10-26)

  • First release on PyPI.

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

gpcam-7.4.6.tar.gz (11.9 MB view details)

Uploaded Source

Built Distribution

gpcam-7.4.6-py2.py3-none-any.whl (36.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file gpcam-7.4.6.tar.gz.

File metadata

  • Download URL: gpcam-7.4.6.tar.gz
  • Upload date:
  • Size: 11.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for gpcam-7.4.6.tar.gz
Algorithm Hash digest
SHA256 1693895f6cf9b3954c69c17dee40c8f1ec2b86f5046c5d960b99a873f0478136
MD5 10bb5e0a59cbf580fa8d05be66624067
BLAKE2b-256 51062f472c4d7c0edcaef2759ffd73878493ab236427ac217f5ed290f1f5c291

See more details on using hashes here.

Provenance

File details

Details for the file gpcam-7.4.6-py2.py3-none-any.whl.

File metadata

  • Download URL: gpcam-7.4.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 36.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for gpcam-7.4.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c2db4b09cfb9b66eebfec26e4941113c0a30faf2e0a3ca98b1ec0be805868546
MD5 ed2d0d427dbeb935245cac7280358de8
BLAKE2b-256 869add9e0c1d77066fa3b5db28b1935a4d6af5a4e2ca6749478ebb0157a387ee

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page