Marinerg-i Data Access Service

This software is part of the Marinerg-i preparatory phase project.

This service supports the management of project datasets.

Quick Start

This is a Python Django application and can be managed through the standard Django APIs.

If you want a quick demo of it running locally you can inspect this script on Linux or Mac and run it if happy with it:

./infra/quick_start.sh

which will:

• Set up a Python virtual environment and install dependencies
• Populate the shell environment with demo Django settings, such as Admin credentials
• Set up a local database and create an admin user
• Launch the development server

You can then go to localhost:8000/api in a browser to interact with the backend API.

For the CKAN-backed catalogue work, the local compose stack lives in infra/ckan.

For the current end-to-end catalogue demo, this repo also includes:

• infra/zenodo_mock/mock_zenodo.py — local Zenodo-compatible API and file server.
• infra/ckan/seeds/mock-zenodo-wave-tank.yaml — CKAN seed record pointing at the mock Zenodo files.
• notebooks/demo/wave_tank_ckan_zenodo_xarray_demo.ipynb — Jupyter/xarray demo notebook.
• notebooks/demo/ckan_xarray_demo.py — small Pydantic 2 typed helper client for CKAN resources and NetCDF downloads.

See notebooks/demo/README.md for the run order.

For more detailed deployment information more suitable for production you can see the Developer Guide.

Licensing

This software is copyright of the Irish Centre for High End Computing (ICHEC). It may be used under the terms of the GNU AGPL version 3 or later, with license details in the included LICENSE file. Exemptions are available for Marinerg project partners and possibly others on request.