Skip to content

Commit a4fb8d7

Browse files
committed
DOC: Update installation documentation
1 parent 25a6722 commit a4fb8d7

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

INSTALL.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Dependencies
22
------------
33

4-
Qiita is a python package, with support for python 2.7 and 3.2, that depends on the following python libraries (all of them can be installed using pip):
4+
Qiita is a python package, with support for python 2.7, that depends on the following python libraries (all of them can be installed using pip):
55

66
<!--
77
* [pgbouncer](http://pgfoundry.org/projects/pgbouncer)
8-
* [IPython](https://github.com/ipython/ipython)
98
-->
109

10+
* [IPython](https://github.com/ipython/ipython)
1111
* [tornado 3.1.1](http://www.tornadoweb.org/en/stable/)
1212
* [toredis](https://pypi.python.org/pypi/toredis)
1313
* [Psycopg2](http://initd.org/psycopg/download/)
@@ -22,28 +22,50 @@ Qiita is a python package, with support for python 2.7 and 3.2, that depends on
2222
* [networkx](http://networkx.lanl.gov/index.html)
2323
* [WTForms 2.0.1](https://wtforms.readthedocs.org/en/latest/)
2424
* [Mock](http://www.voidspace.org.uk/python/mock/) For running test code only
25+
* [redis 2.8.0](https://pypi.python.org/pypi/redis/)
2526

2627
And on the following packages:
2728

2829
* [PostgresSQL 9.3](http://www.postgresql.org/download/)
29-
* [redis 2.8.0](https://pypi.python.org/pypi/redis/)
30-
31-
<!--
3230
* [redis-server](http://redis.io)
33-
-->
3431

3532
Install
3633
-------
3734

3835
Once you have [PostgresSQL](http://www.postgresql.org/download/) and [redis](https://pypi.python.org/pypi/redis/) installed (follow the instruction on their web site), simply run these commands to install qiita and configure the demo environment, replacing $QIITA_DIR for the path where qiita is installed
39-
(note that if you are not using Ubuntu you might need to follow the instructions in the next section):
36+
(note that if you are not using Ubuntu you might need to follow the instructions in the next section).
4037

4138
```bash
42-
echo "export QIITA_CONFIG_FP=$QIITA_DIR/qiita_core/support_files/config_demo.txt" >> ~/.bashrc
39+
pip install numpy
40+
pip install cogent burrito qcli emperor pyzmq
41+
pip install https://github.com/biocore/qiime/archive/master.zip --no-deps
42+
pip install qiita
43+
```
44+
45+
After these commands are executed, you will need (1) download a [sample Qiita configuration file](https://raw.githubusercontent.com/biocore/qiita/a0628e54aef85b1a064d40d57ca981aaf082a120/qiita_core/support_files/config_test.txt), (2) set the `QIITA_CONFIG_FP` environment variable and (3) proceed to initialize your environment:
46+
47+
```bash
48+
# (1) use curl -O if using OS X
49+
wget https://github.com/biocore/qiita/blob/a0628e54aef85b1a064d40d57ca981aaf082a120/qiita_core/support_files/config_test.txt
50+
# (2) set the enviroment variable in your .bashrc
51+
echo "export QIITA_CONFIG_FP=config_test.txt" >> ~/.bashrc
4352
source ~/.bashrc
44-
pip install https://github.com/biocore/qiita/archive/master.zip
45-
qiita_env make_env --env demo
53+
# (3) start a test environment
54+
qiita_env make --no-load-ontologies --add-demo-user
4655
```
56+
57+
Finally you need to start the server:
58+
59+
```bash
60+
# IPython takes a while to get initialized so wait 30 seconds
61+
qiita_env start_cluster demo test reserved && sleep 30
62+
qiita webserver start
63+
64+
```
65+
66+
If all the above commands executed correctly, you should be able to go to http://localhost:8888 in your browser, to login use `demo@microbio.me` and `password` as the credentials.
67+
68+
4769
## If using other operating systems that are not Ubuntu
4870

4971
You will need to add the postgres user to the database. In order to do this, run:

0 commit comments

Comments
 (0)