Skip to main content

Extensible schema for atomistic simulations and calculations.

Project description

atomea

Extensible schema for atomistic simulations and calculations.

Build Status PyPI version PyPI - Python Version codecov GitHub release (latest by date) License GitHub repo size Black style Black style Black style

Documentation

Overview

Atomea is a Python package designed to simplify and standardize the setup and data management for atomistic simulations and calculations. It leverages the power of Pydantic for schema definition and Jinja2 templates for input file generation, making it easy to automate, document, and prepare input files for various computational chemistry and biology tools.

Key features

  • Extensible Schema Definition: Easily define schemas for various computational packages using Pydantic.
  • Automated Input File Preparation: Generate input files with Jinja2 templates to ensure consistency and reproducibility.
  • Data Digestion: Convert raw output files into optimized storage formats (e.g., Zarr) with a consistent interface.
  • YAML Integration: Save and load configurations and data in YAML format for easy sharing and reproducibility.

Installation

You can install atomea via pip:

pip install atomea

Deploying

We use bump-my-version to release a new version. This will create a git tag that is used by poetry-dynamic-version to generate version strings and update CHANGELOG.md.

For example, to bump the minor version you would run the following command.

poetry run bump-my-version bump minor

After releasing a new version, you need to push and include all tags.

git push --follow-tags

License

This project is released under the Apache-2.0 License as specified in LICENSE.md.

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

atomea-0.0.0.post158.tar.gz (49.6 kB view details)

Uploaded Source

Built Distribution

atomea-0.0.0.post158-py3-none-any.whl (59.0 kB view details)

Uploaded Python 3

File details

Details for the file atomea-0.0.0.post158.tar.gz.

File metadata

  • Download URL: atomea-0.0.0.post158.tar.gz
  • Upload date:
  • Size: 49.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for atomea-0.0.0.post158.tar.gz
Algorithm Hash digest
SHA256 60cdfc401c985d82efbd5f8e7a64610e8e00ffe8e6795248efdf5ea6c005f44d
MD5 abb2353abead3d01d048f49ef7d349a2
BLAKE2b-256 721394925c16a0f812ef5e1413304e8413f43c50deafb93b566dd59bf477e35e

See more details on using hashes here.

File details

Details for the file atomea-0.0.0.post158-py3-none-any.whl.

File metadata

File hashes

Hashes for atomea-0.0.0.post158-py3-none-any.whl
Algorithm Hash digest
SHA256 e1d328dd1c00a6d1a7d3dd3be37b34af4bdb5ee459f255b8ffbb272123729b32
MD5 5a0a9c2111387aadf8e8ada4241f2105
BLAKE2b-256 a86b0090cce826f5eaa2236e5355d414fdb813d85971121ccac31fcaaa6eb1e8

See more details on using hashes here.

Supported by

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