Skip to content

Commit 8d209fe

Browse files
committed
Docs: add minimal xcetool page
1 parent 01d283e commit 8d209fe

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/xcetool.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Running `xcetool`
2+
3+
xcengine provides a command `xcetool` which converts a Jupyter Python notebook
4+
to a compute engine. A compute engine consists of:
5+
6+
- A docker container image packaging the notebook code, a Python environment,
7+
and an [xcube](https://xcube.readthedocs.io/) server component, letting
8+
the notebook results be served over multiple supported APIs and explored
9+
in the interactive xcube viewer.
10+
- An accompanying CWL file defining an OGC
11+
[Earth Observation Application Package](docs.ogc.org/bp/20-089r1.html) using
12+
the container image. This lets your notebook code run as part of a processing
13+
workflow on any EOAP platform.
14+
15+
In the conversion process, xcengine tries to maximize convenience for the user
16+
by requiring as little extra configuration and input as possible. Input
17+
variables and their types can be defined by tagging a notebook cell
18+
(similarly to [papermill](https://papermill.readthedocs.io/)), and output
19+
datasets are automatically extracted from the notebook’s environment.
20+
Some user configuration is unavoidable, but xcengine automates much of the
21+
boilerplate required to create an EOAP.

0 commit comments

Comments
 (0)