Skip to main content

Logo

CI Status codecov PyPI Downloads Conda Downloads Requires Python 3.10+ Paper

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 fast. 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

If you'd like to use the latest unreleased changes on the main branch, you can install directly from GitHub:

pip install -U git+https://github.com/materialsproject/pymatgen

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

Change Log

See GitHub releases, docs/CHANGES.md or commit history in increasing order of details.

Using pymatgen

Please refer to the official pymatgen docs 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 the pymatgen docs on how to cite them.

Soliciting contributions to 2nd pymatgen paper

If you are a long-standing pymatgen contributor and would like to be involved in working on an updated pymatgen publication, please fill out this co-author registration form or contact @shyuep, @mkhorton and @janosh with questions.

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 (@shyuep) of the Materials Virtual Lab started Pymatgen in 2011 and is still the project lead. Janosh Riebesell (@janosh) and Matthew Horton (@mkhorton) are co-maintainers.

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 2024.10.3

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 2024.10.3
File Size Uploaded Provenance Actions
pymatgen-2024.10.3.tar.gz 3.1 MB Without provenance Details for pymatgen-2024.10.3.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for pymatgen 2024.10.3
File Actions
pymatgen-2024.10.3-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for pymatgen-2024.10.3-cp312-cp312-win_amd64.whl
pymatgen-2024.10.3-cp312-cp312-win32.whl CPython 3.12 CPython 3.12 Windows x86-32 Details for pymatgen-2024.10.3-cp312-cp312-win32.whl
pymatgen-2024.10.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.17+ x86-64 Details for pymatgen-2024.10.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
pymatgen-2024.10.3-cp312-cp312-macosx_11_0_arm64.whl CPython 3.12 CPython 3.12 macOS 11.0+ ARM64 Details for pymatgen-2024.10.3-cp312-cp312-macosx_11_0_arm64.whl
pymatgen-2024.10.3-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details for pymatgen-2024.10.3-cp311-cp311-win_amd64.whl
pymatgen-2024.10.3-cp311-cp311-win32.whl CPython 3.11 CPython 3.11 Windows x86-32 Details for pymatgen-2024.10.3-cp311-cp311-win32.whl
pymatgen-2024.10.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.11 CPython 3.11 Linux glibc 2.17+ x86-64 Details for pymatgen-2024.10.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
pymatgen-2024.10.3-cp311-cp311-macosx_11_0_arm64.whl CPython 3.11 CPython 3.11 macOS 11.0+ ARM64 Details for pymatgen-2024.10.3-cp311-cp311-macosx_11_0_arm64.whl
pymatgen-2024.10.3-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details for pymatgen-2024.10.3-cp310-cp310-win_amd64.whl
pymatgen-2024.10.3-cp310-cp310-win32.whl CPython 3.10 CPython 3.10 Windows x86-32 Details for pymatgen-2024.10.3-cp310-cp310-win32.whl
pymatgen-2024.10.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.10 CPython 3.10 Linux glibc 2.17+ x86-64 Details for pymatgen-2024.10.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
pymatgen-2024.10.3-cp310-cp310-macosx_11_0_arm64.whl CPython 3.10 CPython 3.10 macOS 11.0+ ARM64 Details for pymatgen-2024.10.3-cp310-cp310-macosx_11_0_arm64.whl

Total release size: 50.5 MB

Release files / pymatgen-2024.10.3.tar.gz

Download URL pymatgen-2024.10.3.tar.gz
Size 3.1 MB
Tags Source
SHA-256 checksum
How to use checksums
de6d12a87e013b1b34f64c2120c7f07cfcffe60feabb0b711c21ad8fd964f4fd
BLAKE2b-256 checksum
How to use checksums
d22aefbafb0dc43f0ac0dfb9c279dfe8fc9762951467abc40fad601fcc12788d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.5

Release files / pymatgen-2024.10.3-cp312-cp312-win_amd64.whl

Download URL pymatgen-2024.10.3-cp312-cp312-win_amd64.whl
Size 3.6 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
d278eab6be3ec420f52c1c82af4aba04cec5a7c2ca6a52534739f98302b10ee5
BLAKE2b-256 checksum
How to use checksums
3327efcc394f1796a70b417fba517226ca35150a1f8f3a15f4834b20850e45a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp312-cp312-win32.whl

