Skip to content

Commit 612fb8e

Browse files
committed
Docs: add basic versions of several pages
1 parent 8d209fe commit 612fb8e

File tree

5 files changed

+56
-1
lines changed

5 files changed

+56
-1
lines changed

docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,10 @@ links to further resources.
2020
2. [Installing xcengine](installing.md)
2121
3. [Making a Jupyter notebook xcengine-compatible](notebook.md)
2222
4. [Running `xcetool`](xcetool.md)
23-
5. [Further documentation and resources](resources.md)
23+
5. [Testing and running Application Packages](testing.md)
24+
6. [Further documentation and resources](resources.md)
25+
26+
xcengine is developed as part of the [Open Earth Monitor
27+
Cyberinfrastructure](https://earthmonitor.org/) project, which has received
28+
funding from the European Union's Horizon Europe research and innovation
29+
programme under grant agreement No. 101059548.

docs/installing.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Installing xcengine
2+
3+
xcengine is developed on GitHub and distributed as a Conda package on the
4+
conda-forge channel.
5+
6+
## Installing from conda-forge
7+
8+
9+
10+
## Installing directly from the GitHub repository

docs/notebook.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Making a Jupyter notebook xcengine-compatible
2+
3+
xcengine is designed to require as little alteration as possible to a Python
4+
notebook, but some configuration may be necessary, in particular to define
5+
input parameters.
6+
7+
## Configuring input parameters
8+
9+
An Application Package can have, and usually does have, *input parameters*
10+
defined types and default values, which can be set by the caller when running
11+
the package. xcengine automatically generates these parameters from variables
12+
in the notebook. Any variable to be used as a parameter
13+
14+
## Configuring xcengine

docs/resources.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Further documentation and resources
2+
3+
xcengine has been presented at conferences and workshops. The presentation
4+
materials are available online and provide a useful complement to this
5+
documentation.
6+
7+
OEMC Global Workshop 2024, Laxenburg:
8+
[recording](https://www.youtube.com/watch?v=e0P1KVyvoEc&list=PLXUoTpMa_9s3g9lD7_aP0XB12wluSPhRJ&index=28)
9+
10+
ESA Living Planet Symposium 2025, Vienna:
11+
[slides](https://lps25.esa.int/lps25-presentations/presentations/1276/lurcock_update.pdf)
12+
13+
OpenGeoHub EO-Council Summer School 2025, Wageningen:
14+
"Application packages in the xcube ecosystem".
15+
[Course page](https://xcube-dev.github.io/summerschool25/) with links to
16+
slides, documentation, and hands-on exercises.
17+
[Video](https://www.youtube.com/watch?v=b3BdOE3mJZU)
18+
19+
ESA Big Data from Space 2025, Riga:
20+
[Programme entry](https://federicorondoni.github.io/bids25/brella-wrapper.html?date=2025-10-01&showSession=749314)

docs/testing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Testing and running application packages
2+
3+
## Running with cwltool
4+
5+
## Running with ZOO-Project and the DRU extensions

0 commit comments

Comments
 (0)