Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update text #34

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Update text #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
572fb09
update readme
cehbrecht Dec 12, 2024
c2b6cfb
update text, mention pygeoapi
cehbrecht Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```


Expand All @@ -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.
Expand All @@ -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/).

4 changes: 2 additions & 2 deletions docs/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/)

19 changes: 13 additions & 6 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Loading