Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CenterForCollectiveLearning/DIVE-backend
Codebase for DIVE backend (server, worker, and ORM)
https://github.com/CenterForCollectiveLearning/DIVE-backend
Last synced: about 1 month ago
JSON representation
Codebase for DIVE backend (server, worker, and ORM)
- Host: GitHub
- URL: https://github.com/CenterForCollectiveLearning/DIVE-backend
- Owner: CenterForCollectiveLearning
- License: gpl-3.0
- Created: 2015-09-02T07:31:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:36:24.000Z (about 2 years ago)
- Last Synced: 2024-08-02T03:11:53.645Z (4 months ago)
- Language: Python
- Homepage:
- Size: 2.5 MB
- Stars: 157
- Watchers: 19
- Forks: 42
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DIVE Backend
=================================================
The Data Integration and Visualization Engine (DIVE) is a platform for semi-automatically generating web-based, interactive visualizations of structured data sets. Data visualization is a useful method for understanding complex phenomena, communicating information, and informing inquiry. However, available tools for data visualization are difficult to learn and use, require a priori knowledge of what visualizations to create. See [dive.media.mit.edu](http://dive.media.mit.edu) for more information.
Development setup involves the following steps:
--------
1. Installing system dependencies
2. Setting up postgres
3. Setting up rabbitMQ
4. Starting and entering virtual environment
5. Installing python dependencies
6. Migrating database
7. Starting celery worker
8. Starting server
Install System Dependencies (Linux / apt)
---------
```bash
$ sudo apt-get update && sudo apt-get install -y postgresql git python2.7 python-pip build-essential python-dev libpq-dev libssl-dev libffi-dev liblapack-dev gfortran libxml2-dev libxslt1-dev rabbitmq-server
```
Install System Dependencies (Mac / brew)
---------
Install [Homebrew](http://brew.sh/) if you don't already have it. Then, run the following code:
```bash
$ brew install postgres
$ brew install rabbitmq
```
OR Install postgres.app
---------
Install postgres.app by following the instructions here: (http://postgresapp.com/).
Download and open the app to start postgres.
Setup postgres
---------
Make sure that you have a postgres server instance running:
```bash
postgres -D /usr/local/pgsql/data >logfile 2>&1 &
sudo -u postgres -i
```
Create the dive database by running:
```bash
$ createuser admin -P
$ createdb dive -O admin
```
Start RabbitMQ AMQP Server
---------
1. Add rabbitmq-server executable to path (add `PATH=$PATH:/usr/local/sbin` to ~/.bash_profile or ~/.profile)
2. Run the server as a background process
`sudo rabbitmq-server -detached`
3. Create a RabbitMQ user and virtual host:
```bash
$ sudo rabbitmqctl add_user admin password
$ sudo rabbitmqctl add_vhost dive
$ sudo rabbitmqctl set_permissions -p dive admin ".*" ".*" ".*"
```
Install and Enter Virtual Python Environment
---------
1. Installation: See [this fine tutorial](http://simononsoftware.com/virtualenv-tutorial/).
2. Starting virtual env: `source venv/bin/activate`.
Install Python Dependencies
---------
Within a virtual environment, install dependencies in `requirements.txt`. But due to a dependency issue in numexpr, we need to install numpy first.
```bash
$ pip install -U numpy && pip install -r requirements.txt
```
Start Celery Worker
---------
1. Start celery worker: `./run_worker.sh`
2. Start celery monitor (flower): `celery -A base.core flower`
Database Migrations
--------
Follow [the docs](https://flask-migrate.readthedocs.org/en/latest/). The first time, run the migration script.
```bash
python migrate.py db init
```
Then, review and edit the migration script. Finally, each time models are changed, run the following:
```bash
$ python migrate.py db migrate
$ python migrate.py db upgrade
```
Run API
---------
1. To run development Flask server, run `python run_server.py`.
2. To run production Gunicorn server, run `./run_server.sh`.
Deployment
--------
1. Set environment variable before running any command:
```bash
$ source production_env
```
Building Docker Images
--------
```
conda env export > environment.yml
conda env create -f environment.yml
conda list -e > conda-requirements.txt
conda create --name dive --file conda-requirements.txt
```