fix: Add snakecase and test cases for examples (dd28c251) · Commits · Research Enablement / Xylem

examples/atmosphericcorrection-pansharpening-orthorectification/README.md→examples/atmospheric_correction-pansharpening-orthorectification/README.md

+6 −5

Original line number	Diff line number	Diff line
		@@ -6,15 +6,15 @@
		- In the associated `config.json`, there is a single directory listed. Xylem will parse through this main directory and concurrently process all available subdirectories.
		```json
		"input":
		"/path/to/input/directory"
		"/data/test-cases"
		```
		- Multiple directories may also be specified. Note that when listing multiple directories, they are listed within `[ ]`, signaling to Xylem these specific directories should be concurrently processed.
		```json
		"input": [
		"/path/to/input/order1",
		"/path/to/input/order2",
		"/path/to/input/order3",
		"/path/to/input/order4"
		"/data/test-cases/test-case-GE01-medium-low-mid",
		"/data/test-cases/test-case-WV02-medium-mid-high",
		"/data/test-cases/test-case-wv03-large-high-mid",
		"/data/test-cases/test-case-wv03-large-mid-low"
		]
		```
		- Define each module:
		@@ -98,5 +98,6 @@ For more thorough discussions on variables and overall structure, along with a l
		- Module P also updates the middle of the filenames from `P1BS` for panchromatic imagery and `M1BS` for multispectral imagery to `S3XS` which is a Maxar naming standard and a naming convention upheld throughout the use of Legacy PIPE.
		- For multi-module processing, combinations can only be made in these two orders:
		> Module A -> Module P -> Module O

		> Module P -> Module O
		- Atmospheric correction is always the first processing step if it is included, and imagery must be pansharpened before it is orthorectified.
		No newline at end of file

+6 −6

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@
		],
		"keywords": [],
		"input":
		"/path/to/input/directory",
		"/data/test-cases",
		"modules": [
		{
		"name": "Module A (local)",
		@@ -15,7 +15,7 @@
		"programmingLanguage": "python",
		"uri": "file:///path/to/module-a",
		"variables": {
		"OUTPUT_DIRECTORY": "/path/to/output/directory",
		"OUTPUT_DIRECTORY": "/data/output",
		"METHOD": "boa_reflectance",
		"PROFILE": "urban"
		},
		@@ -45,8 +45,8 @@
		"programmingLanguage": "python",
		"uri": "file:///path/to/module-p",
		"variables": {
		"SOURCE_DIRECTORY": "/path/to/output/directory",
		"OUTPUT_DIRECTORY": "/path/to/output/directory",
		"SOURCE_DIRECTORY": "/data/output",
		"OUTPUT_DIRECTORY": "/data/output",
		"METHOD": "nn_diffuse",
		"MODULE_LIST": "MODA, MODP, MODO"
		},
		@@ -76,8 +76,8 @@
		"programmingLanguage": "python",
		"uri": "file:///path/to/module-o",
		"variables": {
		"SOURCE_DIRECTORY": "/path/to/output/directory",
		"OUTPUT_DIRECTORY": "/path/to/output/directory"
		"SOURCE_DIRECTORY": "/data/output",
		"OUTPUT_DIRECTORY": "/data/output"
		},
		"template": {
		"command": "python",

+5 −5

Original line number	Diff line number	Diff line
		@@ -6,15 +6,15 @@
		- In the associated `config.json`, there is a single directory listed. Xylem will parse through this main directory and concurrently process all available subdirectories.
		```json
		"input":
		"/path/to/input/directory"
		"/data/test-cases"
		```
		- Multiple directories may also be specified. Note that when listing multiple directories, they are listed within `[ ]`, signaling to Xylem these specific directories should be concurrently processed.
		```json
		"input": [
		"/path/to/input/order1",
		"/path/to/input/order2",
		"/path/to/input/order3",
		"/path/to/input/order4"
		"/data/test-cases/test-case-GE01-medium-low-mid",
		"/data/test-cases/test-case-WV02-medium-mid-high",
		"/data/test-cases/test-case-wv03-large-high-mid",
		"/data/test-cases/test-case-wv03-large-mid-low"
		]
		```
		- Define the module:

+2 −2

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@
		],
		"keywords": [],
		"input":
		"/path/to/input/directory",
		"/data/test-cases",
		"modules": [
		{
		"name": "Module A (local)",
		@@ -15,7 +15,7 @@
		"programmingLanguage": "python",
		"uri": "file:///path/to/module-a",
		"variables": {
		"OUTPUT_DIRECTORY": "/path/to/output/directory",
		"OUTPUT_DIRECTORY": "/data/output",
		"METHOD": "boa_reflectance",
		"PROFILE": "urban"
		},

+5 −5

Original line number	Diff line number	Diff line
		@@ -6,16 +6,16 @@
		- In the associated `config.json`, multiple directories are listed. Note that when listing multiple directories, they are listed within `[ ]`, signaling to Xylem these specific directories should be concurrently processed.
		```json
		"input": [
		"/path/to/output_MODP/order1",
		"/path/to/output_MODP/order2",
		"/path/to/output_MODP/order3",
		"/path/to/output_MODP/order4"
		"/data/test-cases/test-case-GE01-medium-low-mid",
		"/data/test-cases/test-case-WV02-medium-mid-high",
		"/data/test-cases/test-case-wv03-large-high-mid",
		"/data/test-cases/test-case-wv03-large-mid-low"
		]
		```
		- A single directory may also be specified. Xylem will parse through this main directory and concurrently process all available subdirectories.
		```json
		"input":
		"/path/to/output_MODP"
		"/data/test-cases"
		```
		- Define the module:
		- Within the module variable, specify the `name` and `uri` to the module. The `uri` specifically informs Xylem from where to install the module environment. For example, if a user has Xylem installed and has cloned each of the modules in their `dev` directory within a Docker container, this path may look something like: