Skip to main content

SCGO: Simple Cluster Global Optimization

Python PyPI License: MIT

SCGO Logo

Global optimization of atomic clusters with ASE: Basin Hopping, Genetic Algorithms, NEB transition-state search, and MLIPs (MACE, UMA, UPET) via TorchSim. Covers gas-phase, surface, and adsorbate workflows.

Documentation: Read the Docs

Install

Exactly one MLIP extra per environment:

pip install "scgo[mace]"   # or [uma] / [upet]
# UPET only: pip install 'vesin==0.6.0' --force-reinstall --no-deps

Python 3.12+, SQLite JSON1. Details: installation guide.

Quick start

from scgo import run_go
from scgo.param_presets import get_testing_params

results = run_go(
    ["Pt"] * 4,
    params=get_testing_params(),
    seed=42,
    system_type="gas_cluster",
)

results is a list of (energy, Atoms) unique minima (energy-sorted). Use run_go_campaign for multi-composition runs.

Workflows

Goal Entry point
Single composition GO run_go
Multi-composition GO run_go_campaign
TS from existing minima run_ts_search
GO then TS run_go_ts
Multi-composition TS / GO+TS run_ts_campaign / run_go_ts_campaign

system_type is always a run argument: gas_cluster, surface_cluster, gas_cluster_adsorbate, or surface_cluster_adsorbate. Surfaces need surface_config=; adsorbates need adsorbates=.

Output: run_go writes {formula}_searches/; GO+TS/TS use a campaign root with sibling {formula}_searches/ and {formula}_ts_results/. See quickstart.

Examples

examples/ — MACE + TorchSim smoke scripts for all four system types (example_pt5_*.py).

Development

pip install -e ".[mace,dev]"   # or [uma,dev] / [upet,dev]
pre-commit install
pytest tests/ -m "not slow"

Long MLIP sweeps: benchmark/.


MIT License — see LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scgo-0.6.1.tar.gz (598.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scgo-0.6.1-py3-none-any.whl (733.7 kB view details)

Uploaded Python 3

File details

Details for the file scgo-0.6.1.tar.gz.

File metadata

  • Download URL: scgo-0.6.1.tar.gz
  • Upload date:
  • Size: 598.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for scgo-0.6.1.tar.gz
Algorithm Hash digest
SHA256 167c078003bf79cf3a74b7816e7fbb08ae77c56f523096cf28621b6d93a71225
MD5 c69789a79d6939b7fdce08cfff4618eb
BLAKE2b-256 1ef283d1d8a22fcd3deb30d8f9acdc2bd868978fd86d7d61cc19f475d8b6837d

See more details on using hashes here.

Provenance

The following attestation bundles were made for scgo-0.6.1.tar.gz:

Publisher: publish-pypi.yml on rlaplaza-lab/scgo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file scgo-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: scgo-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 733.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for scgo-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 efaab7368de3960c06f06f013392d11f16984763734c5479a5716955401e95af
MD5 490b7aa5c7e72a4557ce339931af4a10
BLAKE2b-256 697d01dbae16ba0651467998db1a935bb5fef9f0a782b652974f4117c00d86f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for scgo-0.6.1-py3-none-any.whl:

Publisher: publish-pypi.yml on rlaplaza-lab/scgo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.8.0

2 files

0.7.0

2 files

0.6.5

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

This release

0.6.1 This release

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.4.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page