Skip to main content

Data-driven materials discovery based on composition.

Reason this release was yanked:

bug in CrabNet that caused MAE to spike

Project description

DiSCoVeR

Open In Colab (PyPI) Open in Code Ocean Interactive Figures Read the Docs GitHub Workflow Status

PyPI version Code style: black Coverage Status Lines of code License DOI

Conda Conda Conda Anaconda-Server Badge

A materials discovery algorithm geared towards exploring high performance candidates in new chemical spaces using composition-only.

Bulk modulus values overlaid on DensMAP densities (cropped).

The documentation describes the DiSCoVeR algorithm, how to install mat_discover, and basic usage (fit/predict, custom or built-in datasets, adaptive design, and cluster plots). Interactive plots for several types of Pareto front plots are available. We also describe how to contribute, and what to do if you run into bugs or have questions. Various examples (including a teaching example), the interactive figures mentioned, and the Python API are also hosted at https://mat-discover.readthedocs.io. The article is published at Digital Discovery. If you find this useful, please consider citing as follows:

Citing

Baird, S. G.; Diep, T. Q.; Sparks, T. D. DiSCoVeR: A Materials Discovery Screening Tool for High Performance, Unique Chemical Compositions. Digital Discovery 2022. https://doi.org/10.1039/D1DD00028D.

@article{bairdDiSCoVeRMaterialsDiscovery2022,
  title = {{{DiSCoVeR}}: A {{Materials Discovery Screening Tool}} for {{High Performance}}, {{Unique Chemical Compositions}}},
  shorttitle = {{{DiSCoVeR}}},
  author = {Baird, Sterling Gregory and Diep, Tran Q. and Sparks, Taylor D.},
  year = {2022},
  month = feb,
  journal = {Digital Discovery},
  publisher = {{RSC}},
  issn = {2635-098X},
  doi = {10.1039/D1DD00028D},
  abstract = {We present Descending from Stochastic Clustering Variance Regression (DiSCoVeR) (https://github.com/sparks-baird/mat_discover), a Python tool for identifying and assessing high-performing, chemically unique compositions relative to existing compounds using a combination of a chemical distance metric, density-aware dimensionality reduction, clustering, and a regression model. In this work, we create pairwise distance matrices between compounds via Element Mover's Distance (ElMD) and use these to create 2D density-aware embeddings for chemical compositions via Density-preserving Uniform Manifold Approximation and Projection (DensMAP). Because ElMD assigns distances between compounds that are more chemically intuitive than Euclidean-based distances, the compounds can then be clustered into chemically homogeneous clusters via Hierarchical Density-based Spatial Clustering of Applications with Noise (HDBSCAN*). In combination with performance predictions via Compositionally-Restricted Attention-Based Network (CrabNet), we introduce several new metrics for materials discovery and validate DiSCoVeR on Materials Project bulk moduli using compound-wise and cluster-wise validation methods. We visualize these via multi-objective Pareto front plots and assign a weighted score to each composition that encompasses the trade-off between performance and density-based chemical uniqueness. In addition to density-based metrics, we explore an additional uniqueness proxy related to property gradients in DensMAP space. As a validation study, we use DiSCoVeR to screen materials for both performance and uniqueness to extrapolate to new chemical spaces. Top-10 rankings are provided for the compound-wise density and property gradient uniqueness proxies. Top-ranked compounds can be further curated via literature searches, physics-based simulations, and/or experimental synthesis. Finally, we compare DiSCoVeR against the naive baseline of random search for several parameter combinations in an adaptive design scheme. To our knowledge, this is the first time automated screening has been performed with explicit emphasis on discovering high-performing, novel materials.},
  langid = {english},
}

If you use this software, in addition to the above reference, please also cite the Zenodo DOI and state the version that you used:

Sterling Baird. (2022). sparks-baird/mat_discover. Zenodo. https://doi.org/10.5281/zenodo.5594678

@software{sterling_baird_2022_6116258,
  author       = {Sterling Baird},
  title        = {sparks-baird/mat\_discover},
  month        = feb,
  year         = 2022,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.5594678},
  url          = {https://doi.org/10.5281/zenodo.5594678}
}

If you use this software as an installed dependency in another GitHub repository, please add mat_discover to a requirements.txt file in your repository via e.g.:

pip install pipreqs
pipreqs .

pipreqs generates (at least a starting point) for a requirements.txt file based on import statements in your working directory and subfolders. For an example, see requirements.txt.

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

mat_discover-2.1.6.tar.gz (17.0 MB view details)

Uploaded Source

Built Distribution

mat_discover-2.1.6-py2.py3-none-any.whl (37.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file mat_discover-2.1.6.tar.gz.

File metadata

  • Download URL: mat_discover-2.1.6.tar.gz
  • Upload date:
  • Size: 17.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.27.1

File hashes

Hashes for mat_discover-2.1.6.tar.gz
Algorithm Hash digest
SHA256 b7ad3449285041ab119f6fcab7ff028876ae8b4ea101af8170a056b25f02a76c
MD5 4bb1d3a8fc7dead2f667b03f4d2363bc
BLAKE2b-256 7f16a269d484ee8cb8fa48eec693e4d8b03aee89edcc48ad2d3a317bec440f3a

See more details on using hashes here.

File details

Details for the file mat_discover-2.1.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mat_discover-2.1.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 59fcc50d048789eb2da1072c27f5a1d837b9f98eea2e7d40adb1e97895b36272
MD5 454ef4d560c48c2b535057b77036b629
BLAKE2b-256 550369e834c164f0474352355067b6b7680d46b86ea690f533f3a19d8bae4739

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