energy-gnome

AI-Driven Screening and Prediction for Selected Advanced Energy Materials

https://github.com/paolodeangelis/energy-gnome

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 19 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org, nature.com, zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

AI-Driven Screening and Prediction for Selected Advanced Energy Materials

Basic Info
  • Host: GitHub
  • Owner: paolodeangelis
  • License: cc-by-4.0
  • Language: Python
  • Default Branch: main
  • Size: 306 MB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 3
Created over 1 year ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Zenodo

README.md

Energy-GNoME

Energy-GNoMs

AI-Driven Screening and Prediction for Selected Advanced Energy Materials

DOI

This repository contains the database, documentation, Python library (coming soon), and notebooks used to build the Energy-GNoME database.

The purpose of this repository is to enable reproducibility and, more importantly, to support the continuous integration of your data points for model training, as the database is designed as a living database.

For further details, refer to the associated article:

De Angelis P., Trezza G., Barletta G., Asinari P., Chiavazzo E. "Energy-GNoME: A Living Database of Selected Materials for Energy Applications".arXiv, November 15,2024. doi:10.48550/arXiv.2411.10125.

How to cite

If you find this project valuable, please consider citing the following pre-print work:

De Angelis P., Trezza G., Barletta G., Asinari P., Chiavazzo E. "Energy-GNoME: A Living Database of Selected Materials for Energy Applications". arXiv November 15, 2024. doi: 10.48550/arXiv.2411.10125.

```bibtex

@misc{deangelisenergy-gnome:2024, title = {Energy-{GNoME}: {A} {Living} {Database} of {Selected} {Materials} for {Energy} {Applications}}, shorttitle = {Energy-{GNoME}}, url = {http://arxiv.org/abs/2411.10125}, doi = {10.48550/arXiv.2411.10125}, abstract = {Artificial Intelligence (AI) in materials science is driving significant advancements in the discovery of advanced materials for energy applications. The recent GNoME protocol identifies over 380,000 novel stable crystals. From this, we identify over 33,000 materials with potential as energy materials forming the Energy-GNoME database. Leveraging Machine Learning (ML) and Deep Learning (DL) tools, our protocol mitigates cross-domain data bias using feature spaces to identify potential candidates for thermoelectric materials, novel battery cathodes, and novel perovskites. Classifiers with both structural and compositional features identify domains of applicability, where we expect enhanced accuracy of the regressors. Such regressors are trained to predict key materials properties like, thermoelectric figure of merit (zT), band gap (Eg), and cathode voltage (\${\textbackslash}Delta V_c\$). This method significantly narrows the pool of potential candidates, serving as an efficient guide for experimental and computational chemistry investigations and accelerating the discovery of materials suited for electricity generation, energy storage and conversion.}, urldate = {2024-12-03}, publisher = {arXiv}, author = {De Angelis, Paolo and Trezza, Giovanni and Barletta, Giulio and Asinari, Pietro and Chiavazzo, Eliodoro}, month = nov, year = {2024}, note = {arXiv:2411.10125}, keywords = {Condensed Matter - Materials Science, Condensed Matter - Other Condensed Matter, Computer Science - Machine Learning}, }

```

Additional articles to cite:

  • GNoME Database: Additionally, please consider citing the foundational GNoME database work:

    Merchant, A., Batzner, S., Schoenholz, S.S. et al. "Scaling deep learning for materials discovery". Nature 624, 80-85, 2023. doi: 10.1038/s41586-023-06735-9.

  • E(3)NN Model: And the E(3)NN Graph Neural Network model

    Chen Z., Andrejevic N., Smidt T. et al. " Direct Prediction of Phonon Density of States With Euclidean Neural Networks." Advanced Science 8 (12), 2004214, 2021. 10.1002/advs.202004214

Project Status

  • [x] Databases:
    • [X] Cathodes
    • [x] Perovskites
    • [x] Thermoelectrics
  • [x] Dashboards
    • [x] Cathodes
    • [x] Perovskites
    • [x] Thermoelectrics
  • [ ] energy-gnome python library
    • [X] Data handlers Objects
    • [X] Model handlers Objects
    • [ ] CLI e-gnome
  • [X] jupyter notebooks tutorials
    • [X] Perovskites
    • [X] Thermoelectrics
    • [X] Materials Project
    • [X] GNoME
    • [X] E(3)NN Regressor
    • [X] GBDT Regressor
    • [X] GBDT Classifier

Detailed TODO list: - energy-gnome API - energy-gnome CLI - energy-gnome documentation

Project Organization

`` LICENSE <- Open-source license if one is chosen Makefile <- Makefile with convenience commands likemake dataormake train` README.md <- The top-level README for developers using this project. data external <- Data from third party sources. final <- The screened candidates, along with predictions on their properties of interest. interim <- Intermediate data that has been transformed. processed <- The final, canonical data sets for modeling. raw <- The original, immutable data dump.

docs <- A default mkdocs project; see www.mkdocs.org for details

models <- Trained and serialized models, model predictions, or model summaries

notebooks <- Jupyter notebooks demonstrating example usage of the energy-gnome.

pyproject.toml <- Project configuration file with package metadata for energy_gnome and configuration for tools like black

references <- Data dictionaries, manuals, and all other explanatory materials.

reports <- Generated analysis as HTML, PDF, LaTeX, etc. figures <- Generated graphics and figures to be used in reporting

requirements.txt <- The requirements file for reproducing the analysis environment, e.g. generated with pip freeze > requirements.txt

setup.cfg <- Configuration file for flake8

energy_gnome <- Source code for use in this project.

 __init__.py    <- Makes energy_gnome a Python module

 config.py      <- Store useful variables and configuration

 dataset        <- Scripts to handle data and features for modeling

 models         <- Scripts to handle ML models

```


Contributing

Work in Progress

We are actively working on improving testing and refining the API to support the seamless integration of new models and datasets. Our goal is to keep the project aligned with the latest advancements in computational materials science.

How You Can Contribute While the contribution process is still under development, youre welcome to get involved by:

Reviewing the contribution guidelines and our Code of Conduct.

Forking the repository and creating a feature branch.

Adding your model or dataset (note: the test suite is still under construction).

Submitting a pull request for review.

For Larger Contributions If you're interested in integrating new material descriptors or machine learning models (for regression or classification), we recommend:

Opening an issue to discuss your proposal, or

Contacting us directly at paolo.deangelis@polito.it for guidance and support.

We are happy to assist with integration and discuss potential research collaborations using the protocol or database.


Creative Commons Licence   SMALL site   POLITO site

Owner

  • Name: Paolo De Angelis
  • Login: paolodeangelis
  • Kind: user
  • Location: Torino
  • Company: Politecnico di Torino

GitHub Events

Total
  • Release event: 6
  • Delete event: 7
  • Push event: 89
  • Pull request review event: 1
  • Pull request event: 30
  • Create event: 10
Last Year
  • Release event: 6
  • Delete event: 7
  • Push event: 89
  • Pull request review event: 1
  • Pull request event: 30
  • Create event: 10

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 9
  • Average time to close issues: 4 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 1
  • Bot pull requests: 2
Past Year
  • Issues: 1
  • Pull requests: 9
  • Average time to close issues: 4 months
  • Average time to close pull requests: 5 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 5
  • Bot issues: 1
  • Bot pull requests: 2
Top Authors
Issue Authors
Pull Request Authors
  • giuliobarl (15)
  • pre-commit-ci[bot] (2)
Top Labels
Issue Labels
Pull Request Labels