Gen3 Analysis API

Overview

The Gen3 Analysis service allows users to run analysis queries on Gen3 data.

Getting Started

Installation

assume you have poetry installed:

poetry install

Running the server

poetry run uvicorn gen3analysis.main:app_instance --reload

Note: the --reload flag is optional and will reload the server on code changes

Details

The server is built with FastAPI and packaged with Poetry.

• Use bin/run.sh to spin up a localhost instance of the API
• Use bin/test.sh to run all the tests
• Use bin/clean.sh to run several formatting and linting commands

Key documentation

The documentation can be browsed in the docs folder, and key documents are linked below.

• Detailed API Documentation
• Quickstart
• Terms & Conditions acceptance — schema, API, and deployed environment setup