Data Access Service

Run the app with Docker

Simply run ./startServer.sh to run the app, this will create a docker image and run the image for you.

Host will be http://localhost:8000.

Run the app for development

Requirements

• Conda (recommended for creating a virtual environment)

1. Install Conda (if not already installed):

   Follow the instructions at Conda Installation.

2. Create Conda virtual environment:

   $ conda env create -f environment.yml

Dependency management

Poetry is used for dependency management, the pyproject.toml file is what is the most important, it will orchestrate the project and its dependencies.

You can update the file pyproject.toml for adding/removing dependencies by using

$ poetry add <pypi-dependency-name> # e.g poetry add numpy
$ poetry remove <pypi-dependency-name> # e.g. poetry remove numpy

You might want to update the poetry.lock file after manually modifying pyproject.toml with poetry lock command. To update all dependencies, use poetry update command.

There is a library aodn_cloud_optimised, which referencing direct AODN's GitHub repository as source instead of PyPi. It is written by PO to access cloud optimized data. Please do not access S3 directly and should via this library.

Right now the version is always main branch which is not idea, we should be able to use tag version

aodn_cloud_optimised = { git = "https://github.com/aodn/aodn_cloud_optimised.git", branch = "main" }

Installation and Usage

1. Activate Conda virtual environment:

   $ conda activate data-access-service

2. Install dependencies using Poetry:

   # after cloning the repo with git clone command
   $ cd data-access-service
   $ poetry install

3. Run the app:

   Host will be http://localhost:5000.

   $ data-access-service

   OR

   $ poetry run python data_access_service/run.py

Code formatting

The command below is for manual checks; checks are also executed when you run git commit.

The configurations for pre-commit hooks are defined in .pre-commit-config.yaml.

pre-commit run --all-files

Environment variables

In the root directory of the project, create a .env file.

Profiles

You can use one of the following profiles, set an environment variable call PROFILE in .env

1. dev (default)
2. edge
3. staging
4. prod

E.g

PROFILE=edge

Endpoints

Description	Endpoints	Param	Environment
Formatted metadata	/api/v1/das/metadata/{uuid}	none	ALL
Raw metadata	/api/v1/das/metadata/{uuid}/raw	none	ALL
Subsetting	/api/v1/das/data/{uuid}	start_date=2023-12-25T14:30:00 end_date=2024-02-25T14:30:00 start_depth=-0.06 f=netcdf or json	ALL