Skip to main content

Logo

CI Status Coveralls PyPI Downloads Conda Downloads Requires Python 3.8+

Pymatgen (Python Materials Genomics) is a robust, open-source Python library for materials analysis. These are some of the main features:

  1. Highly flexible classes for the representation of Element, Site, Molecule and Structure objects.
  2. Extensive input/output support, including support for VASP, ABINIT, CIF, Gaussian, XYZ, and many other file formats.
  3. Powerful analysis tools, including generation of phase diagrams, Pourbaix diagrams, diffusion analyses, reactions, etc.
  4. Electronic structure analyses, such as density of states and band structure.
  5. Integration with the Materials Project REST API.

Pymatgen is free to use. However, we also welcome your help to improve this library by making your contributions. These contributions can be in the form of additional tools or modules you develop, or feature requests and bug reports. The following are resources for pymatgen:

Why use pymatgen?

  1. It is (fairly) robust. Pymatgen is used by thousands of researchers and is the analysis code powering the Materials Project. The analysis it produces survives rigorous scrutiny every single day. Bugs tend to be found and corrected quickly. Pymatgen also uses Github Actions for continuous integration, which ensures that every new code passes a comprehensive suite of unit tests.
  2. It is well documented. A fairly comprehensive documentation has been written to help you get to grips with it quickly.
  3. It is open. You are free to use and contribute to pymatgen. It also means that pymatgen is continuously being improved. We will attribute any code you contribute to any publication you specify. Contributing to pymatgen means your research becomes more visible, which translates to greater impact.
  4. It is fast. Many of the core numerical methods in pymatgen have been optimized by vectorizing in numpy/scipy. This means that coordinate manipulations are extremely fast and are in fact comparable to codes written in other languages. Pymatgen also comes with a complete system for handling periodic boundary conditions.
  5. It will be around. Pymatgen is not a pet research project. It is used in the well-established Materials Project. It is also actively being developed and maintained by the Materials Virtual Lab, the ABINIT group and many other research groups.
  6. A growing ecosystem of developers and add-ons. Pymatgen has contributions from materials scientists all over the world. We also now have an architecture to support add-ons that expand pymatgen's functionality even further. Check out the contributing page and add-ons page for details and examples.

Installation

The version at the Python Package Index (PyPI) is always the latest stable release that is relatively bug-free and can be installed via pip:

pip install pymatgen

The minimum Python version is 3.8. Some extra functionality (e.g., generation of POTCARs) does require additional setup (see the pymatgen page).

Change Log

Please check GitHub releases and commit history for the latest changes. A legacy changelog is still up at https://pymatgen.org/change_log.

Using pymatgen

Please refer to the official pymatgen page for tutorials and examples.

How to cite pymatgen

If you use pymatgen in your research, please consider citing the following work:

Shyue Ping Ong, William Davidson Richards, Anubhav Jain, Geoffroy Hautier, Michael Kocher, Shreyas Cholia, Dan Gunter, Vincent Chevrier, Kristin A. Persson, Gerbrand Ceder. Python Materials Genomics (pymatgen): A Robust, Open-Source Python Library for Materials Analysis. Computational Materials Science, 2013, 68, 314-319. doi:10.1016/j.commatsci.2012.10.028

In addition, some of pymatgen's functionality is based on scientific advances/principles developed by the computational materials scientists in our team. Please refer to pymatgen's documentation on how to cite them.

License

Pymatgen is released under the MIT License. The terms of the license are as follows:

The MIT License (MIT) Copyright (c) 2011-2012 MIT & LBNL

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About the Pymatgen Development Team

Shyue Ping Ong of the Materials Virtual Lab started Pymatgen in 2011 and is still the project lead.

The pymatgen development team is the set of all contributors to the pymatgen project, including all subprojects.

Pymatgen uses a shared copyright model. Each contributor maintains copyright over their contributions to pymatgen. But, it is important to note that these contributions are typically only changes to the repositories. Thus, the pymatgen source code, in its entirety is not the copyright of any single person or institution. Instead, it is the collective copyright of the entire pymatgen Development Team. If individual contributors want to maintain a record of what changes/contributions they have specific copyright on, they should indicate their copyright in the commit message of the change, when they commit the change to one of the pymatgen repositories.

Metadata

Release files for pymatgen 2023.1.20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pymatgen 2023.1.20
File Size Uploaded Provenance Actions
pymatgen-2023.1.20.tar.gz 9.6 MB Without provenance Details for pymatgen-2023.1.20.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for pymatgen 2023.1.20
File Actions
pymatgen-2023.1.20-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for pymatgen-2023.1.20-cp310-cp310-win_amd64.whl
pymatgen-2023.1.20-cp310-cp310-macosx_11_0_x86_64.whl CPython 3.10 CPython 3.10 macOS 11.0+ x86-64 Details for pymatgen-2023.1.20-cp310-cp310-macosx_11_0_x86_64.whl
pymatgen-2023.1.20-cp39-cp39-win_amd64.whl CPython 3.9 CPython 3.9 Windows x86-64 Details for pymatgen-2023.1.20-cp39-cp39-win_amd64.whl
pymatgen-2023.1.20-cp39-cp39-macosx_11_0_x86_64.whl CPython 3.9 CPython 3.9 macOS 11.0+ x86-64 Details for pymatgen-2023.1.20-cp39-cp39-macosx_11_0_x86_64.whl
pymatgen-2023.1.20-cp39-cp39-macosx_11_0_arm64.whl CPython 3.9 CPython 3.9 macOS 11.0+ ARM64 Details for pymatgen-2023.1.20-cp39-cp39-macosx_11_0_arm64.whl
pymatgen-2023.1.20-cp38-cp38-win_amd64.whl CPython 3.8 CPython 3.8 Windows x86-64 Details for pymatgen-2023.1.20-cp38-cp38-win_amd64.whl
pymatgen-2023.1.20-cp38-cp38-macosx_10_15_x86_64.whl CPython 3.8 CPython 3.8 macOS 10.15+ x86-64 Details for pymatgen-2023.1.20-cp38-cp38-macosx_10_15_x86_64.whl

