Skip to content

README.md

Latest commit

 

History

History
31 lines (24 loc) · 1.37 KB

README.md

File metadata and controls

31 lines (24 loc) · 1.37 KB

plotting-service

The plotting service provides a h5-grove fastapi implementation
License: GPL-3.0 Code style: black linting: pylint

Local Install

pip install .[all] You may need to escape the square brackets e.g. [all]

Running Directly for development

The following environment variables can be set:

  • CEPH_DIR: Directory containing reduced data (default: /ceph)
  • IMAT_DIR: Directory for IMAT data (default: /imat)
  • API_KEY: API key required for updating settings and cache keys.
  • DEV_MODE: Set to True for development mode (default: False).
  • JWT_SECRET: Secret used for JWT authentication (default: shh).
  • FIA_AUTH_URL: URL for the FIA authentication service.
  • FIA_AUTH_API_KEY: API key for the FIA authentication service.

It is assumed that the directory structure for reduced data is as follows:
<CEPH_DIR>/<instrument>/RBNumber/RB<RBNUMBER>/autoreduced/<NEXUS FILE> E.g /ceph/mari/RBNumber/RB12345/autoreduced/MAR_1231231.nxspe

uvicorn plotting_service.plotting_api:app --reload

The reload option will reload the api on code changes.