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.post160.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

atomea-0.0.0.post160-py3-none-any.whl (59.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: atomea-0.0.0.post160.tar.gz
  • Upload date:
  • Size: 49.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.post160.tar.gz
Algorithm Hash digest
SHA256 15d409ede7a3d0711cd6327da4f46dc6d0e4b59273a9ae3f829bc491c0049bad
MD5 dd80fc11b8adcd774ce64aec9dd95389
BLAKE2b-256 5c8bc7c1aa4eccd5b6f01b60bb159528378549183ffa6749b6e7b85b059c7b7d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomea-0.0.0.post160-py3-none-any.whl
Algorithm Hash digest
SHA256 68d743c76452c67148fb138b71096f657e000ab08aa5ae2189e5210b608d2c9a
MD5 47d81363489ecb396a512ed2a9a74511
BLAKE2b-256 e0845b1258c5c035e5015efe78c5ecda826d576a8ee4e5d5331277c7df362491

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