Skip to main content

A random atoms package for atomistic scientists: easily generate, filter, and manage atomic datasets.

Project description

randatoms

A random atoms package for atomistic scientists: easily sample random structures from existing datasets, filter, and manage atomic datasets.

Overview

randatoms provides tools for sampling random atomic structures from pre-existing datasets, as well as utilities for filtering, merging, and loading these structures. The package is designed to help researchers in computational chemistry and materials science efficiently retrieve random structures, apply various filters, and manage large collections of atomic data.

Installation

You can install randatoms using pip:

pip install randatoms

Usage

💬 Conversational AI Docs 🔗 Try it on Google Colab
Ask DeepWiki Open In Colab

Loading Random Structures

from randatoms import randomatoms

# Get a single random structure
atoms = randomatoms()

# Get multiple random structures with filters
atoms_list = randomatoms(5, seed=42, include_elements=['C', 'H'], max_atoms=50)

Advanced Data Loading

from randatoms import DataLoader

# Initialize loader
loader = DataLoader()

# filter query
filter = dict(
    include_elements=['C', 'H', 'O'],
    has_metals=True,
    is_periodic=True
    )

# Get random structures
atoms = loader.get_random_structures(**filter)

# View statistics
loader.print_statistics(**filter)

Unit test

wget -O randatoms-main.zip https://github.com/kangmg/randatoms/archive/refs/heads/main.zip

unzip randatoms-main.zip "randatoms-main/test/*" && mv randatoms-main/test ./test && rm -rf randatoms-main randatoms-main.zip


python3 -m unittest discover test -v

Dataset References

  • [OMOL25 set]
    Levine, D.S. et al. (2025). The Open Molecules 2025 (OMol25) Dataset, Evaluations, and Models.
    arXiv preprint arXiv:2505.08762

  • [OMAT24 set]
    Barroso-Luque, L. et al. (2024). Open Materials 2024 (OMat24) Inorganic Materials Dataset and Models.
    arXiv preprint arXiv:2410.12771

  • [peptide set]
    Řezáč, J. et al. (2018). Journal of Chemical Theory and Computation, 14(3), 1254–1266.
    DOI: 10.1021/acs.jctc.7b01074

  • [X23b set]
    Zhugayevych, A. et al. (2023). Journal of Chemical Theory and Computation, 19(22), 8481–8490.
    DOI: 10.1021/acs.jctc.3c00861

  • [ODAC23 set]
    Sriram, A. et al. (2024). ACS Central Science, 10(5), 923–941.
    DOI: 10.1021/acscentsci.3c01629

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

randatoms-0.0.2.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

randatoms-0.0.2-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file randatoms-0.0.2.tar.gz.

File metadata

  • Download URL: randatoms-0.0.2.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for randatoms-0.0.2.tar.gz
Algorithm Hash digest
SHA256 b43550fc47929145f2bff807742d68445133a00ad892f6fecb638f75182a7074
MD5 8b4bab38bcec226966a137ce2a5c9faa
BLAKE2b-256 be818a1573d0f4f53a4d7a39a22bddf2fe5db044f94ef01892f65a13c8e615bd

See more details on using hashes here.

File details

Details for the file randatoms-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: randatoms-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for randatoms-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aae6a09eea89c2628910320b3740965aabf5d6d213f4471e52102bd280dd60f3
MD5 a1231aa1f8d0c8e35ab244d7dfd392b9
BLAKE2b-256 be08cb93dc675f83ce3610dd3f3d3843fe50924a9028a5f6c2a667bc184f6885

See more details on using hashes here.

Supported by

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