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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: atomea-0.0.0.post159.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.post159.tar.gz
Algorithm Hash digest
SHA256 d35cc55a085e24db080b518308703d4eb562e865635c82fe9bfcef7e25673629
MD5 a0fd30edfef9bd761245b94552d1a80c
BLAKE2b-256 d0dc4a2564fb1db92c68481249ba77a5a3c155289263610acf5accc1fe331b8c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for atomea-0.0.0.post159-py3-none-any.whl
Algorithm Hash digest
SHA256 75b7d80870e0f069440d968d955acda1820c8e83736ff92164d967dda2b5f9d1
MD5 43dcfdf6b089e1fb8b3f511546168697
BLAKE2b-256 4828271471d9b23e2cbbf45828ec229f57f63ee37592f98c054421d3b278b4d3

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