Skip to content

Commit 8bdf781

Browse files
Merge pull request #86 from OMaraLab/adjustments
Final adjustments resulting from manuscript revision
2 parents d885930 + 2803e4d commit 8bdf781

27 files changed

+10187
-18
lines changed

.DS_Store

0 Bytes
Binary file not shown.

.github/CODEOWNERS

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
* @lunamorrow @khiron @recombinatrix @RangikaM
44

55
/polyconf/ @lunamorrow @recombinatrix
6-
/polytop/ @lunamorrow @khiron
7-
/polybuild/ @lunamorrow @RangikaM
6+
/polytop/ @lunamorrow @khiron @recombinatrix
7+
/polybuild/ @lunamorrow @RangikaM @recombinatrix
88

99
# information on how to adjust the code owners can be found here:
10-
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
10+
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
*PolyConstruct* contains three python tools for generating polymer coordinate and topolgy files for molecular dynamics simulations.
44

5-
*PolyConf* is a tool for generating ensembles of polymer conformations by combining monomer coordinate files.
5+
* *PolyConf* is a tool for generating ensembles of polymer conformations by combining monomer coordinate files.
66

7-
*PolyBuild* is a tool for generating polymer topology files for simulaton from polymer coordinate files, leveraging the functionality of the gromacs tool pdb2gmx.
7+
* *PolyBuild* is a tool for generating polymer topology files for simulaton from polymer coordinate files, leveraging the functionality of the gromacs tool pdb2gmx.
88

9-
*PolyTop* is a tool for generating polymer topology files from monomer topology files.
9+
* *PolyTop* is a tool for generating polymer topology files from monomer topology files.
1010

1111
*PolyConstruct* was published in the paper *PolyConstruct: adapting biomolecular simulation pipelines for polymers with PolyBuild, PolyConf and PolyTop*.
1212

1313
## Getting started
1414

15-
Detailed documentation is available at the [PolyConstruct ReadTheDocs](https://polyconstruct.readthedocs.io/en/latest/index.html). This includes installation instructions, tutorials and worked examples, and api documentation for all polyconstruct methods.
15+
Detailed documentation is available at the [PolyConstruct ReadTheDocs](https://polyconstruct.readthedocs.io/en/latest/index.html). This includes installation instructions, tutorials and worked examples, and api documentation for all *PolyConstruct* methods.
1616

17-
There are also detailed tutorials for PolyConf in the folder [polyconf_examples](https://github.com/OMaraLab/polyconstruct/tree/main/polyconf_examples), and detailed tutorials for PolyTop in the folder [polytop_examples](https://github.com/OMaraLab/polyconstruct/tree/main/polytop_examples)
17+
There is a series of detailed tutorials for *PolyConf* in the folder [polyconf_examples](https://github.com/OMaraLab/polyconstruct/tree/main/polyconf_examples), and for *PolyTop* in the folder [polytop_examples](https://github.com/OMaraLab/polyconstruct/tree/main/polytop_examples). A set of example input and output files for *PolyBuild* are presented in the folder [polybuild_examples/RTP_entries](https://github.com/OMaraLab/polyconstruct/tree/main/polybuild_examples/RTP_entries)
1818

1919
## Quick and dirty installation
2020

docs/CODEOWNERS

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
* @lunamorrow @khiron @recombinatrix @RangikaM
44

55
/polyconf/ @lunamorrow @recombinatrix
6-
/polytop/ @lunamorrow @khiron
7-
/polybuild/ @lunamorrow @RangikaM
6+
/polytop/ @lunamorrow @khiron @recombinatrix
7+
/polybuild/ @lunamorrow @RangikaM @recombinatrix
88

99
# information on how to adjust the code owners can be found here:
10-
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
10+
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

docs/source/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424

2525
# -- Project information -----------------------------------------------------
2626

27-
project = "polyconstruct"
27+
project = "PolyConstruct"
2828
copyright = (
29-
"2024, Luna Morrow. "
29+
"2024, Rangika Munaweera, Ada Quinn, Luna Morrow, Megan O'Mara. "
3030
"A Python library for constructing polymer topologies and coordinates"
3131
)
32-
author = "Luna Morrow"
32+
author = "Rangika Munaweera, Ada Quinn, Luna Morrow, Megan O'Mara"
3333
add_module_names = False
3434

3535
# The short X.Y version
@@ -195,7 +195,7 @@
195195
# dir menu entry, description, category)
196196
texinfo_documents = [
197197
(master_doc, "polyconstruct", "PolyConstruct Documentation",
198-
author, "polyconstruct", "A group of packages to construct polymer topologies and coordinates for molecular dynamics simulation with GROMACS",
198+
author, "polyconstruct", "A python library to generate polymer topology and coordinate files for molecular dynamics simulation with GROMACS",
199199
"Miscellaneous"),
200200
]
201201

polybuild/.DS_Store

6 KB
Binary file not shown.

polybuild_examples/.DS_Store

6 KB
Binary file not shown.

0 commit comments

Comments
 (0)