Skip to main content

MATerial and Atomic Databases Of Refined structures.

Project description

GH Actions Coverage Status Documentation Status MIT License

matador is an aggregator, manipulator and runner of first-principles calculations, written with a bent towards battery electrode materials. The source can be found on GitHub and online documentation is hosted on ReadTheDocs.

Example Jupyter notebooks and tutorials can be found online or in the examples/ folder of the matador source code.

Written & maintained by Matthew Evans (2016-).

docs/src/img/lipzn.png

Installation

In the simplest case, pip install matador-db is sufficient to get up and running, preferably in a fresh virtual environment. More detailed instructions can be found in the Installation instructions.

Usage

For basic command-line usage, please explore the help system for each sub-command. Common workflows can be found inside examples/ and in the online docs.

Please consult the full Python API documentation for programmatic usage.

usage: matador [-h] [--version]
               {stats,query,import,hull,voltage,changes,hulldiff,swaps,refine}
               ...

MATerial and Atomic Database Of Refined structures.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

subcommands:
  valid sub-commands

  {stats,query,import,hull,voltage,changes,hulldiff,swaps,refine}
    stats               print some stats about the database.
    query               query and extract structures from the database
    import              import new structures in folder into database
    hull                create a convex hull from query results (currently
                        limited to binaries and ternaries)
    voltage             plot a voltage curve from query results (currently
                        limited to binaries and ternaries)
    changes             view database changelog or undo additions to database
                        (NB: not deletions!)
    hulldiff            diff two convex hulls with the --compare flag.
    swaps               perform atomic swaps on query results
    refine              update structures in the database according to
                        specified --task

Core functionality

The core functionality can be summarised by the various sub-commands of the command-line interface above. The API has many more features that can be explored in the examples and API documentation.

  • Scraping of CASTEP (and Quantum Espresso) input/output files into flexible Python dictionaries/models.
  • The creation and curation of MongoDB collections of geometry optimisation, calculations, with a powerful querying CLI/API.
  • Customisable, publication-ready plots for all models, e.g. phase diagrams, PDF, PXRD, voltage profiles, electronic/vibrational bandstructures etc.
  • Automated high-throughput geometry optimisations, electronic and vibrational properties using CASTEP (and Quantum Espresso) with run3. Tested on several supercomputers.
  • Creation of phase diagrams and electrochemical voltage profiles from the results of DFT calculations.

Project details


Download files

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

Files for matador-db, version 0.9.0
Filename, size File type Python version Upload date Hashes
Filename, size matador_db-0.9.0post1-py3-none-any.whl (417.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size matador_db-0.9.0-py3-none-any.whl (96.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size matador-db-0.9.0.tar.gz (4.1 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page