README.rst

User Documentation

pharus is a generic REST API server backend for DataJoint pipelines built on top of flask, datajoint, and pyjwt.

• Documentation
• PyPi Package
• Docker Image
• Release
• Source

Installation

If you have not done so already, please install the following dependencies.

• Docker
• Docker Compose

Prerequisites

Download the docker-compose-deploy.yaml docker environment from the source located here.

Running the API server

To start the API server, use the command:

PHARUS_VERSION=0.7.3 docker-compose -f docker-compose-deploy.yaml up -d

To stop the API server, use the command:

PHARUS_VERSION=0.7.3 docker-compose -f docker-compose-deploy.yaml down

References

• DataJoint
  • https://datajoint.io
• DataJoint LabBook (a companion frontend)
  • https://github.com/datajoint/datajoint-labbook