Skip to content

Commit

Permalink
install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lwilbraham committed Aug 9, 2020
1 parent bd0a873 commit e3ee1f9
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.egg-info
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ repeat units (each of which are 2 monomers long) and explore 100 conformers whil
applying an implicit solvent model for benzene:

```python
session = polyhts.Session('my_session', 2, 4, 100, solvent='benzene')
session = polyhts.Session('my_session', 2, 4, 100, solvent='benzene')
```
This way, we can explore co-polymer compositions with arbitrary repeat unit complexity
and polymer chain length.
Expand All @@ -42,7 +42,7 @@ and polymer chain length.
Within this session, we can screen all combinations of pre-supplied monomer unit
SMILES from a text file:
```python
session.screen('smiles-list.txt', nprocs=20)
session.screen('smiles-list.txt', nprocs=20)
```
where `smiles-list.txt` has the format:
```
Expand All @@ -68,7 +68,7 @@ of smiles explicitly, where the length of this list is equivalent to the
repeat unit length:

```python
session.calc_polymer_properties(['c1c(Br)cc(Br)cc1', 'c1c(Br)cc(Br)cc1'], 'polymer-name')
session.calc_polymer_properties(['c1c(Br)cc(Br)cc1', 'c1c(Br)cc(Br)cc1'], 'polymer-name')
```
Following the `stk` documentation, `Br` atoms are places within SMILES strings
where monomer units are to be connected to one another.
Expand All @@ -77,6 +77,7 @@ where monomer units are to be connected to one another.
clone the repo and then:
```
$ cd polyhts
$ pip install -r requirements.txt
$ pip install -e .
```
You will also need to install RDKit, which can be installed via conda:
Expand All @@ -85,7 +86,7 @@ $ conda install -c rdkit rdkit
```

## references
* [1] J. Chem. Inf. Model. 2015, 121, 2562-2574
* [1] J. Chem. Inf. Model. 2015, 121, 2562-2574
* [2] J. Chem. Theory Comput. 2017, 13, 1989-2009
* [3] Comput. Theor. Chem. 2014, 1040, 45-53
* [4] J. Chem. Phys. 2016, 145, 054103
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
joblib==0.16.0
19 changes: 19 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
from distutils.core import setup
from setuptools import find_packages

setup(
name = 'polyhts',
packages = ['polyhts'],
version = '0.1',
license='MIT',
description = 'Polymer electronic property screening package.',
author = 'Liam Wilbraham',
author_email = '[email protected]',
url = 'https://github.com/LiamWilbraham/polyhts',
download_url = 'https://github.com/LiamWilbraham/polyhts/archive/v_01.tar.gz',
keywords = ['cheminformatics', 'chemistry', 'materials'],
classifiers=[
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
],
)

0 comments on commit e3ee1f9

Please sign in to comment.