/beacon-network

Beacon Network APIs

Primary LanguagePythonApache License 2.0Apache-2.0

Archival Notice

beacon-network was developed for ELIXIR Beacon implementation studies 2018 and 2019-2021. Development on the Beacon v1 specification has ceased, and a new Beacon v2 specification has been finalised, and is being adopted by beacon providers.

Users are encouraged to move to the next iteration of Beacon Network v2. Beacon v2 development can be followed at GA4GH Beacon v2 Project.

We thank all parties that have been involved with us in the development of the Beacon v1 products past these years.

Beacon Network

Github Actions

CodeQL S2I Build Style Checks Registry Unit Tests Aggregator Unit Tests Documentation Checks

External CI

Coverage Status Documentation Status

Beacon Network is a service for gathering multiple Beacons together for easy access.

Beacon Network as a service consists of:

  • A Registry for holding data regarding member Beacons
  • An Aggregator that serves as a gateway to query all known Beacons at once
  • A web portal that provides a GUI to use the APIs described above
  • An OIDC client used for authenticating users and authorizing access to protected data

This repository covers Aggregator and Registry APIs.

For information regarding the other relevant service components, see:

Documentation

For instructions on configuring and setting up Registry and Aggregator APIs, refer to the documentation.

License

beacon-network and all it sources are released under Apache 2.0 License.