Skip to main content

rapmat

Rapid materials discovery TUI tool, based on random crystal generation and machine learning interatomic potentials.

Installation

An Nvidia GPU is highly recommended. Linux is recommended as well, since all backends are currently supported on Linux systems. Conda may be useful.

Linux

Install pytorch<2.10.0 with CUDA support if you have an NVIDIA GPU, otherwise skip this step:

pip install torch==2.9.1 torchvision --index-url https://download.pytorch.org/whl/cu126

Then install rapmat:

# basic install
pip install rapmat

# mattersim support
pip install rapmat[mattersim]

# all calculators at once
pip install rapmat[all-calculators]

Run its TUI:

rapmat

Windows

On Windows, only the UPET and MatterSim (the latter if built with its prerequisites installed) MLIPs are supported.

One way to overcome the Windows limitations is WSL2 -- check the Nvidia or Ubuntu guides.

Install WSL2

wsl.exe --install
  • Ensure it's up to date:
wsl.exe --update
  • Enter into WSL (Ubuntu is the default distro):
wsl.exe
  • Install CUDA Toolkit inside WSL:
$ wget https://developer.download.nvidia.com/compute/cuda/repos/wsl-ubuntu/x86_64/cuda-keyring_1.1-1_all.deb

$ sudo dpkg -i cuda-keyring_1.1-1_all.deb

$ sudo apt-get update

$ sudo apt-get -y install cuda-toolkit-13-2

Update the linker paths

NequIP compiles its CUDA kernels and needs the CUDA (stub) libraries on the linker path before installation:

export LIBRARY_PATH=/usr/local/cuda/lib64/stubs:$LIBRARY_PATH

Or, even better, add it to the ~/.bashrc to make it permanent:

echo 'export LIBRARY_PATH=/usr/local/cuda/lib64/stubs:$LIBRARY_PATH' >> ~/.bashrc
source ~/.bashrc

Proceed to the linux install guide

Usage

Basic concepts

A study defines the system (e.g. Al-O) you are working on and the calculation settings like calculator, forces convergence criterion or pressure. A run defines a specific formula x [formula units range]: e.g. Al2O3 x 6..8 constituting the unit cell being calculated.

Each run belongs to exactly one study, while a study may have many runs. Runs in one study may overlap, but you can view and perform actions such as deduplication or thickness filtering for only one run at a time.

Metadata

Release files for rapmat 0.3.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rapmat 0.3.6
File Size Uploaded
rapmat-0.3.6.tar.gz 139.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rapmat 0.3.6
File Interpreter ABI Platform
rapmat-0.3.6-py3-none-any.whl Python 3 none any Details

Total release size: 273.6 kB

Release files / rapmat-0.3.6.tar.gz

Download URL rapmat-0.3.6.tar.gz
Size 139.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1b92c4f1658ad1303fb202b6f6c8715e066ef56632cef27b81c6b36e564c70f8
BLAKE2b-256 checksum
How to use checksums
89c45420efd7953f10215268d55daad3256aee7c0d44d916d66a73e1d1f16c44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 10, 2026.

Transparency log

Release files / rapmat-0.3.6-py3-none-any.whl

Download URL rapmat-0.3.6-py3-none-any.whl
Size 133.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fce7cbc588c884485ab1fc1bb7166eb6df9d2258436ea405cd99aed3ef9f549e
BLAKE2b-256 checksum
How to use checksums
52b3abb84a32670a3343bd826d0044a928822b54a32f9b9af0ee8e377f9524de
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 10, 2026.

Transparency log

Release history Release notifications | RSS feed

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

This release

0.3.6 This release

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.2.19

2 release files

0.2.18

2 release files

0.2.17

2 release files

0.2.16

2 release files

0.2.15

2 release files

0.2.14

2 release files

0.2.13

2 release files

0.2.12

2 release files

0.2.11

2 release files

0.2.10

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.43

2 release files

0.1.42

2 release files

0.1.41

2 release files

0.1.40

2 release files

0.1.39

2 release files

0.1.38

2 release files

0.1.37

2 release files

0.1.36

2 release files

0.1.35

2 release files

0.1.34

2 release files

0.1.33

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page