Skip to content

Commit f741ed6

Browse files
committed
Updated the docs regarding install instructions.
1 parent 72ffe7d commit f741ed6

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/install.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,19 @@ Although you can run *Structure_threader* by simply cloning the repository (or
33
downloading one of the releases), and placing the contents of the directory
44
"structure_threader", $PATH, there is now a better, simpler way.
55
Since version 0.1.6 `setup.py` is implemented, and therefore all that is
6-
required is running `python3 setup.py install` from the root of the software.
6+
required is running `python3 setup.py install` (or even better,
7+
`pip install .`) from the distribution's root directory (where `setup.py` is
8+
located).
79
Please note that while dependencies like numpy and matplotlib are handled by
8-
this method, STRUCTURE and fastStructure are not, and you still have to either
9-
install them manually, or rely on the ["helper_scripts"](https://github.com/StuntsPT/Structure_threader/tree/master/helper_scripts)
10-
where you will find some scripts to help you install both *Structure* **and** *fastStructure*.
10+
this method, and if using the `pip` method for installing, binary distributions
11+
of STRUCTURE and fastStructure are also installed.
12+
Regardless, if you wish to compile your own binaries, you may wish to rely on
13+
our
14+
["helper_scripts"](https://github.com/StuntsPT/Structure_threader/tree/master/helper_scripts)
15+
which contain commands to compile and install *Structure* **and**
16+
*fastStructure* (along with any required dependencies).
17+
18+
**TODO**: Add *Structure_threader* to Pypi.
1119

1220

1321
## Structure_threader helper scripts

0 commit comments

Comments
 (0)