forked from cehbrecht/duck
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* updated docs * fix bump
- Loading branch information
Showing
4 changed files
with
80 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
´´´ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters