Skip to content

Commit af00a35

Browse files
committed
README.md: add installation instructions
1 parent 4bd971a commit af00a35

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,43 @@ Currently only Python 2.7 is supported, but this may change in the future. Autom
4747
- FMA, as mentioned above.
4848

4949

50+
## Installation
51+
52+
### From PyPI (wlsqm v0.1.1+)
53+
54+
Install as user:
55+
56+
```bash
57+
pip install wlsqm --user
58+
```
59+
60+
Install as admin:
61+
62+
```bash
63+
sudo pip install wlsqm
64+
```
65+
66+
Note that this package is currently compatible with Python 2.7 only, so you may need to use `pip2` instead of `pip` (which may default to Python 3).
67+
68+
### From GitHub
69+
70+
As user:
71+
72+
```bash
73+
git clone https://github.com/Technologicat/python-wlsqm.git
74+
cd python-wlsqm
75+
python setup.py install --user
76+
```
77+
78+
As admin, change the last command to
79+
80+
```bash
81+
sudo python setup.py install
82+
```
83+
84+
Here, too, may need to use `python2` instead of `python`.
85+
86+
5087
## Documentation
5188

5289
For usage examples, see [examples/wlsqm_example.py](examples/wlsqm_example.py) for a tour, and [examples/expertsolver_example.py](examples/expertsolver_example.py) for a minimal example concentrating specifically on `ExpertSolver`.

0 commit comments

Comments
 (0)