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.10.tar.gz (11.9 MB view details)

Uploaded Source

Built Distribution

gpcam-7.4.10-py2.py3-none-any.whl (37.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for gpcam-7.4.10.tar.gz
Algorithm Hash digest
SHA256 93d5c6fa4aaa11b536f7f339f336b60fe97de9d740f07bb87895ca682faebb6a
MD5 5a936638d8a9b89329d3a5179b55e92c
BLAKE2b-256 21815f2915a749bb1c1ee8dbd217a0bba4b6bd255a9f678ffedfb5e3fd3fbda6

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for gpcam-7.4.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ae636cd575c7ea2578f817947d4fe4dcbb195f94f3ca4d6b6268da24c0372a38
MD5 8d3920cefaada71c58617d14abdb3fd5
BLAKE2b-256 389f68d40b51472ef438fcbfb27e26210b632211dfca194ff161c5b6d2d4e450

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