Skip to content

Commit

Permalink
Added documentation for importing over a file server
Browse files Browse the repository at this point in the history
  • Loading branch information
Madison Brooks committed Sep 18, 2015
1 parent 5e09d7a commit a97b0f3
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Expand Up @@ -22,9 +22,25 @@ Then navigate to the `topicalguide` directory and optionally switch over to the

### 2. Install Dependencies

Superuser permissions are necessary to install the Topical Guide as shown in the current instructions.

In order to circumvent the need for superuser permissions, you can create a virtual environment using `virtualenv`, `virtualenvwrapper`, `pyenv`, or another tool.

To use `virtualenv`, type the following inside the project's root directory:

virtualenv ENV
source ENV/bin/activate

You must activate your virtual environment by typing the second line above any time that `(ENV)` does not appear in front of your command line.

Documentation for all of the above mentioned tools can be found here:
[virtualenv](https://virtualenv.pypa.io/en/latest/)
[virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/)
[pyenv](https://github.com/yyuu/pyenv#installation)

Dependencies are listed in the `requirements.txt` file and can be easily installed with:

sudo pip install -r requirements.txt
pip install -r requirements.txt

If you want to use the word stemmer then run the following:

Expand All @@ -40,21 +56,24 @@ First, copy the template:

Second, go to [this website](http://www.miniwebtool.com/django-secret-key-generator/) to generate your `SECRET_KEY`.

Open `topicalguide/settings.py` in your favorite text editor.
Insert your generated `SECRET_KEY` where it says
Third, open `topicalguide/settings.py` in your favorite text editor.
Within this file:

(1) Insert your generated `SECRET_KEY` where it says

SECRET_KEY=''

Third, set your database settings. You could use sqlite, which is configured for you.
(2) Set your database settings. You could use sqlite, which is configured for you.
If you want to use Postgres there are instructions below for setting it up on Fedora.

Fourth, set `DEBUG = True` to use the developement server.
If DEBUG is set to False then ALLOWED_HOSTS must be set. See Django's documentation for further details.
(3) Set `DEBUG = True` to use the developement server. If DEBUG is set to False then ALLOWED_HOSTS must be set. See Django's documentation for further details.

Optionally, configure other various django options.
(4) Optionally, configure other various django options.

### 4. Import a Dataset

Warning: If you import the dataset over a file server, it will run extremely slowly.

You can run (from the project's root directory):

./default_datasets/import_state_of_the_union.sh
Expand Down

0 comments on commit a97b0f3

Please sign in to comment.