kups · PyPI

A toolkit for building high-performance molecular simulations on JAX

kUPS provides composable, differentiable primitives — samplers, potentials, and propagators — with hardware acceleration on CPU, GPU, and TPU.

Documentation | Quick Start | Features | Examples

Installation

Standard Installation	pip install kups
GPU Support	pip install kups[cuda]
Development	git clone https://github.com/cusp-ai-oss/kups.git cd kUPS uv sync

Quick Start

[!TIP] The repository includes example applications built with kUPS in the examples/ directory.

Monte Carlo Simulation (GCMC)

cd examples
kups_mcmc_rigid mcmc_rigid.yaml

Molecular Dynamics (Lennard-Jones)

cd examples
kups_md md_lj_argon_nvt.yaml

Features

Simulation Methods

Monte Carlo — NVT and GCMC ensembles with translation, rotation, reinsertion, and exchange moves
Molecular Dynamics — NVE, NVT, NPT ensembles
Geometry Optimization — FIRE and L-BFGS relaxation

Force Fields & Potentials

Lennard-Jones potential
Coulomb interactions (Ewald summation)
Harmonic bonds and angles
Morse potential
MACE and UMA ML force fields

Core Capabilities

Composable — shared propagator interface; methods and potentials snap together freely
Batched — run thousands of independent simulations as vectorized computations

Performance & Integration

GPU-native — JIT-compiled on CPU, GPU, and TPU with no code changes
Differentiable — full automatic differentiation via JAX
PyTorch interop — bring PyTorch models into JAX via Tojax

Documentation

Full documentation is available at cusp-ai-oss.github.io/kUPS.

Building docs locally

To build the docs locally run ./docs/scripts/build.sh, which executes and renders all documentation notebooks and generates API pages in markdown.

./docs/scripts/build.sh           # build into site/
./docs/scripts/build.sh --serve   # serve with live updates on http://127.0.0.1:8000

Citation

If you use kUPS in your research, please cite:

@software{kups2026,
  author = {Gao, Nicholas
    and K{\"o}hler, Jonas
    and Hanke, Felix
    and Ramanan, Anita
    and Moubarak, Elias
    and Morrow, Joe
    and de Haan, Pim
    and Openshaw, Hannah
    and Welling, Max
    and CuspAI Team},
  title = {kUPS - a universal particle simulation toolkit},
  year = {2026},
  url = {https://github.com/cusp-ai-oss/kups}
}

License

Apache License 2.0 — 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

kups-1.0.5.tar.gz (326.8 kB view details)

Uploaded Aug 18, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

kups-1.0.5-py3-none-any.whl (439.5 kB view details)

Uploaded Aug 18, 2026 Python 3

File details

Details for the file kups-1.0.5.tar.gz.

File metadata

Download URL: kups-1.0.5.tar.gz
Upload date: Aug 18, 2026
Size: 326.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kups-1.0.5.tar.gz
Algorithm	Hash digest
SHA256	`7252a3dde6d8967bb93c374277332a282bb65606d3b0cf01ec68f0377a4ed0e6`
MD5	`b98ea73a5e13d7d9a7dc2547724b6a99`
BLAKE2b-256	`1fd58d364ec54b0e0b344eee121ba6854b61375588c540b54fc932e889f4a2f7`

See more details on using hashes here.

Provenance

The following attestation bundles were made for kups-1.0.5.tar.gz:

Publisher: release.yaml on cusp-ai-oss/kUPS

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: kups-1.0.5.tar.gz
- Subject digest: 7252a3dde6d8967bb93c374277332a282bb65606d3b0cf01ec68f0377a4ed0e6
- Sigstore transparency entry: 2501377471
- Sigstore integration time: Aug 18, 2026
Source repository:
- Permalink: cusp-ai-oss/kUPS@1cf31224f6d9673aec7c4e9ad7d43b816b9ae9c6
- Branch / Tag: refs/tags/v1.0.5
- Owner: https://github.com/cusp-ai-oss
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yaml@1cf31224f6d9673aec7c4e9ad7d43b816b9ae9c6
- Trigger Event: push