Skip to content

Commit f64fcb3

Browse files
committed
Improved the documentation index with some important information.
1 parent 56e8799 commit f64fcb3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
11
# *Structure_threader*
22

33
## Description
4+
45
A program to parallelize and automate the runs of [Structure](http://pritchardlab.stanford.edu/structure.html) and [fastStructure](https://rajanil.github.io/fastStructure/) software.
56

67

78
## Requirements
9+
810
Python 3. The main program only uses modules from the standard library.
911
In order to draw the plots, matplotlib >= 1.4 is required.
1012
To run "fastChooseK.py" (fastStructure wrapper only), numpy is also required.
1113

1214

1315
## Where to get it
16+
1417
* Source code - [Structure_threader on github](https://github.com/StuntsPT/Structure_threader)
18+
* Binary distribution - [Sturcture_threader on Pypi](https://pypi.python.org/pypi/structure_threader/)
19+
* You can install this version easily by issuing the command `pip3 install structure_threader`
1520

1621

1722
## Contents
23+
1824
* [Installation & dependencies](install.md)
1925
* [Binary building](binaries.md)
2026
* [Usage](usage.md)
@@ -27,15 +33,18 @@ To run "fastChooseK.py" (fastStructure wrapper only), numpy is also required.
2733

2834

2935
## Other works
36+
3037
The script "fastChooseK.py" was taken from [the original fastStructure repository](https://github.com/rajanil/fastStructure), ported to python 3, largely modified to work as a module for the main script and relicensed as GPLv3.
3138

3239
The scripts "harvesterCore.py" and "structureHarvester.py" were taken from [the original structureHarverster repository](https://github.com/dentearl/structureHarvester), ported to python 3, and slightly modified to work as a module for the main script. Please see the "Citation" part of the README to know what to cite, should you use this module.
3340

3441

3542
## Bug reporting
43+
3644
Found a bug or would like a feature added? Or maybe drop some feedback?
3745
Just [open a new issue](https://github.com/StuntsPT/Structure_threader/issues/new).
3846

3947

4048
## License
49+
4150
GPLv3

0 commit comments

Comments
 (0)