https://github.com/facebookresearch/fairchem
FAIR Chemistry's library of machine learning methods for chemistry
https://github.com/facebookresearch/fairchem
Last synced: 8 days ago
JSON representation
FAIR Chemistry's library of machine learning methods for chemistry
- Host: GitHub
- URL: https://github.com/facebookresearch/fairchem
- Owner: facebookresearch
- License: other
- Created: 2019-09-26T04:47:27.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-23T00:05:32.000Z (14 days ago)
- Last Synced: 2025-04-23T00:35:09.007Z (14 days ago)
- Language: Python
- Homepage: https://fair-chem.github.io/
- Size: 27.7 MB
- Stars: 1,044
- Watchers: 27
- Forks: 294
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- best-of-atomistic-machine-learning - GitHub - 7% open · ⏱️ 23.04.2025): (Universal Potentials)
README
fairchem by FAIR Chemistry
[](https://github.com/codespaces/new/FAIR-Chem/fairchem?quickstart=1)
`fairchem` is the [FAIR](https://ai.meta.com/research/) Chemistry's centralized repository of all its data, models, demos, and application efforts for materials science and quantum chemistry.
> :warning: **If you cloned the repo before January 17, 2025 and are actively developing, please read [this announcement](GIT-CHANGES-17-01-25.md).**
### Documentation
If you are looking for `Open-Catalyst-Project/ocp`, it can now be found at [`fairchem.core`](src/fairchem/core). Visit its corresponding documentation [here](https://fair-chem.github.io/).
### Contents
The repository is organized into several directories to help you find what you are looking for:
- [`fairchem.core`](src/fairchem/core): State of the art machine learning models for materials science and chemistry
- [`fairchem.data`](src/fairchem/data): Dataset downloads and input generation codes
- [`fairchem.demo`](src/fairchem/demo): Python API for the [Open Catalyst Demo](https://open-catalyst.metademolab.com/)
- [`fairchem.applications`](src/fairchem/applications): Follow up applications and works (AdsorbML, CatTSunami, etc.)
### Installation
Packages can be installed in your environment by the following:
```
pip install -e packages/fairchem-{fairchem-package-name}
```
`fairchem.core` requires you to first create your environment
- [Installation Guide](https://fair-chem.github.io/core/install.html)
### Quick Start
Pretrained models can be used directly with ASE through our `OCPCalculator` interface:
```python
from ase.build import fcc100, add_adsorbate, molecule
from ase.optimize import LBFGS
from fairchem.core import OCPCalculator
# Set up your system as an ASE atoms object
slab = fcc100("Cu", (3, 3, 3), vacuum=8)
adsorbate = molecule("CO")
add_adsorbate(slab, adsorbate, 2.0, "bridge")
calc = OCPCalculator(
model_name="EquiformerV2-31M-S2EF-OC20-All+MD",
local_cache="pretrained_models",
cpu=False,
)
slab.calc = calc
# Set up LBFGS dynamics object
dyn = LBFGS(slab)
dyn.run(0.05, 100)
```
If you are interested in training your own models or fine-tuning on your datasets, visit the [documentation](https://fair-chem.github.io/) for more details and examples.
### Why a single repository?
Since many of our repositories rely heavily on our other repositories, a single repository makes it really easy to test and ensure consistency across repositories. This should also help simplify the installation process for users who are interested in integrating many of the efforts into one place.
### LICENSE
`fairchem` is available under a [MIT License](LICENSE.md).