Skip to content

Commit

Permalink
Release 0.2.0 (#9)
Browse files Browse the repository at this point in the history
* updated docs

* fix bump
  • Loading branch information
cehbrecht authored Feb 25, 2022
1 parent b7967ab commit cf07c13
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 7 deletions.
7 changes: 6 additions & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
Changes
*******

0.1.0 (2022-02-18)
0.2.0 (2022-02-25)
==================

* Demo release.

0.1.0 (2022-02-24)
==================

* First release.
64 changes: 64 additions & 0 deletions QuickGuide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Quick Guide to get your Duck


## Install duck with conda

We need `mamba` to install the requirements.
Use your existing `mamba` or install it from here:
https://github.com/conda-forge/miniforge

Get the source:
´´´
git clone https://github.com/FREVA-CLINT/duck.git
cd duck
´´´

Create the conda environment for duck:
´´´
mamba env create
´´´

Activate the duck environment:
´´´
conda activate duck
´´´

Install duck in this environment:
´´´
pip install -e .
´´´

Start your duck as a web service:
´´´
duck start -d
´´´

See it is responding by sending a WPS `GetCapabilities` request:
http://localhost:5000?service=WPS&request=GetCapabilities

You can stop the service with:
´´´
duck stop
´´´

## Start the service with access from outside

You need to start your service with the hostname and IP address to be accessible from outside.

Example:
´´´
duck start --hostname smartduck.lake.earth -b 194.100.0.10
´´´

Check if it is running:
´´´
duck status
´´´

Check access:
http://smartduck.lake.earth:5000?service=WPS&request=GetCapabilities

Stop it:
´´´
duck stop
´´´
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ Duck (the bird)

A Demo Web Service for `Clint AI`_.


Get Started
-----------

Check the Quick Guide to install and run the duck:

https://github.com/FREVA-CLINT/duck/blob/main/QuickGuide.md

Documentation
-------------

Expand Down
8 changes: 2 additions & 6 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,8 @@ tag = True
description-file = README.rst

[bumpversion:file:duck/__version__.py]
search = __version__ = '{current_version}'
replace = __version__ = '{new_version}'

[bumpversion:file:docs/source/conf.py]
parse = version|release = {current_version}
replace = {new_version}
search = __version__ = "{current_version}"
replace = __version__ = "{new_version}"

[bumpversion:file:Dockerfile]
search = Version="{current_version}"
Expand Down

0 comments on commit cf07c13

Please sign in to comment.