Skip to content

Commit

Permalink
readme add matcalc logo and document matcalc purpose for MP
Browse files Browse the repository at this point in the history
  • Loading branch information
janosh committed Aug 3, 2023
1 parent 379112c commit bf02714
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 2 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
exclude: ^(docs|.*test_files|cmd_line|tasks.py)

ci:
autoupdate_schedule: monthly
skip: [mypy]
Expand All @@ -8,7 +6,7 @@ ci:

repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.0.278
rev: v0.0.282
hooks:
- id: ruff
args: [--fix]
Expand All @@ -24,7 +22,7 @@ repos:
- repo: https://github.com/psf/black
rev: 23.7.0
hooks:
- id: black
- id: black-jupyter

- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.4.1
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<p align="center">
<img src="https://github.com/materialsvirtuallab/matcalc/assets/30958850/89486f2f-73fb-40fb-803a-dfafe510eb6d" width="200" height="200" alt="matcalc logo" align="center" />
</p>

# MatCalc

[![GitHub license](https://img.shields.io/github/license/materialsvirtuallab/matcalc)](https://github.com/materialsvirtuallab/matcalc/blob/main/LICENSE)
Expand All @@ -15,6 +19,8 @@ Calculating various materials properties can require relatively involved setup o
goal of MatCalc is to provide a simplified, consistent interface to access these properties with any
parameterization of the PES.

The purpose of MatCalc is to a unified interface for integrating MLIPs into the Materials Project (MP) [Builders infrastructure](https://github.com/materialsproject/emmet) and eventually integrate ML predictions into the MP Code database.

## Outline

The main base class in MatCalc is PropCalc (property calculator). All PropCalc subclasses should implement a
Expand Down

0 comments on commit bf02714

Please sign in to comment.