Download URL pymatgen-2024.10.3-cp312-cp312-win32.whl
Size 3.6 MB
Tags CPython 3.12 Windows x86-32
SHA-256 checksum
How to use checksums
367cf243e971e2e2751ca4514f99a9f5b96e78ef02e3cd2dd541c2e23b306ca5
BLAKE2b-256 checksum
How to use checksums
2a487ef6f248e60c611469e399e73c450c07148c8dd2f045db64b9325123b118
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL pymatgen-2024.10.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.0 MB
Tags CPython 3.12 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
ffa71ea34a9b51e2ccfb9ab65ccbe64244acc9e370eb97bd2d384da38f2ec8c4
BLAKE2b-256 checksum
How to use checksums
7fe69d5c9affca5aa1bd33abc99c3d226705d351f2de9259afd07c27d5d3c3f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp312-cp312-macosx_11_0_arm64.whl

Download URL pymatgen-2024.10.3-cp312-cp312-macosx_11_0_arm64.whl
Size 3.6 MB
Tags CPython 3.12 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
d9beadafe451358d0dbf11bc078d310448060e4f669b21eb6a9a75977964709c
BLAKE2b-256 checksum
How to use checksums
71a437a650b03fc1348fbd0d7768eb1df6d81ae59449d2f6064566347328864d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp311-cp311-win_amd64.whl

Download URL pymatgen-2024.10.3-cp311-cp311-win_amd64.whl
Size 3.6 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
ee7fa9a986a9db04fb681dbe249f2d0595e6f0baea5c51271415685415adb427
BLAKE2b-256 checksum
How to use checksums
92aaa7504c4469c50067d63bdbd2ef0f302a769f9e71ddc6379bf85cd4dc6251
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp311-cp311-win32.whl

Download URL pymatgen-2024.10.3-cp311-cp311-win32.whl
Size 3.6 MB
Tags CPython 3.11 Windows x86-32
SHA-256 checksum
How to use checksums
8d187b1f13f95f28f8f7d03c8da89b30abe94aa529543da2200dec2ff09a0d5e
BLAKE2b-256 checksum
How to use checksums
7cd7d6a785a1d35409af520bc0e3134e36f70ea6a299aef5ce133f820a5f7834
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL pymatgen-2024.10.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 5.0 MB
Tags CPython 3.11 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
52abf47d09adcd6d44458e3349bcf0b12f13725d497ff385c4e202f542d53045
BLAKE2b-256 checksum
How to use checksums
92b4fdfb3f0469129513ce3c72789e8dae8e9abf308dd883aeb28df79c5e2e1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp311-cp311-macosx_11_0_arm64.whl

Download URL pymatgen-2024.10.3-cp311-cp311-macosx_11_0_arm64.whl
Size 3.6 MB
Tags CPython 3.11 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
55bbbda999f3b0840eb314b7511fad8628b4ff51ad96445ecb3b7672347ff1c0
BLAKE2b-256 checksum
How to use checksums
658bf9ad136660351cfcec6dad6c4d687aed311ef5c89a16d829250b033ba2dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.5

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

Download URL pymatgen-2024.10.3-cp310-cp310-win_amd64.whl
Size 3.6 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
db58341d8d56560d4a3b574795cbd577511611ebfbc141c9567fb06afad3d57c
BLAKE2b-256 checksum
How to use checksums
87a94828fb06f0bf422a95013f3e66bea159086e1c379a8bd03425e7e41437aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp310-cp310-win32.whl

Download URL pymatgen-2024.10.3-cp310-cp310-win32.whl
Size 3.6 MB
Tags CPython 3.10 Windows x86-32
SHA-256 checksum
How to use checksums
9bf737ab4e04e640af2c91a9e1dc78c5b7f20bb0e245485192bbf30163855220
BLAKE2b-256 checksum
How to use checksums
be85812c2ebdc042a878462f7a26217ebf65f5d4b9f50b8d903ce6b8f547404d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL pymatgen-2024.10.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 4.9 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64
SHA-256 checksum
How to use checksums
54914e94887625083f7f788d266aaa8a9941aa759141e902c279dd78407ae923
BLAKE2b-256 checksum
How to use checksums
abbb24b617ad00cee24a5957a632882336134878c24807bcecfd9287a6825586
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pymatgen-2024.10.3-cp310-cp310-macosx_11_0_arm64.whl

Download URL pymatgen-2024.10.3-cp310-cp310-macosx_11_0_arm64.whl
Size 3.6 MB
Tags CPython 3.10 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
b20e382bbcd550eb4e41fc9a257d28b3f907e4ef4fb1e93c4fe6e626263540d3
BLAKE2b-256 checksum
How to use checksums
d4b57a6a6b628095e715fd9ec3a1ff9d60f1430e41f8445bd5ba88583548b4d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Security for pymatgen 2024.10.3

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

2024.10.3 This release

13 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