Skip to content

EOFarm/rm-resource-catalogue

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License Build


Logo

EOEPCA Resource Catalogue

This repository includes the documentation of the EOEPCA Resource Catalogue
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

Description

The EOEPCA Resource Catalogue building block is built upon the upstream pycsw project.

pycsw is an OGC API - Records and OGC CSW server implementation written in Python.

Started in 2010 (more formally announced in 2011), pycsw allows for the publishing and discovery of geospatial metadata via numerous APIs (CSW 2/CSW 3, OGC API - Records, STAC API, OpenSearch, OAI-PMH, SRU), providing a standards-based metadata and catalogue component of spatial data infrastructures.

pycsw is Open Source, released under an MIT license, and runs on all major platforms (Windows, Linux, Mac OS X). It is an official OSGeo Project.

pycsw is Certified OGC Compliant and is an OGC Reference Implementation

Resource Catalogue Architecture

Built With

Interfaces

The Resource Catalogue provides the following interfaces:

Resource Catalogue Landing Page Screen Shot

The Resource Catalogue data model is based on ISO 19115-1/2

Metadata registration can be done by the following ways:

  • Transaction interfaces (OGC CSW-T or OGC API - Features - Part4: Create, Replace, Update, Delete)
  • Data Access Registrar
  • Data Access Harvester
  • Workspace API
  • Registration API
  • pycsw Python API
  • pycsw admin CLI utility

Getting Started

To get a local copy up and running in 4 minutes follow these simple steps.

# Setup a virtual environment:
python3 -m venv pycsw && cd pycsw && . bin/activate
    
# Grab the pycsw source code:
git clone https://github.com/geopython/pycsw.git && cd pycsw
pip3 install -e . && pip3 install -r requirements-standalone.txt
    
# Create and adjust a configuration file:
cp default-sample.cfg default.cfg
vi default.cfg
# adjust paths in
# - server.home
# - repository.database
# set server.url to http://localhost:8000/
    
# Setup the database:
pycsw-admin.py setup_db --config default.cfg
    
# Load records by indicating a directory of XML files, use -r for recursive:
pycsw-admin.py load_records --config default.cfg --path /path/to/xml/
    
# Run the server:
python ./pycsw/wsgi.py
    
# See that it works!
curl http://localhost:8000  # OGC API - Records      
curl http://localhost:8000/csw?service=CSW&version=2.0.2&request=GetCapabilities  # CSW

Deployment

Resource Catalogue deployment is described here in the EOEPCA Deployment Guide.

Documentation

The component documentation can be found at https://docs.pycsw.org/en/latest/.

EOEPCA related documents:

Usage

Resource Catalogue usage documentation is provided through the upstream pycsw project.

A basic example of the Resource Catalogue usage:

Using the landing page, the user can browse collections and metadata records through the HTML interface (provided by OGC API - Records)

Resource Catalogue Items Page

The user can find a catalogue record and browse the metadata

Resource Catalogue Item Page

Alternatively the user can browse through the JSON interface

Resource Catalogue JSON Record

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

The EOEPCA components are distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

Angelos Tzotsos - @tzotsos - https://www.osgeo.org/member/angelos-tzotsos/

Project Link: https://github.com/EOEPCA/rm-resource-catalogue

Acknowledgements

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published