|
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. |
| 1 | +# Running xcengine |
| 2 | + |
| 3 | +## The `xcetool` command |
| 4 | + |
| 5 | +The command-line interface to xcengine is the command `xcetool`, which |
| 6 | +implements multiple subcommands and options for building and running |
| 7 | +container images and Application Packages. |
| 8 | + |
| 9 | +### `xcetool image build` |
| 10 | + |
| 11 | +TODO |
| 12 | + |
| 13 | +### `xcetool image run` |
22 | 14 |
|
23 | 15 | TODO |
24 | 16 |
|
25 | | -# Publishing your container image |
| 17 | +###`xcetool make-script` |
26 | 18 |
|
27 | 19 | TODO |
28 | 20 |
|
29 | | -# Deploying your application package |
| 21 | +## Publishing your container image |
| 22 | + |
| 23 | +TODO |
30 | 24 |
|
31 | | -TODO |
| 25 | +## Deploying your application package |
| 26 | + |
| 27 | +TODO |
0 commit comments