From 572fb09d9b81f8895488c3393a013bd3d6539942 Mon Sep 17 00:00:00 2001 From: Carsten Ehbrecht Date: Thu, 12 Dec 2024 20:07:02 +0100 Subject: [PATCH 1/2] update readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f0908c4..bb5c728 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ It can be helpful to preview changes on your computer before opening a pull requ Clone this repository locally, and cd into it: ```console -$ git clone https://github.com/bird-house/bird-house.github.io -$ cd bird-house.github.io +git clone https://github.com/bird-house/bird-house.github.io +cd bird-house.github.io ``` @@ -31,16 +31,16 @@ conda env create conda activate birdhouse2 ``` -Now you can ask mkdocs to build the website: +Now you can ask `mkdocs` to build the website: -``` +```console mkdocs build mkdocs serve ``` Point your browser at http://127.0.0.1:8000/. -Edit the various parts, mkdocs should automatically rebuild and +Edit the various parts, `mkdocs` should automatically rebuild and refresh the pages when changes occur. To stop serving the website, press **`Ctrl`**-`C` in your terminal. @@ -56,5 +56,5 @@ It is written in [Markdown](https://guides.github.com/features/mastering-markdow The site has other pages written in Markdown like `about.md`. -To customise the layout read the documentation of the [minima theme](https://github.com/jekyll/minima). +To customise the layout read the documentation of [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). From c2b6cfbcb3a696b3ea273b8f3537cdd4041cdbfc Mon Sep 17 00:00:00 2001 From: Carsten Ehbrecht Date: Thu, 12 Dec 2024 20:40:03 +0100 Subject: [PATCH 2/2] update text, mention pygeoapi --- docs/documentation.md | 4 ++-- docs/index.md | 19 +++++++++++++------ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/documentation.md b/docs/documentation.md index c260d79..e2e43ad 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -1,6 +1,6 @@ Find out more about how we are doing these things: -* [Latest (main)](https://birdhouse2-docs.readthedocs.io/en/latest/) +* [Latest (main), pygeoapi](https://birdhouse2-docs.readthedocs.io/en/latest/) -* [Legacy documentation](https://birdhouse.readthedocs.io/en/latest/) +* [Legacy documentation, PyWPS](https://birdhouse.readthedocs.io/en/latest/) diff --git a/docs/index.md b/docs/index.md index 8ba9d08..edb6234 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,15 +4,22 @@ # Welcome to Birdhouse Birdhouse tools enable you to build your own customised -[Web Processing Service](http://opengeospatial.org/standards/wps) -application in support of web-based geospatial (climate) data analysis. Birdhouse offers you: +[OGC](https://www.ogc.org/publications/) compute service in support of web-based geospatial (climate) data analysis. -* A [Cookiecutter template](https://cookiecutter-birdhouse.readthedocs.io/en/latest/) to create your own [PyWPS](http://pywps.org/) compute service. -* An [Ansible script](https://ansible-wps-playbook.readthedocs.io/en/latest/index.html) to deploy a full-stack PyWPS service. +An OGC compute service has a set of processes with defined input and output parameters. These processes can be executed by a client. For example, a process could run the calclulation of a climate indice or the subsetting of [CMIP](https://wcrp-cmip.org/) climate model data. + +Birdhouse offers you: + +* A [Cookiecutter template](https://cookiecutter-birdhouse.readthedocs.io/en/latest/) to create your own compute service. +* An [Ansible script](https://ansible-wps-playbook.readthedocs.io/en/latest/index.html) to deploy a full-stack compute service including a Slurm queuing manager. * A web-based application, [Phoenix](https://pyramid-phoenix.readthedocs.io/en/latest/), and ... * ... a Python library, [Birdy](https://birdy.readthedocs.io/en/latest/), suitable for [Jupyter](https://jupyter.org/) notebooks to interact with WPS compute services. * An OWS security proxy, [Twitcher](https://twitcher.readthedocs.io/en/latest/), - to provide access control to OGC/WPS compute services. + to provide access control to OGC compute services. + +The current (v1.x, legacy) tools support the OGC [Web Processing Service](https://www.ogc.org/publications/standard/wps/) (XML) standard using the [PyWPS](http://pywps.org/) Python implementation. + +The new (>v2) tools support [OGC API – Processes](https://www.ogc.org/publications/standard/ogcapi-processes/) (json, rest-api) using the [pygeoapi](https://pygeoapi.io/) Python implementation. -We already have several WPS compute services for climate data analysis, like [Rook](https://github.com/roocs/rook) and [Finch](https://github.com/bird-house/finch). +We already have several compute services for climate data analysis, like [Rook](https://github.com/roocs/rook) and [Finch](https://github.com/bird-house/finch).