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

Uploaded Source

Built Distribution

gpcam-8.0.0-py2.py3-none-any.whl (51.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for gpcam-8.0.0.tar.gz
Algorithm Hash digest
SHA256 cad960071b410840d4618342aab31b5ce27c711739a851311d0fdd87ab74b959
MD5 26a5e5a328c70c03b2c5ebf920c17586
BLAKE2b-256 2f2b19379a2addfab27bfc813919231306a1d4fefd849ab0a3a96c7b747651b1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: gpcam-8.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 51.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for gpcam-8.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 aad941cce75eb90f6cd6ce574a7097d3b4c1ab45e2c15559c0fbcade4a808003
MD5 8ddebbd71ca64b96ca03e9b99c02e9f4
BLAKE2b-256 5a417809f449bfb0a0b8c0bd83213a5f19702e65cb436ee4003bc04c60660e94

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