Get Started
OrpheusDB requires the following software to be installed successfully prior to setup:
- Python 2.7.x
- PostgreSQL >= 9.5
OrpheusDB comes with a standard setup.py script for installation. The required python dependency packages include
- click >= 6.6
- psycopy2 >= 2.6.2
- pandas >= 0.19.0
- pyyaml >= 3.12
- pyparsing >=2.1.1
- sqlparse >= 0.2.2
- django >= 1.11.6
- grpcio >= 1.6.3
Users are able to install any of missing dependencies themselves via pip. Alternatively, an easier way to install all the requisite dependencies is via pip install . (If you encounter permission errors, install via sudo -H pip install .)
To start with, users need to install PostgresSQL successfully. (A tutorial of installing PostgresSQL on Mac OSX can be found here.) After installing, and then starting PostgresSQL (e.g., via pg_ctl), users can call createdb to create a new database with a new username and password, all under the current user login. Remember the username and password, the parameters of the new database, and other details of the PostgreSQL setup.
Once the configuration is complete, edit the appropriate entries in the file config.yaml. After configuration, users can use orpheus --help to list all the available commands in OrpheusDB. By default, orpheus is the alias for OrpheusDB user interface.