Skip to main content

Calculators for materials properties from the potential energy surface.

Project description

MatCalc logo MatCalc

GitHub license Linting Testing codecov Requires Python 3.8+

Introduction

MatCalc is a Python library for calculating materials properties from the potential energy surface (PES). The PES can be from DFT or, more commonly, from machine learning interatomic potentials (MLIPs).

Calculating various materials properties can require relatively involved setup of various simulation codes. The goal of MatCalc is to provide a simplified, consistent interface to access these properties with any parameterization of the PES.

Outline

The main base class in MatCalc is PropCalc (property calculator). All PropCalc subclasses should implement a calc(pymatgen.Structure) -> dict method that returns a dict of properties.

In general, PropCalc should be initialized with an ML model or ASE calculator, which is then used by either ASE, LAMMPS or some other simulation code to perform calculations of properties.

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

matcalc-0.0.3.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

matcalc-0.0.3-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file matcalc-0.0.3.tar.gz.

File metadata

  • Download URL: matcalc-0.0.3.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for matcalc-0.0.3.tar.gz
Algorithm Hash digest
SHA256 4ed3e41c6a81f62eab8abd0378c345a2c3d7a8b3a4bd3fcca35bf4c5cf5bccc2
MD5 fb105eab4c6adae7d71a16d84b4d245d
BLAKE2b-256 a505f1d5b1c4ad915e4287846cf38b6c6c614088e5ce6baebd709b2299019002

See more details on using hashes here.

File details

Details for the file matcalc-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: matcalc-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for matcalc-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 84a5cfc315b97ec8b5ccafa013866ab020ed3fda5c9fd419f4577b7b71cbd583
MD5 61a196c192b54e0d75d89833b2672e68
BLAKE2b-256 8d6aa4e34ae1497375f16f170c6992b64ee9c668ca73e01415591e41513452c5

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