Skip to main content

Python Materials Genomics is a robust materials analysis code that defines core object representations for structures and molecules with support for many electronic structure codes. It is currently the core analysis code powering the Materials Project (https://www.materialsproject.org).

Project description


.. image:: https://circleci.com/gh/materialsproject/pymatgen.svg?style=shield&circle-token=:circle-token

.. image:: https://ci.appveyor.com/api/projects/status/akdyke5jxg6gps45?svg=true

.. image:: https://anaconda.org/matsci/pymatgen/badges/downloads.svg

.. image:: https://coveralls.io/repos/github/materialsproject/pymatgen/badge.svg?branch=master

Official docs: `http://pymatgen.org <http://pymatgen.org/>`_

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,
Structure objects.
2. Extensive input/output support, including support for VASP
(http://cms.mpi.univie.ac.at/vasp/), ABINIT (http://www.abinit.org/), 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 own contributions. These contributions can be in the
form of additional tools or modules you develop, or feature requests and bug
reports. Please report any bugs and issues at pymatgen's `Github page
<https://github.com/materialsproject/pymatgen>`_. If you wish to be notified
of pymatgen releases, you may become a member of `pymatgen's Google Groups page
<https://groups.google.com/forum/?fromgroups#!forum/pymatgen/>`_.


Why use pymatgen?
=================

There are many materials analysis codes out there, both commerical and free,
but pymatgen offer several advantages:

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
`CircleCI <https://circleci.com>`_ and `Appveyor <https://www.appveyor.com/>`_
for continuous integration on the Linux and Windows platforms,
respectively, which ensures that every commit passes a comprehensive suite
of unittests. The coverage of the unittests can be seen at
`here <coverage/index.html>`_.
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.

With effect from version 3.0, pymatgen now supports both Python 2.7 as well
as Python 3.x. All developers must ensure that their code passes the
unittests on both Py2.7 and 3.x.


Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymatgen-2017.8.20.tar.gz (1.6 MB view details)

Uploaded Source

Built Distributions

pymatgen-2017.8.20-cp36-cp36m-win_amd64.whl (1.9 MB view details)

Uploaded CPython 3.6m Windows x86-64

pymatgen-2017.8.20-cp36-cp36m-macosx_10_7_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.6m macOS 10.7+ x86-64

pymatgen-2017.8.20-cp35-cp35m-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.5m macOS 10.9+ x86-64

pymatgen-2017.8.20-cp27-cp27m-macosx_10_7_x86_64.whl (2.0 MB view details)

Uploaded CPython 2.7m macOS 10.7+ x86-64

File details

Details for the file pymatgen-2017.8.20.tar.gz.

File metadata

File hashes

Hashes for pymatgen-2017.8.20.tar.gz
Algorithm Hash digest
SHA256 f80386d3a55c707fcc41e5bb50a12867cf17df87c0e33446e852456a331d7491
MD5 6b95dc36b68db3eac6f208819e1ab3a0
BLAKE2b-256 9624d75e9a718807c3712c060524f4fb86de7334874c1b1c8760fb3a21005879

See more details on using hashes here.

File details

Details for the file pymatgen-2017.8.20-cp36-cp36m-win_amd64.whl.

File metadata

File hashes

Hashes for pymatgen-2017.8.20-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 dfe5bae331d2aee0e76987fdb797e9d2c4539d5e970d4c1f01ee789aa3f77e2b
MD5 40e21e58d3f99efe2d815fbff6eb182a
BLAKE2b-256 233f1e1dd4c8c060f79da4086d4e28405487405d2fdf66678c9ec9f2b6b341d5

See more details on using hashes here.

File details

Details for the file pymatgen-2017.8.20-cp36-cp36m-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for pymatgen-2017.8.20-cp36-cp36m-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 3f3e4a8e8e2ce161137b4d33edd2d32f2d8971c405ef113983fe339dc7494312
MD5 6de05ee72d46fd1c2bc4dcd1430a46a4
BLAKE2b-256 477be65b01d84ecca1a0f475161b2562069a78682083714c006c22bfdf334720

See more details on using hashes here.

File details

Details for the file pymatgen-2017.8.20-cp35-cp35m-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pymatgen-2017.8.20-cp35-cp35m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 7f56ab8a4cd2f64f0ff3f04c43d42ea18024ad12f064741c1d13ea1c144eeeed
MD5 b67ed0fbc1df93a1c1b85c664cd98638
BLAKE2b-256 8c8ea429991e8bd0017bf560a0082b66c7bb8bd082ee51d2d28971b8841c7aea

See more details on using hashes here.

File details

Details for the file pymatgen-2017.8.20-cp27-cp27m-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for pymatgen-2017.8.20-cp27-cp27m-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 f4c0fd75bb9ab745a6068bf529255c4ecaa26dcb98ee598456745f83620d9e13
MD5 5adedb0755de96e3c8a31310c6a611c8
BLAKE2b-256 d616d04ad5557b1849a1dea9b2838aa880b1a21e387dcee95d45ba18e9c03954

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