gpcam

Autonomous Data Acquisition, Uncertainty Quantification and HPC Optimization

https://github.com/lbl-camera/gpcam

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

Autonomous Data Acquisition, Uncertainty Quantification and HPC Optimization

Basic Info
Statistics
  • Stars: 27
  • Watchers: 4
  • Forks: 12
  • Open Issues: 3
  • Releases: 41
Created over 4 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Citation Authors

README.md

gpCAM

PyPI Documentation Status gpCAM CI Codecov PyPI - License DOI Downloads

[comment]: <> ([![Maintainability](https://api.codeclimate.com/v1/badges/29b04c3f69e2b515dac6/maintainability)](https://codeclimate.com/github/lbl-camera/gpCAM/maintainability)) [comment]: <> (Hiding maintainibility score while starting to address issues)

gpCAM (gpcam.lbl.gov) is an API and software designed to make advanced Gaussian Process function approximation and autonomous data acquisition/Bayesian Optimization for experiments and simulations more accurate, 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, in Euclidean and non-Euclidean spaces. A specialized function optimizer in gpCAM can take advantage of HPC architectures for fast analysis time and reactive autonomous data acquisition. gpCAM broke a 2019 record for the largest exact GP ever run! Below you can see a simple example of how to set up an autonomous experimentation loop.

Usage

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

```python !pip install gpcam

from gpCAM import GPOptimizer

mygp = GPOptimizer(xdata,ydata,) mygp.train()

trainat = [10,20,30] #optional for i in range(100): new = mygp.ask(np.array([[0.,1.]]))["x"] mygp.tell(new, f1(new).reshape(len(new))) if i in trainat: my_gp.train()

```

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.

Owner

  • Name: CAMERA
  • Login: lbl-camera
  • Kind: organization

GitHub Events

Total
  • Create event: 12
  • Issues event: 3
  • Release event: 11
  • Watch event: 8
  • Delete event: 1
  • Issue comment event: 6
  • Push event: 33
  • Pull request event: 11
Last Year
  • Create event: 12
  • Issues event: 3
  • Release event: 11
  • Watch event: 8
  • Delete event: 1
  • Issue comment event: 6
  • Push event: 33
  • Pull request event: 11

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 426
  • Total Committers: 5
  • Avg Commits per committer: 85.2
  • Development Distribution Score (DDS): 0.347
Past Year
  • Commits: 58
  • Committers: 2
  • Avg Commits per committer: 29.0
  • Development Distribution Score (DDS): 0.224
Top Committers
Name Email Commits
Marcus Michael Noack M****k@l****v 278
ronpandolfi r****i@g****m 107
Ian Humphrey i****y@g****m 31
elliott e****n@h****m 5
Matthew Carbone x****e@g****m 5
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 6
  • Total pull requests: 45
  • Average time to close issues: 2 days
  • Average time to close pull requests: 12 days
  • Total issue authors: 3
  • Total pull request authors: 7
  • Average comments per issue: 0.67
  • Average comments per pull request: 0.89
  • Merged pull requests: 37
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 11
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.09
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • MarcusMNoack (3)
  • rfung-uwm-edu (2)
  • ronpandolfi (2)
Pull Request Authors
  • ronpandolfi (29)
  • MarcusMNoack (7)
  • ihumphrey (5)
  • jan-janssen (1)
  • lbeverly (1)
  • jmlarson1 (1)
  • elliottperryman (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,325 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 75
  • Total maintainers: 2
pypi.org: gpcam

Autonomous data acquisition

  • Homepage: https://gpcam.lbl.gov
  • Documentation: https://gpcam.readthedocs.io/
  • License: *** License Agreement *** GPL v3 License gpCAM Copyright (c) 2024, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 8.2.6
    published 9 months ago
  • Versions: 75
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 1,325 Last month
Rankings
Dependent packages count: 10.1%
Downloads: 11.2%
Average: 14.3%
Dependent repos count: 21.6%
Last synced: 8 months ago

Dependencies

.github/workflows/gpCAM-CI.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • codecov/codecov-action v2 composite
  • fnkr/github-action-ghr v1 composite
  • pypa/gh-action-pypi-publish release/v1 composite
requirements.txt pypi
  • dask >=2021.6.2
  • distributed >=2021.6.2
  • fvgp ==3.3.3
  • loguru *
  • matplotlib *
  • notebook *
  • numpy *
  • ophyd *
  • pandas *
  • plotly *
  • scipy ==1.9.1
  • torch >=1.9.0
  • wheel *
  • zmq *
setup.py pypi