Skip to content

Repository to store the OpenSource version of the code made by E84 for OceanBestPractices.org

License

Notifications You must be signed in to change notification settings

iodepo/OceanBestPractices

Repository files navigation

OceanBestPractices

Repository to store the OpenSource version of the code made for search.oceanbestpractices.org by Element84.

If you wish to reuse this code:

  • Please note the relevant conditions in our LICENSE.
  • Please consider forking this repository, allowing all to trace, contribute to, and benefit from new innovations in an open manner.

Documentation on each module can be found in the following READMEs:

Narrative documents on the development of the system can be found in the ./developmentReports directory.

Infrastructure

This project includes all APIs, functions, queries, mappings, and resources necessary to deploy or query the OBP ingest and API infrastructure.

The ingest component is a system which fetches existing documents from the Ocean Best Practices respository, extracts text if necessary, and indexes the document metadata into OpenSearch. The ingest component is also responsible for managing supported ontologies an vocabularies in a managed Neptune instance.

The search API provides endpoints for clients to search and discover indexed documents.

The website provides the user interface for interacting with the search repository.