Skip to content

Latest commit

 

History

History
111 lines (79 loc) · 3.86 KB

README.md

File metadata and controls

111 lines (79 loc) · 3.86 KB

Light Curve Survey Classification Web App

Build Status

About

A light curve survey classification web app built on cesium, cesium_web, and baselayer.

Running the app locally

  1. A Python 3.6 or later installation is required.

  2. Install the following dependencies: Supervisor, NGINX, PostgreSQL, Node.JS.

  • On macOS:

    1. Using Homebrew: brew install supervisor nginx postgresql node
    2. Start the postgresql server:
    • to start automatically at login: brew services start postgresql
    • to start manually: pg_ctl -D /usr/local/var/postgres start

  • On Linux:

    1. Using apt-get: sudo apt-get install nginx supervisor postgresql libpq-dev npm nodejs-legacy
    2. It may be necessary to configure your database permissions: at the end of your pg_hba.conf (typically in /etc/postgresql/9.6/main), add the following lines:
    local   all             postgres                                peer
local cesium cesium trust
local cesium_test cesium trust
local survey_app survey_app trust
local survey_app_test survey_app trust

    and restart postgresl (sudo service postgresql restart).

  1. Initialize the database with make db_init

If you've run this script before, you may see warnings here about the database already existing. Ignore those.

  1. Run make download_data to download the models, feature sets and other data needed to run the app. This data will be downloaded to survey_classifier_data alongside the top-level survey_app repo.

  2. Run make cesium_web_init to populate the cesium_web database and start the server.

  3. Run make to start the server and navigate to localhost:7000 to start using the app.

Configuration

Copy config.yaml.defaults to config.yaml and customize.

  • Under server, set 'multi_user' to True to enable logins. Also provide the Google credentials, obtained as described in the config file.
  • Under app, modify the secret-key.

Dev Tips

To execute the test suite:

  • Install ChromeDriver from: https://sites.google.com/a/chromium.org/chromedriver/home (The binary has to be placed somewhere on your path.)

  • Install Chrome or Chromium

  • Optional: install xfvb for headless tests (only available on Linux)

  • make test_headless or make test

    To run a single test:

    ./tools/test_frontend.py cesium_app/tests/frontend/test_build_model.py::test_build_model_rfc

    Prepend the above with xvfb-run to run in headless mode.

Debugging:

  • Run make log to watch log output
  • Run make stop to stop any running web services.
  • Run make attach to attach to output of webserver, e.g. for use with pdb.set_trace()
  • Run make check-js-updates to see which Javascript packages are eligible for an upgrade.

Standards

To ensure that JavaScript & JSX code conforms with industry style recommendations, after adding or modifying any .js or .jsx files, run ESLint with node_modules/eslint/bin/eslint.js -c .eslintrc --ext .jsx,.js static/js/. To automatically run ESLint when you make changes to your JavaScript code, add a pre-commit hook by adding the following to your .git/hooks/pre-commit:

#!/bin/bash
# Pre-commit Git hook to run ESLint on JavaScript files.
#
# If you absolutely must commit without testing,
# use: git commit --no-verify (git commit -n)

filenames=($(git diff --cached --name-only HEAD))

for i in "${filenames[@]}"
do
    if [[ $i =~ \.js$ ]] || [[ $i =~ \.jsx$ ]] ;
    then
        echo node_modules/eslint/bin/eslint.js -c .eslintrc $i
        node_modules/eslint/bin/eslint.js -c .eslintrc $i
        if [ $? -ne 0 ];
        then
            exit 1
        fi
    fi
done