Skip to content

Commit abf5b8d

Browse files
Merge pull request #83 from OMaraLab/recombinatrix-patch-2
Update getting_started.rst
2 parents f6a8224 + b104d89 commit abf5b8d

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

docs/source/getting_started.rst

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
Getting Started
1+
PolyConstruct
22
===============
33

44
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
9+
10+
Getting Started
11+
===============
12+
913

1014
**Installing PolyConstruct:**
1115

@@ -49,26 +53,37 @@ Then, build the PolyTop, PolyConf and PolyBuild packages:
4953
5054
5155
52-
Input files and monomer design
56+
Input files
5357
===============
5458

59+
**PolyConf**
60+
5561
*PolyConf* assembles polymer pdb files by tiling individual monomer pdb files. Monomer PDB files should
5662
include all monomer atoms that will be present in the final polymer, dummy atoms corresponding to
5763
connectivity with adjacent monomers, and `CONECT` records that describe the connectivity between
5864
monomer atoms.
5965

60-
These coordinate files should represent a sensible monomer geometry as could be found in the final
61-
polymer. These might be created using tools like ChimeraX, with theoretical ideal bond lengths and
62-
angles, by geometry optimization, or generated by automated parameterization tools. Additionally,
63-
it is often convenient if the monomer is in a conformation where atoms corresponding to adjacent monomers
64-
are as far as possible from other atoms, and pointed away from other attachment points.
66+
*PolyConf* does not require any preprocessing of monomer .pdb files.
67+
68+
**PolyBuild**
6569

6670
*PolyBuild* requires monomer itp files, which are then converted into gromacs residue topology database
6771
entries, and a coordinate file containing a complete structure of the intended polymer. This structure can
6872
be created with PolyConf, manually, or by using other structure creation packages.
6973

74+
PolyBuild leverages GROMACS tools to automatically parameterise polymers. and requires
75+
.itp files to be converted to RTP database entries using the provided `ITP2RTP` program.
76+
For more infomation, see the :ref:`PolyBuild` documentation.
77+
78+
**PolyTop**
79+
7080
*PolyTop* requires monomer itp files describing all monomers that will be contained in the system.
7181

82+
*PolyTop* does not require any preprocessing of monomer .itp files.
83+
84+
Monomer design
85+
===============
86+
7287
For both *PolyBuild* and *PolyTop*, monomer parameters should include all monomer atoms that will be present
7388
in the simulation model of the final polymer, and dummy atoms correesponding to connectivity with adjacent monomers.
7489
The method for preparing monomer .itp depends on the choice of force field, and a number of suitable automated tools
@@ -84,12 +99,12 @@ and not the ammonium and carboxylate groups found in the precursor amino acids.
8499
Monomer parameters should be designed in a manner consistent with the desired force field. We recommend you
85100
do not combine monomer parameters from different force field families in a single polymer.
86101

87-
For PolyConf and PolyTop, monomer .itp and .pdb files do not need to be pre-processed.
88-
89-
PolyBuild leverages GROMACS tools to automatically parameterise polymers. and requires
90-
.itp files to be converted to RTP database entries using the provided `ITP2RTP` program.
91-
For more infomation, see the :ref:`PolyBuild` documentation.
92102

103+
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
105+
angles, by geometry optimization, or generated by automated parameterization tools. Additionally,
106+
it is often convenient if the monomer is in a conformation where atoms corresponding to adjacent monomers
107+
are as far as possible from other atoms, and pointed away from other attachment points.
93108

94109
Worked Examples
95110
==================
@@ -331,4 +346,4 @@ Find the above and additional worked examples as executable Python scripts or Ju
331346
Notebooks on the `PolyConstruct GitHub repository <https://github.com/OMaraLab/polyconstruct>`_.
332347
Examples for PolyTop are available at 'polyconstruct/paper_worked_examples.ipynb'
333348
and for PolyConf at 'polyconstruct/polyconf_examples/'; while instructions to
334-
use the two PolyBuild scripts are included under the :ref:`PolyBuild` documentation.
349+
use the two PolyBuild scripts are included under the :ref:`PolyBuild` documentation.

0 commit comments

Comments
 (0)