Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 4.67 KB

README.md

File metadata and controls

91 lines (69 loc) · 4.67 KB
Raw

GraphSpace

GraphSpace is running at http://graphspace.org

GraphSpace has three dummy users:

  1. Username: [email protected] Password: user1
  2. Username: [email protected] Password: user2
  3. Username: [email protected] Password: user3

Requirements

  1. Python v2.7.10
  2. sqlite3 v3.8.10
  3. virtualenv

Running GraphSpace locally

In order to run GraphSpace, please install sqlite3 and both the Python runtime and development environments. We have tested GraphSpace with Python v2.7.10 and sqlite3 v3.8.10. GraphSpace does not support Python v3. GraphSpace performs best on either Mozilla Firefox or Google Chrome browsers. The following steps describe how to install Python packages required by GraphSpace, download the GraphSpace code, and set up and start the server. The following instructions should apply to computers running a version of the Linux or OS X operating systems.

  1. Download the GraphSpace code by running git clone https://github.com/Murali-group/GraphSpace.git or by downloading the latest release: https://github.com/Murali-group/GraphSpace/releases.
  2. Visit the GraphSpace directory: cd GraphSpace
  3. Create a virtual environment for the project: virtualenv venv
  4. Start using the virtual environment: source venv/bin/activate
  5. Install graphspace: sh install.sh
  6. Finally, start the GraphSpace server: python manage.py runserver --settings=graphspace.settings.local
  7. Visit http://localhost:8080 and enjoy using GraphSpace!

Running GraphSpace on Apache

This section describes the steps required to launch GraphSpace on a server that has apache2 running on it. First, please follow the steps in Running GraphSpace locally. Next, execute the instructions below.

  1. Follow instructions 1-5 in Running GraphSpace locally
  2. Add settings file production.py by copying local settings file. cp graphspace/settings/local.py graphspace/settings/
  3. Update your production.py settings file.
  4. InSet URL_PATH to the URL where your server will be running. Note: Please add the ending '/' character at the end of this value: For example: http://graphspace.org/
  5. Modify the PATH to point to where GraphSpace directory exists. Note: Please add the ending '/' character at the end of this value: For example: /home/ubuntu/GraphSpace/
  6. Visit the apache2 directory: cd /path_to/apache2. An example of the full path to this directory is /etc/apache2.
  7. Navigate to the sites-enabled directory: cd sites-enabled
  8. Create a file called graphspace.conf and access this file using admin privileges: `sudo vim graphspace.conf'
  9. Inside this file, copy and paste following lines, after replacing path_to_GraphSpace with the name of the directory where you downloaded GraphSpace:
WSGIDaemonProcess GraphSpace python-path=/path_to_GraphSpace:/path_to_GraphSpace/venv/lib/python2.7/site-packages/ python-eggs=/path_to_python_eggs
WSGIProcessGroup GraphSpace
WSGIScriptAlias / /path_to_GraphSpace/graphspace/wsgi.py

 <Directory /path_to_GraphSpace/graphspace/>
    <Files wsgi.py>
        Order deny,allow
        Require all granted
    </Files>
 </Directory>
 
 Alias /static/ /path_to_GraphSpace/graphs/static/
 
 <Directory /path_to_GraphSpace/graphs/static/>
     Require all granted
 </Directory>
 
 <Directory /path_to_GraphSpace>
  Options Indexes FollowSymLinks
  AllowOverride None
  Require all granted
 </Directory>
  1. Install module to recognize Django application through apache2: sudo apt-get install libapache2-mod-wsgi
  2. Give permission to access static files through apache2. Navigate outside GraphSpace and type: chmod 777 GraphSpace
  3. Create a directory for python-eggs. mkdir /path_to_python_eggs
  4. Give permission to access static files through apache2. chmod 777 /path_to_python_eggs
  5. Restart the apache server. On a computer running Ubuntu, the command is sudo service apache2 restart

Refer to https://docs.djangoproject.com/en/1.8/howto/deployment/wsgi/modwsgi/ if any problems occur with the setup.

Testing the GraphSpace REST API

  1. Follow the instructions above to run GraphSpace locally or on Apache2.
  2. Navigate to the tests directory in GraphSpace: cd tests
  3. Enter python command to run test cases: python restapi_test.py

This script will test all the REST API commands supported by the GraphSpace server. If something fails, it will display the error.

Contributing

Feel free to fork and send us pull requests. Here are the guidelines for contribution in GraphSpace.