Skip to main content

Extensible schema for atomistic simulations and calculations.

Project description

atomea

Extensible schema for atomistic simulations and calculations.

Build Status 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.post147.tar.gz (48.7 kB view details)

Uploaded Source

Built Distribution

atomea-0.0.0.post147-py3-none-any.whl (58.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: atomea-0.0.0.post147.tar.gz
  • Upload date:
  • Size: 48.7 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.post147.tar.gz
Algorithm Hash digest
SHA256 ed2cd6b25bb8210923c6ed6640611276fb3f7d8fbab772fb40a610102d7f4b99
MD5 af4f57875503a0169cfd1e0ef5fcb0e1
BLAKE2b-256 5d8bc0af6e2d68deea4139712620696740e01ab1533e4137a94c2c8165e08235

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomea-0.0.0.post147-py3-none-any.whl
Algorithm Hash digest
SHA256 d8f2ebebab80012316ca68530a1b05cbd385ccb433b7e9d7d294511ec1724122
MD5 c07a91696856e8a4cf77bf29c412954f
BLAKE2b-256 d2ba96c87f20fba13fd25939bf131bf775000a41cbe23c2b2e9490a75d06ae3e

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