Total release size: 80.9 MB

Release files / pymatgen-2023.1.20.tar.gz

Download URL pymatgen-2023.1.20.tar.gz
Size 9.6 MB
Tags Source
SHA-256 checksum
How to use checksums
6874d5815da03b909d02ad63f6eb92148c13181183c26f066dec38c004b0a29d
BLAKE2b-256 checksum
How to use checksums
0d13352165c1a5af8cf39bcdde91f297f9d77bfb6ec3f5cbb7f18348ca9ad97f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.13

Release files / pymatgen-2023.1.20-cp310-cp310-win_amd64.whl

Download URL pymatgen-2023.1.20-cp310-cp310-win_amd64.whl
Size 10.2 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
d144db3ab0cfb50c461017699ea117174fad49a8f8fc7d19879c13a957592ceb
BLAKE2b-256 checksum
How to use checksums
28dabea57569321c31da3022a76e5e66cd9638b4fac4fa06b9ef13e476be4bd0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release files / pymatgen-2023.1.20-cp310-cp310-macosx_11_0_x86_64.whl

Download URL pymatgen-2023.1.20-cp310-cp310-macosx_11_0_x86_64.whl
Size 10.2 MB
Tags CPython 3.10 macOS 11.0+ x86-64
SHA-256 checksum
How to use checksums
707f52629b664c417fd7c2af64b99b48cc86e117fed0ffdf0a627838a52c8823
BLAKE2b-256 checksum
How to use checksums
cc145700ee33381a1a1ac720173e18957eccb4bcb8f93fa8a403d40532f4ece3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Release files / pymatgen-2023.1.20-cp39-cp39-win_amd64.whl

Download URL pymatgen-2023.1.20-cp39-cp39-win_amd64.whl
Size 10.2 MB
Tags CPython 3.9 Windows x86-64
SHA-256 checksum
How to use checksums
5945d7965e7ba18a995711b3da358f85e2d460a85b6d687cdf0cb88bc1ac336b
BLAKE2b-256 checksum
How to use checksums
d30c643ec0d1fa9ca6a4b94995e4a2828aa0cbc7ebec0930e8ca0d6cb36b7fa0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.13

Release files / pymatgen-2023.1.20-cp39-cp39-macosx_11_0_x86_64.whl

Download URL pymatgen-2023.1.20-cp39-cp39-macosx_11_0_x86_64.whl
Size 10.2 MB
Tags CPython 3.9 macOS 11.0+ x86-64
SHA-256 checksum
How to use checksums
431cd35aaa712ca8a6fbbed8d261be382e898961c4bcabfc0db90982a6e31166
BLAKE2b-256 checksum
How to use checksums
5f3ea20ae330c1b6a46fa7724d3bae554dd672add7beea61564440030bd73266
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / pymatgen-2023.1.20-cp39-cp39-macosx_11_0_arm64.whl

Download URL pymatgen-2023.1.20-cp39-cp39-macosx_11_0_arm64.whl
Size 10.2 MB
Tags CPython 3.9 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
f80a94594b508308fbef11a4a33242b55f3b715f3653e20389e25765accd6f43
BLAKE2b-256 checksum
How to use checksums
35066cb47a980b7c9e700596eb153f67bda72dd7d71ababd96da04cd0aebd983
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.13

Release files / pymatgen-2023.1.20-cp38-cp38-win_amd64.whl

Download URL pymatgen-2023.1.20-cp38-cp38-win_amd64.whl
Size 10.2 MB
Tags CPython 3.8 Windows x86-64
SHA-256 checksum
How to use checksums
15d1669c8ecf513e7f6acd96a2eb7b5b601885d17102530238e0d2da277e8b42
BLAKE2b-256 checksum
How to use checksums
87ea4872d5a7dac19e71ebb5660f2e2e69aae58084b7841f7102746324b0391b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.10

Release files / pymatgen-2023.1.20-cp38-cp38-macosx_10_15_x86_64.whl

Download URL pymatgen-2023.1.20-cp38-cp38-macosx_10_15_x86_64.whl
Size 10.2 MB
Tags CPython 3.8 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
4a8d815295b49fac7c114910a42fe096041ff66dfefebf7f66544be8472d3dde
BLAKE2b-256 checksum
How to use checksums
00bcc756169c4bbb688cd8e5da1b2705dbdff8a591ee6c76f837819d1f28cb45
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.16

Security for pymatgen 2023.1.20

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2023.1.20 This release

8 release files No provenance

3.0.12

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page