Skip to main content

A framework for simulations of interacting particles

Project description

Atooms

pypi version license Binder DOI pipeline coverage report

atooms is a high-level Python framework for simulations of interacting particles, such as molecular dynamics or Monte Carlo.

This is the core package: it provides a consistent interface to the basic objects of particle-based simulations. [Feature packages](Feature packages) are built on top of it and implement complex simulation methods and analysis tools.

Quick start

Here is a small example for setting up a mixture of two types of particles, A and B, in a periodic elongated cell. The number density is set to unity.

from atooms.system import System

system = System(N=64)
system.replicate(times=4, axis=0)
system.composition = {'A': 128, 'B': 128}
system.density = 1.0

Particles in the central part of the cell get a random displacement and are folded back into the simulation cell

import numpy

for p in system.particle:
    if abs(p.position[0]) < system.cell.side[0] / 4:
        p.position += 0.5 * (numpy.random.random() - 0.5)
        p.fold(system.cell)
system.show('ovito')

Simulation data are stored in trajectory files, which are easy to manipulate and convert with atooms. Here, we write the system species and positions in a single-frame trajectory file using the xyz format.

from atooms.trajectory import TrajectoryXYZ

with TrajectoryXYZ('input.xyz', 'w') as th:
    th.variables = ['species', 'position']  # actually, this is the default
    th.write(system)

The trajectory file can now be used to start a simulation using one the available simulation backends or your own code.

Features

  • Focus on a simple and expressive interface
  • API refined over the years towards consistency
  • Modular and extensible design via namespace packages
  • Semantic versioning - for what is worth
  • Easy to interface: in-house codes and custom formats are first-class citizens
  • Support for efficient simulation backends, with a focus on GPU codes

Documentation

Check out the tutorial for more examples and the public API for more details.

Org-mode and jupyter notebooks are available under docs. You can run them interactively on Binder.

Installation

From the python package index

pip install atooms

From the code repository

git clone https://framagit.org/atooms/atooms.git
cd atooms
make install

Contributing

You are welcome to contribute to this project! Please have a look at these guidelines.

Feature packages

Atooms is modular: it is easy to add new functionalities, and just those you actually need.

Feature packages are available from the atooms main repository. They are installed in the atooms namespace to prevent name clashing. If you want to add your own feature package to the atooms namespace, structure it this way

atooms/your_package
atooms/your_package/__init__.py

where __init__.py contains

from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

Install your_package and you are ready to go

import atooms.your_package

Authors

Daniele Coslovich: https://www.units.it/daniele.coslovich/

Thanks go to Francesco Turci, Geert Kapteijns and Romain Simon for their contributions.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

atooms-3.27.0.tar.gz (157.4 kB view details)

Uploaded Source

Built Distribution

atooms-3.27.0-py3-none-any.whl (153.0 kB view details)

Uploaded Python 3

File details

Details for the file atooms-3.27.0.tar.gz.

File metadata

  • Download URL: atooms-3.27.0.tar.gz
  • Upload date:
  • Size: 157.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for atooms-3.27.0.tar.gz
Algorithm Hash digest
SHA256 e8e76269915ee7c3463b1d18978d0ac7421503c6d99a05c4638f3a4c8c56a526
MD5 e345b1d77974101b5cec7e8fe44b767c
BLAKE2b-256 73723f1129e8ce6ddfb9f6b37d75aeca41ce243d5ac1f3814be20213245e3bec

See more details on using hashes here.

File details

Details for the file atooms-3.27.0-py3-none-any.whl.

File metadata

  • Download URL: atooms-3.27.0-py3-none-any.whl
  • Upload date:
  • Size: 153.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for atooms-3.27.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b6aad13e992f3296574c9d67abb8a4379cc6b8aaf26be86929f1ab36bbf8c0c
MD5 fad27318ac65280f1c24ad03c5f5615c
BLAKE2b-256 ca889812c4417135a0ee779542b2f88b6547af75c215aa72943a62e618d20fda

See more details on using hashes here.

Supported by

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