Skip to content

Commit 72bdc9f

Browse files
committed
Updated the docs..
1 parent d98c57a commit 72bdc9f

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,24 @@ A program to parallelize the runs of [Structure](http://pritchardlab.stanford.ed
66
[![DOI](https://zenodo.org/badge/31598374.svg)](https://zenodo.org/badge/latestdoi/31598374)
77

88

9-
## Installation from Pypi
9+
## Installation
1010

1111
```bash
1212
pip3 install structure_threader
1313
```
1414

1515
*Structure_threader* is available on
1616
[Pypi](https://pypi.python.org/pypi/structure_threader/). It can be
17-
installed by simply running the above command. Don't forget the
18-
`--user` option if you can't or don't want to install the program as `root`
19-
user. Using this method, binaries for STRUCTURE, fastStructure and *MavericK*
20-
are also distributed. For more details on this, please [check the
17+
installed by simply running the above command. If you are on a \*nix like
18+
platform, you can use the `--user` option if you can't or don't want to install
19+
the program as `root` user. Binaries for STRUCTURE, fastStructure and
20+
*MavericK* are also distributed for GNU/Linux and Mac OS X. For more details,
21+
please [check the
2122
manual](http://structure-threader.readthedocs.io/en/latest/install/).
2223

2324

24-
## Documentation
25-
The complete manual can be found on [readthedocs.org](http://structure-threader.readthedocs.io/en/latest/).
25+
## Manual
26+
The complete documentation can be found on [readthedocs.org](http://structure-threader.readthedocs.io/en/latest/).
2627

2728

2829
## Citation

docs/install.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
# Installation
2+
In order to install and use *Structure_threader* you need [Python 3](https://www.python.org/). If you don't already have it installed, that is the first thing you should do.
3+
Python for windows comes bundled with `pip`, which is the preferred way to install *Structure_threader*. On other platforms, you can either use the OS's builtin package manager to install it (on Ubuntu and other Debian based Linux distributions you can get it by installing the package `python3-pip`) or by following the instructions on the
4+
[pip website](https://pip.pypa.io/en/stable/installing
25

3-
## Preferred method
46

7+
## Preferred method
58
Since v0.1.8 *Structure_threader* is available in
69
[Pypi](https://pypi.python.org/pypi/structure_threader/), which means that
7-
currently, installing *Structure_threader* is as simple as running
8-
`pip3 install structure_threader`. Don't forget the `--user` option if you can't
9-
or don't want to install the program as `root` user.
10+
currently, installing *Structure_threader* is as simple as following these steps (This guide assumes `python 3` and `pip` are already installed in your system):
11+
12+
1. Open a terminal (or `powershell` on Windows)
13+
2. Type `sudo pip3 install structure_threader` in the terminal is you are on any OS that is not Windows.
14+
2. If you are on Windows, type `pip install structure_threader`.
15+
3. You're done.
16+
17+
If you are not on a Windows OS and can't or don't want to install the package with `root` permission, type instead: `pip3 install structure_threader --user`.
18+
Also, on non Windows platforms, the binaries for *Structure_threader*, STRUCTURE, fastStructure and *MavericK* are placed under `~/.local/bin/` if you install without `root` permissions and under `/usr/local/bin/` if you install as `root`.
1019

11-
## Alternative methods
1220

21+
## Alternative methods
1322
You can also run *Structure_threader* by simply cloning the repository (or
1423
downloading one of the releases), and placing the contents of the directory
1524
"structure_threader", on any location on your `$PATH` env var.
@@ -35,14 +44,12 @@ the next few sections.
3544

3645

3746
## Structure_threader helper scripts
38-
3947
The directory "helper_scripts" contains two scripts that will install STRUCTURE and fastStructre, respectively in a *semi* automatic way.
4048

4149
Both scripts default the programs' install locations to ~/Software/<program_name>. You can change this in the scripts themselves should you wish to change this location.
4250

4351

4452
### install_structure.sh
45-
4653
This script will download and install STRUCTURE.
4754

4855

@@ -80,7 +87,6 @@ sudo apt-get install cython python-numpy python-scipy gsl-bin
8087
```
8188

8289
###Important note:
83-
8490
If you are relying on the GNU Scientific Library that was installed using the
8591
`install_faststructure` script, you will need to make your system aware of
8692
where these libraries are.
@@ -95,7 +101,6 @@ Where `$install_dir` is the directory defined in `install_faststructure.sh`.
95101

96102

97103
### install_maverick.sh
98-
99104
This script will download and install MavericK.
100105

101106

0 commit comments

Comments
 (0)