Metadata-Version: 2.4
Name: marinerg_facility
Version: 3.3.0
Summary: Common elements of the Marinerg Access Portal infrastructure.
Author-email: Irish Centre for High End Computing <james.grogan@ichec.ie>
License: MIT
Project-URL: Repository, https://git.ichec.ie/marinerg-i/facility-service
Project-URL: Homepage, https://git.ichec.ie/marinerg-i/facility-service
Keywords: Web Application,Django
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.14
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ichec_django_core==6.2.0
Provides-Extra: container
Requires-Dist: psycopg2-binary; extra == "container"
Requires-Dist: gunicorn; extra == "container"
Provides-Extra: types
Requires-Dist: types-requests; extra == "types"
Dynamic: license-file

# MARINERG-i Facility Service

A Django app, `marinerg_facility`, that records MARINERG-i's marine renewable
energy test facilities and their equipment. It stores who runs each facility,
where it is, and its persistent identifiers, such as ROR. It serves them
through a REST API.

In production it runs inside the
[Test Access Service](https://git.ichec.ie/marinerg-i/test-access-service).
It also runs on its own for development.

## Quick start

Read `infra/quick_start.sh`, then run it:

```sh
./infra/quick_start.sh
```

It sets up a local database and an admin user, then starts the server at
[localhost:8000/api](http://localhost:8000/api).

To develop, test or populate ROR identifiers, see the
[Developer Guide](docs/DeveloperGuide.md).

## Release

Each pipeline on `main` has `release patch`, `release minor` and
`release major` buttons. Press one to publish that release. Consumers pin an
exact version, so they see a release only when they update the pin.

## Licence

Copyright of the Irish Centre for High End Computing (ICHEC). Released under
the MIT License. See [LICENSE](LICENSE).
