Skip to content

Commit 2b259f1

Browse files
Merge pull request #84 from OMaraLab/recombinatrix-patch-3
Update getting_started.rst again
2 parents abf5b8d + c0c8e4a commit 2b259f1

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

docs/source/getting_started.rst

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,27 @@ This page details how to get started with *PolyConstruct*.
55

66
The design, testing, and validation of *PolyConstruct* is detailed in the manuscript "PolyConstruct:
77
adapting biomolecular simulation pipelines for polymers with PolyBuild, PolyConf and PolyTop", by
8-
**__Rangika Munaweera__**, **__Ada Quinn__**, Luna Morrow, Richard A Morris, Megan L O’Mara
8+
**Rangika Munaweera**, **Ada Quinn**, Luna Morrow, Richard A Morris, Megan L O’Mara
99

1010
Getting Started
1111
===============
1212

13-
1413
**Installing PolyConstruct:**
1514

16-
From your home directory, clone PolyConstruct from Git:
15+
From your home directory, clone *PolyConstruct* from GitHub:
1716

1817
.. code-block:: python
1918
2019
cd ~
2120
git clone https://github.com/OMaraLab/polyconstruct.git
2221
23-
Then navigate to polyconstruct:
22+
Then navigate to `~/PolyConstruct`:
2423

2524
.. code-block:: python
2625
2726
cd polyconstruct
2827
29-
To setup an environment for polyconstruct, run:
28+
To setup an environment for *PolyConstruct*, run:
3029

3130
.. code-block:: python
3231
@@ -35,7 +34,7 @@ To setup an environment for polyconstruct, run:
3534
3635
pip install -r requirements.txt
3736
38-
Then, build the PolyTop, PolyConf and PolyBuild packages:
37+
Then, build the *PolyTop*, *PolyConf* and *PolyBuild* packages:
3938

4039
.. code-block:: python
4140
@@ -87,8 +86,8 @@ Monomer design
8786
For both *PolyBuild* and *PolyTop*, monomer parameters should include all monomer atoms that will be present
8887
in the simulation model of the final polymer, and dummy atoms correesponding to connectivity with adjacent monomers.
8988
The method for preparing monomer .itp depends on the choice of force field, and a number of suitable automated tools
90-
exist for small molecule parameterization such as the `Automated Topology Builder <https://atb.uq.edu.au>`,
91-
`antechamber <https://ambermd.org/antechamber/ac.html>`, and `LigParGen https://zarbi.chem.yale.edu/ligpargen/`.
89+
exist for small molecule parameterization such as the `Automated Topology Builder <https://atb.uq.edu.au>`_,
90+
`antechamber <https://ambermd.org/antechamber/ac.html>`_, and `LigParGen <https://zarbi.chem.yale.edu/ligpargen/>_`.
9291

9392
Monomer coordinates and parameters used as inputs should be designed to reflect the state of the monomer
9493
in the mature polymer chain, rather than the isolated monomer molecule prior to polymerization. For example,
@@ -99,9 +98,8 @@ and not the ammonium and carboxylate groups found in the precursor amino acids.
9998
Monomer parameters should be designed in a manner consistent with the desired force field. We recommend you
10099
do not combine monomer parameters from different force field families in a single polymer.
101100

102-
103101
For *PolyConf* These coordinate files should represent a sensible monomer geometry as could be found in the final
104-
polymer. These might be created using tools like ChimeraX, with theoretical ideal bond lengths and
102+
polymer. These might be created using tools like `ChimeraX <https://www.cgl.ucsf.edu/chimerax/>`_, with theoretical ideal bond lengths and
105103
angles, by geometry optimization, or generated by automated parameterization tools. Additionally,
106104
it is often convenient if the monomer is in a conformation where atoms corresponding to adjacent monomers
107105
are as far as possible from other atoms, and pointed away from other attachment points.
@@ -114,7 +112,8 @@ Worked Examples
114112
PolyConf creates polymer coordinate files through the tiling and manipulation of monomer pdb files.
115113

116114
There are several detailed examples of the use of PolyConf to create ensembles of starting
117-
conformations for a series of increasingly complex polymer architectures. These are contained in the PolyConf repository in the folder 'polyconstruct/polyconf_examples/' contained in the
115+
conformations for a series of increasingly complex polymer architectures. These are contained in the
116+
*PolyConf* repository in the folder `polyconstruct/polyconf_examples/` contained in the
118117

119118
Here is one simple example, showing the construction of a linear polyethylenimine 128-mer.
120119

0 commit comments

Comments
 (0)