You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,24 @@
1
1
# 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
[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`.
10
19
11
-
## Alternative methods
12
20
21
+
## Alternative methods
13
22
You can also run *Structure_threader* by simply cloning the repository (or
14
23
downloading one of the releases), and placing the contents of the directory
15
24
"structure_threader", on any location on your `$PATH` env var.
@@ -35,14 +44,12 @@ the next few sections.
35
44
36
45
37
46
## Structure_threader helper scripts
38
-
39
47
The directory "helper_scripts" contains two scripts that will install STRUCTURE and fastStructre, respectively in a *semi* automatic way.
40
48
41
49
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.
0 commit comments