-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
FNTwin
committed
Jul 22, 2024
1 parent
e649bee
commit e2bb77a
Showing
103 changed files
with
3,460 additions
and
673 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -149,3 +149,6 @@ cookie.txt | |
*.txt | ||
*.sh | ||
.DS_Store | ||
*.zarr/ | ||
scripts/ | ||
notebooks/ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.base |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.alchemy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.ani |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.comp6 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.interaction.des |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.gdml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.geom.GEOM |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.iso_17 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.interaction.l7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.md22 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.interaction.metcalf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.molecule3d |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.multixcqm9 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.nabladft |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.orbnet_denali |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.pcqm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.proteinfragments |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.qm1b |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.qm7x |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.qmugs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.qmx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.revmd17 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.sn2_rxn |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.solvated_peptides |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
|
||
::: openqdc.datasets.potential.spice |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.interaction.splinter |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.tmqm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.transition1x |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.vqm24 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.waterclusters |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.potential.waterclusters3_30 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.interaction.x40 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.datasets.structure |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
# QM Methods | ||
|
||
::: openqdc.methods | ||
::: openqdc.methods.enums | ||
|
||
# Isolated Atom Energies | ||
|
||
::: openqdc.methods.atom_energies |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.utils.regressor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# UNITS | ||
|
||
::: openqdc.utils.units |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
::: openqdc.utils |
This file was deleted.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
# CLI for dataset downloading and uploading | ||
You can quickly download, fetch, preprocess and upload openQDC datasets using the command line interface (CLI). | ||
|
||
## Datasets | ||
Print a formatted table of the available openQDC datasets and some informations. | ||
|
||
Usage: | ||
|
||
openqdc datasets [OPTIONS] | ||
|
||
Options: | ||
|
||
--help Show this message and exit. | ||
|
||
## Cache | ||
Get the current local cache path of openQDC | ||
|
||
Usage: | ||
|
||
openqdc cache [OPTIONS] | ||
|
||
Options: | ||
|
||
--help Show this message and exit. | ||
|
||
|
||
## Download | ||
Download preprocessed ml-ready datasets from the main openQDC hub. | ||
|
||
Usage: | ||
|
||
openqdc download DATASETS... [OPTIONS] | ||
|
||
Options: | ||
|
||
--help Show this message and exit. | ||
--overwrite Whether to force the re-download of the datasets and overwrite the current cached dataset. [default: no-overwrite] | ||
--cache-dir Path to the cache. If not provided, the default cache directory (.cache/openqdc/) will be used. [default: None] | ||
--as-zarr Whether to use a zarr format for the datasets instead of memmap. [default: no-as-zarr] | ||
--gs Whether source to use for downloading. If True, Google Storage will be used.Otherwise, AWS S3 will be used [default: no-gs] | ||
|
||
Example: | ||
|
||
openqdc download Spice | ||
|
||
## Fetch | ||
Download the raw datasets files from the main openQDC hub | ||
|
||
Note: | ||
|
||
Special case: if the dataset is "all", "potential", "interaction". | ||
|
||
Usage: | ||
|
||
openqdc fetch DATASETS... [OPTIONS] | ||
|
||
Options: | ||
|
||
--help Show this message and exit. | ||
--overwrite Whether to overwrite or force the re-download of the raw files. [default: no-overwrite] | ||
--cache-dir Path to the cache. If not provided, the default cache directory (.cache/openqdc/) will be used. [default: None] | ||
|
||
Example: | ||
|
||
openqdc fetch Spice | ||
|
||
## Preprocess | ||
Preprocess a raw dataset (previously fetched) into a openqdc dataset and optionally push it to remote. | ||
|
||
Usage: | ||
|
||
openqdc preprocess DATASETS... [OPTIONS] | ||
|
||
Options: | ||
|
||
--help Show this message and exit. | ||
--overwrite Whether to overwrite the current cached datasets. [default: overwrite] | ||
--upload Whether to attempt the upload to the remote storage. Must have write permissions. [default: no-upload] | ||
--as-zarr Whether to preprocess as a zarr format or a memmap format. [default: no-as-zarr] | ||
|
||
Example: | ||
|
||
openqdc preprocess Spice QMugs | ||
|
||
## Upload | ||
Upload a preprocessed dataset to the remote storage | ||
|
||
Usage: | ||
|
||
openqdc upload DATASETS... [OPTIONS] | ||
|
||
Options: | ||
|
||
--help Show this message and exit. | ||
--overwrite Whether to overwrite the remote files if they are present. [default: overwrite] | ||
--as-zarr Whether to upload the zarr files if available. [default: no-as-zarr] | ||
|
||
Example: | ||
|
||
openqdc upload Spice --overwrite | ||
|
||
## Convert | ||
Convert a preprocessed dataset from a memmap dataset to a zarr dataset. | ||
|
||
Usage: | ||
|
||
openqdc convert DATASETS... [OPTIONS] | ||
|
||
Options: | ||
|
||
--help Show this message and exit. | ||
--overwrite Whether to overwrite the current zarr cached datasets. [default: no-overwrite] | ||
--download Whether to force the re-download of the memmap datasets. [default: no-download] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Contribute | ||
|
||
The below documents the development lifecycle of OpenQDC. | ||
|
||
## Setup a dev environment | ||
|
||
```bash | ||
mamba env create -n openqdc -f env.yml | ||
mamba activate datamol | ||
pip install -e . | ||
``` | ||
|
||
## Pre commit installation | ||
|
||
```bash | ||
pre-commit install | ||
pre-commit run --all-files | ||
``` | ||
|
||
## Continuous Integration | ||
|
||
OpenQDC uses Github Actions to: | ||
|
||
- **Build and test** `openQDC`. | ||
- Multiple combinations of OS and Python versions are tested. | ||
- **Check** the code: | ||
- Formatting with `black`. | ||
- Static type check with `mypy`. | ||
- Modules import formatting with `isort`. | ||
- Pre-commit hooks. | ||
- **Documentation**: | ||
- Google docstring format. | ||
- build and deploy the documentation on `main` and for every new git tag. | ||
|
||
|
||
## Run tests | ||
|
||
```bash | ||
pytest | ||
``` | ||
|
||
## Build the documentation | ||
|
||
You can build and serve the documentation locally with: | ||
|
||
```bash | ||
# Build and serve the doc | ||
mike serve | ||
``` | ||
|
||
or with | ||
|
||
```bash | ||
mkdocs serve | ||
``` | ||
|
||
### Multi-versionning | ||
|
||
The doc is built for eash push on `main` and every git tags using [mike](https://github.com/jimporter/mike). Everything is automated using Github Actions. Please refer to the official mike's documentation for the details. |
Oops, something went wrong.