This repository includes the documentation of the EOEPCA Resource Catalogue
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
- Description
- Getting Started
- Documentation
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgements
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
The Resource Catalogue provides the following interfaces:
- OGC CSW 2.0.2 (OGC Reference Implementation)
- OGC CSW 3.0.0 (OGC Reference Implementation)
- OGC API - Records - Part1:Core (Early Implementation)
- STAC API 1.0.0 (Listed in STAC API Servers)
- OpenSearch with OGC EO, Geo and Time extensions
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
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
Resource Catalogue deployment is described here in the EOEPCA Deployment Guide.
The component documentation can be found at https://docs.pycsw.org/en/latest/.
EOEPCA related documents:
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)
The user can find a catalogue record and browse the metadata
Alternatively the user can browse through the JSON interface
See the open issues for a list of proposed features (and known issues).
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
The EOEPCA components are distributed under the Apache-2.0 License. See LICENSE for more information.
Angelos Tzotsos - @tzotsos - https://www.osgeo.org/member/angelos-tzotsos/
Project Link: https://github.com/EOEPCA/rm-resource-catalogue
- README.md is based on this template by Othneil Drew.