ckanext-marinerg

This is the CKAN extension behind the MARINERG-i data catalogue, where test facilities describe the datasets from their marine renewable energy test campaigns. The data stays in Zenodo; the catalogue makes it findable. The extension adds a marine metadata form, controlled vocabularies, DOI prefill from Zenodo, facility pickers, a DCAT-AP export for European harvesters, and Keycloak login.

New to data catalogues? Start with How the catalogue works. It explains the concepts and lists what is built and what is not.

Run it locally

You need Docker or Podman.

cd infra
cp .env.example .env
docker compose -f compose.yml -f compose.local.yml up -d --build

CKAN is on http://localhost:5001. Log in as ckan_admin, password ckan_admin. On Apple Silicon, set CKAN_PLATFORM=linux/arm64 in .env first.

The local stack mounts this repo into the container, so Python changes take effect straight away. Restart the ckan service to pick up template changes, and rebuild with --build after a dependency change. The Zenodo prefill talks to a zenodo-mock on port 8766, so a local run never touches real Zenodo. The facility pickers expect the access portal on port 8000, and show nothing without it.

Find your way around

Start at ckanext/marinerg/plugin.py, which registers everything with CKAN.

The fields, their allowed values and labels, and their constraints come from the marinerg-schema package. To change one, change it there and release it. Then move the exact pin in pyproject.toml and run uv lock. The pin is exact because the CKAN image installs from pyproject.toml, not the lock.

Develop

uv sync --group dev
uv run tox

uv run tox runs the format check, lint, type check and tests, as CI does. The tests include the check that the form still takes its rules from the model.

The tests stub CKAN, so they need no CKAN install. Ruff targets Python 3.10, because that's what CKAN 2.11 runs.

Theme

The theme is one stylesheet, assets/css/marinerg-theme.css, loaded after CKAN's own. Only style what CKAN doesn't, and match CKAN's markup instead of overriding it. Set the logo, favicon and site title in CKAN's config at /ckan-admin/config, not in CSS.

We don't use a compiled SCSS theme. CKAN's theme variables can't be overridden without forking its SCSS, which would break on each CKAN upgrade.

Configuration

infra/Dockerfile bakes these keys into ckan.ini, except the token, which is only set at runtime. The runtime environment variable overrides the baked value.

Unset, the facility pickers and portal links show nothing. The OIDC settings and the plugin list are read at runtime. See infra/README.md.

Release

Open the newest pipeline for main and press the play button on release patch, minor or major. The release pipeline publishes the package to PyPI and the CKAN image to DockerHub. It scans the image first, and a high or critical vulnerability with a fix stops the release. Then it tags the commit. Set the new image tag in the infra repo and deploy.

Licence

AGPL-3.0-or-later. See LICENSE. Copyright © Irish Centre for High-End Computing (ICHEC).