Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ jobs:
- name: Install project deps
run: |
uv sync --locked --extra cpu --group test
uv run scripts/install_pyg_deps.py --run
uv run --no-sync scripts/install_pyg_deps.py --run

- name: Run unit tests with coverage
run: |
uv run pytest test/ \
uv run --no-sync pytest test/ \
-m "not integration" \
--cov=./src \
--cov-report=xml:coverage.xml \
Expand Down Expand Up @@ -79,17 +79,11 @@ jobs:
- name: Install project deps
run: |
uv sync --locked --extra cpu --group test
uv run scripts/install_pyg_deps.py --run

- name: Install PyTorch Geometric
run: |
uv pip install torch_geometric \
pyg_lib torch_scatter torch_sparse torch_cluster torch_spline_conv \
-f https://data.pyg.org/whl/torch-${{ env.TORCH }}+${{ env.CUDA }}.html
uv run --no-sync scripts/install_pyg_deps.py --run

- name: Run integration tests
run: |
uv run pytest test/ \
uv run --no-sync pytest test/ \
-m "integration" \
--tb=short
env:
Expand Down
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ When chemtorch is on PyPI uncomment this ^^
[![Python versions](https://img.shields.io/pypi/pyversions/chemtorch.svg)](https://pypi.org/project/chemtorch)
[![Downloads](https://img.shields.io/github/downloads/heid-lab/chemtorch/total.svg)](https://github.com/heid-lab/chemtorch/releases) -->

[Quick Start](#🐎-quick-start) |
[Quick Start](#quick-start) |
[Documentation](https://heid-lab.github.io/chemtorch) |
[Contributing](#🤝-contributing) |
[White Paper](#📄-read-the-white-paper) |
[Citation](#❤️-citation)
[Contributing](#contributing) |
[White Paper](#white-paper) |
[Citation](#citation)

</div>

Expand All @@ -37,12 +37,16 @@ ChemTorch is a modular research framework for deep learning of chemical reaction

<!-- TODO: link to hosted GIF/mp4 of the ChemTorch CLI in action -->

<a id="quick-start"></a>

## 🐎 Quick Start
Follow the [Quick Start guide](https://heid-lab.github.io/chemtorch/getting_started/quick_start.html) to install all dependencies, download some data, and run your first experiment!
For more, checkout the [official ChemTorch documentation](https://heid-lab.github.io/chemtorch)!

<a id="white-paper"></a>

## 📄 Read the white paper
For a few examples of what you can already do with ChemTorch read our [white paper](https://chemrxiv.org/engage/chemrxiv/article-details/690357d9a482cba122e366b6) on ChemRxiv.
Check out the [software/benchmarking paper](https://pubs.acs.org/doi/10.1021/acs.jcim.5c02645) published in JCIM for a few examples of what you can already do with ChemTorch!

## 💬 Support
If you want to ask a question, report a bug, or suggest a feature feel free to open an issue on our [issue tracker](https://github.com/heid-lab/chemtorch/issues) and we will get back to you :)
Expand All @@ -54,10 +58,14 @@ To detect breaking changes early and safeguard your workflows:
- Check the [release notes](https://github.com/heid-lab/chemtorch/releases).
- Add and run [Integrity & Reproducibility tests](https://heid-lab.github.io/chemtorch/advanced_guide/integration_tests.html) for your experiments to ensure reproducibility of past results with newer releases.

<a id="contributing"></a>

## 🤝 Contributing
We welcome contributions.
Please read the [contribution guide](CONTRIBUTING.md) before opening issues or PRs.

<a id="citation"></a>

## ❤️ Citation
If you use this code in your research, please cite the following paper:

Expand All @@ -82,4 +90,4 @@ ChemTorch builds on and was inspired by many excellent open-source projects and
- [PyTorch Lightning](https://www.pytorchlightning.ai/) — cleaner training loops and logging
- [Weights & Biases](https://wandb.ai/site/models/) — experiment tracking and visualization in one place
- [GraphGPS](https://github.com/rampasek/GraphGPS) and [GraphGym](https://github.com/snap-stanford/GraphGym) — modular GNN repos which inspired this framework
- [lightning-hydra-template](https://github.com/ashleve/lightning-hydra-template) — project structure and integration patterns
- [lightning-hydra-template](https://github.com/ashleve/lightning-hydra-template) — project structure and integration patterns
Loading
Loading