Skip to content

Commit

Permalink
Merge pull request #5 from rinikerlab/readmeUpdate
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
MTLehner committed Oct 9, 2023
2 parents e47d98b + d88240c commit 1100c80
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Welcome to Serenityff-Charge
Welcome to DASH
==============================

[//]: # (Badges)
Expand All @@ -17,7 +17,7 @@ Description

Additionally, this repository contains all tools and functions needed to generate a new decision tree for partial charge assignmend, based on the attention data of a graph neural network, cabable of predicting the partial charges of a molecule.

This repository contains code for the publication by M. Lehner et al. DOI: [arXiv:2305.15981](https://doi.org/10.48550/arXiv.2305.15981)
This repository contains code for the publication by M. Lehner et al. DOI: [arXiv:2305.15981](https://doi.org/10.48550/arXiv.2305.15981) and [10.1021/acs.jcim.3c00800](https://pubs.acs.org/doi/full/10.1021/acs.jcim.3c00800)


Content
Expand Down Expand Up @@ -61,8 +61,8 @@ Installation

```bash
conda env create -f environment.yml
conda activate serenityff-charge
conda activate dash
python setup.py install
```

This will create a conda enviroment with the correct packages and install the openff plugin for partial charge assignment in openff.
This will create a conda enviroment with the correct packages and install the openff plugin for partial charge assignment in openff. If you plan on only using the DASH tree and not developing new trees you can also use the file `min_environment.yml` instead, which does not contain any pytorch and pytorch geometric libraries.
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: sff
name: dash
channels:
- defaults
- conda-forge
Expand Down
31 changes: 31 additions & 0 deletions min_environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: dash
channels:
- defaults
- conda-forge
- pytorch
- pyg
dependencies:
- sphinx_rtd_theme
- python
- numpy
- m2r
- conda-build
- typing
- mpmath
- scipy
- nbsphinx
- pytest
- numba
- sympy
- pandas
- sphinx
- rdkit
- openff-toolkit=0.10.0
- codecov
- pandoc
- pytest-cov
- pytables
- pip
- pre-commit
- ipykernel
- py3dmol

0 comments on commit 1100c80

Please sign in to comment.