From 1323aedc050bf767c3513be9038e438ac5883e45 Mon Sep 17 00:00:00 2001 From: chavlin Date: Mon, 12 Feb 2024 13:10:19 -0600 Subject: [PATCH] update schema for release --- docs/_static/yt-napari_0.4.0.json | 434 ++++++++++++++++++++ docs/_static/yt-napari_latest.json | 436 +++++++++++---------- docs/schema.rst | 2 + repo_utilities/update_schema_docs.py | 2 +- repo_utilities/validate.py | 5 +- src/yt_napari/schemas/yt-napari_0.4.0.json | 434 ++++++++++++++++++++ 6 files changed, 1099 insertions(+), 214 deletions(-) create mode 100644 docs/_static/yt-napari_0.4.0.json create mode 100644 src/yt_napari/schemas/yt-napari_0.4.0.json diff --git a/docs/_static/yt-napari_0.4.0.json b/docs/_static/yt-napari_0.4.0.json new file mode 100644 index 0000000..0ca45c4 --- /dev/null +++ b/docs/_static/yt-napari_0.4.0.json @@ -0,0 +1,434 @@ +{ + "$defs": { + "DataContainer": { + "properties": { + "filename": { + "default": null, + "description": "the filename for the dataset", + "title": "Filename", + "type": "string" + }, + "selections": { + "allOf": [ + { + "$ref": "#/$defs/SelectionObject" + } + ], + "default": null, + "description": "selections to load in this dataset" + }, + "store_in_cache": { + "default": true, + "description": "if enabled, will store references to yt datasets.", + "title": "Store In Cache", + "type": "boolean" + } + }, + "title": "DataContainer", + "type": "object" + }, + "Left_Edge": { + "properties": { + "value": { + "default": [ + 0.0, + 0.0, + 0.0 + ], + "description": "3-element unitful tuple.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ], + "title": "Value", + "type": "array" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Left_Edge", + "type": "object" + }, + "Length_Tuple": { + "properties": { + "value": { + "default": null, + "description": "3-element unitful tuple.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ], + "title": "Value", + "type": "array" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Length_Tuple", + "type": "object" + }, + "Length_Value": { + "properties": { + "value": { + "default": null, + "description": "Single unitful value.", + "title": "Value", + "type": "number" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Length_Value", + "type": "object" + }, + "Region": { + "properties": { + "fields": { + "default": null, + "description": "list of fields to load for this selection", + "items": { + "$ref": "#/$defs/ytField" + }, + "title": "Fields", + "type": "array" + }, + "left_edge": { + "allOf": [ + { + "$ref": "#/$defs/Left_Edge" + } + ], + "default": null, + "description": "the left edge (min x, min y, min z)" + }, + "right_edge": { + "allOf": [ + { + "$ref": "#/$defs/Right_Edge" + } + ], + "default": null, + "description": "the right edge (max x, max y, max z)" + }, + "resolution": { + "default": [ + 400, + 400, + 400 + ], + "description": "the resolution at which to sample between the edges.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "integer" + }, + { + "type": "integer" + }, + { + "type": "integer" + } + ], + "title": "Resolution", + "type": "array" + }, + "rescale": { + "default": false, + "description": "rescale the final image between 0,1", + "title": "Rescale", + "type": "boolean" + } + }, + "title": "Region", + "type": "object" + }, + "Right_Edge": { + "properties": { + "value": { + "default": [ + 1.0, + 1.0, + 1.0 + ], + "description": "3-element unitful tuple.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ], + "title": "Value", + "type": "array" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Right_Edge", + "type": "object" + }, + "SelectionObject": { + "properties": { + "regions": { + "default": null, + "description": "a list of regions to load", + "items": { + "$ref": "#/$defs/Region" + }, + "title": "Regions", + "type": "array" + }, + "slices": { + "default": null, + "description": "a list of slices to load", + "items": { + "$ref": "#/$defs/Slice" + }, + "title": "Slices", + "type": "array" + } + }, + "title": "SelectionObject", + "type": "object" + }, + "Slice": { + "properties": { + "fields": { + "default": null, + "description": "list of fields to load for this selection", + "items": { + "$ref": "#/$defs/ytField" + }, + "title": "Fields", + "type": "array" + }, + "normal": { + "default": null, + "description": "the normal axis of the slice", + "title": "Normal", + "type": "string" + }, + "center": { + "allOf": [ + { + "$ref": "#/$defs/Length_Tuple" + } + ], + "default": null, + "description": "The center point of the slice, default domain center" + }, + "slice_width": { + "allOf": [ + { + "$ref": "#/$defs/Length_Value" + } + ], + "default": null, + "description": "The slice width, defaults to full domain" + }, + "slice_height": { + "allOf": [ + { + "$ref": "#/$defs/Length_Value" + } + ], + "default": null, + "description": "The slice width, defaults to full domain" + }, + "resolution": { + "default": [ + 400, + 400 + ], + "description": "the resolution at which to sample the slice", + "maxItems": 2, + "minItems": 2, + "prefixItems": [ + { + "type": "integer" + }, + { + "type": "integer" + } + ], + "title": "Resolution", + "type": "array" + }, + "periodic": { + "default": false, + "description": "should the slice be periodic? default False.", + "title": "Periodic", + "type": "boolean" + }, + "rescale": { + "default": false, + "description": "rescale the final image between 0,1", + "title": "Rescale", + "type": "boolean" + } + }, + "title": "Slice", + "type": "object" + }, + "TimeSeriesFileSelection": { + "properties": { + "directory": { + "default": null, + "description": "The directory of the timseries", + "title": "Directory", + "type": "string" + }, + "file_pattern": { + "default": null, + "description": "The file pattern to match", + "title": "File Pattern", + "type": "string" + }, + "file_list": { + "default": null, + "description": "List of files to load.", + "items": { + "type": "string" + }, + "title": "File List", + "type": "array" + }, + "file_range": { + "default": null, + "description": "Given files matched by file_pattern, this option will select a range. Argument orderis taken as start:stop:step.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "integer" + }, + { + "type": "integer" + }, + { + "type": "integer" + } + ], + "title": "File Range", + "type": "array" + } + }, + "title": "TimeSeriesFileSelection", + "type": "object" + }, + "Timeseries": { + "properties": { + "file_selection": { + "$ref": "#/$defs/TimeSeriesFileSelection" + }, + "selections": { + "allOf": [ + { + "$ref": "#/$defs/SelectionObject" + } + ], + "default": null, + "description": "selections to load in this dataset" + }, + "load_as_stack": { + "default": false, + "description": "If True, will stack images along a new dimension.", + "title": "Load As Stack", + "type": "boolean" + } + }, + "required": [ + "file_selection" + ], + "title": "Timeseries", + "type": "object" + }, + "ytField": { + "properties": { + "field_type": { + "default": null, + "description": "a field type in the yt dataset", + "title": "Field Type", + "type": "string" + }, + "field_name": { + "default": null, + "description": "a field in the yt dataset", + "title": "Field Name", + "type": "string" + }, + "take_log": { + "default": true, + "description": "if true, will apply log10 to the selected data", + "title": "Take Log", + "type": "boolean" + } + }, + "title": "ytField", + "type": "object" + } + }, + "properties": { + "datasets": { + "default": null, + "description": "list of dataset containers to load", + "items": { + "$ref": "#/$defs/DataContainer" + }, + "title": "Datasets", + "type": "array" + }, + "timeseries": { + "default": null, + "description": "List of timeseries to load", + "items": { + "$ref": "#/$defs/Timeseries" + }, + "title": "Timeseries", + "type": "array" + } + }, + "title": "InputModel", + "type": "object" +} diff --git a/docs/_static/yt-napari_latest.json b/docs/_static/yt-napari_latest.json index 04794a5..0ca45c4 100644 --- a/docs/_static/yt-napari_latest.json +++ b/docs/_static/yt-napari_latest.json @@ -1,63 +1,44 @@ { - "title": "InputModel", - "type": "object", - "properties": { - "datasets": { - "title": "Datasets", - "description": "list of dataset containers to load", - "type": "array", - "items": { - "$ref": "#/definitions/DataContainer" - } - }, - "timeseries": { - "title": "Timeseries", - "description": "List of timeseries to load", - "type": "array", - "items": { - "$ref": "#/definitions/Timeseries" - } - } - }, - "definitions": { - "ytField": { - "title": "ytField", - "type": "object", + "$defs": { + "DataContainer": { "properties": { - "field_type": { - "title": "Field Type", - "description": "a field type in the yt dataset", + "filename": { + "default": null, + "description": "the filename for the dataset", + "title": "Filename", "type": "string" }, - "field_name": { - "title": "Field Name", - "description": "a field in the yt dataset", - "type": "string" + "selections": { + "allOf": [ + { + "$ref": "#/$defs/SelectionObject" + } + ], + "default": null, + "description": "selections to load in this dataset" }, - "take_log": { - "title": "Take Log", - "description": "if true, will apply log10 to the selected data", + "store_in_cache": { "default": true, + "description": "if enabled, will store references to yt datasets.", + "title": "Store In Cache", "type": "boolean" } - } + }, + "title": "DataContainer", + "type": "object" }, "Left_Edge": { - "title": "Left_Edge", - "type": "object", "properties": { "value": { - "title": "Value", - "description": "3-element unitful tuple.", "default": [ 0.0, 0.0, 0.0 ], - "type": "array", - "minItems": 3, + "description": "3-element unitful tuple.", "maxItems": 3, - "items": [ + "minItems": 3, + "prefixItems": [ { "type": "number" }, @@ -67,32 +48,28 @@ { "type": "number" } - ] + ], + "title": "Value", + "type": "array" }, "unit": { - "title": "Unit", - "description": "the unit length string.", "default": "code_length", + "description": "the unit length string.", + "title": "Unit", "type": "string" } - } + }, + "title": "Left_Edge", + "type": "object" }, - "Right_Edge": { - "title": "Right_Edge", - "type": "object", + "Length_Tuple": { "properties": { "value": { - "title": "Value", + "default": null, "description": "3-element unitful tuple.", - "default": [ - 1.0, - 1.0, - 1.0 - ], - "type": "array", - "minItems": 3, "maxItems": 3, - "items": [ + "minItems": 3, + "prefixItems": [ { "type": "number" }, @@ -102,58 +79,77 @@ { "type": "number" } - ] + ], + "title": "Value", + "type": "array" }, "unit": { - "title": "Unit", + "default": "code_length", "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Length_Tuple", + "type": "object" + }, + "Length_Value": { + "properties": { + "value": { + "default": null, + "description": "Single unitful value.", + "title": "Value", + "type": "number" + }, + "unit": { "default": "code_length", + "description": "the unit length string.", + "title": "Unit", "type": "string" } - } + }, + "title": "Length_Value", + "type": "object" }, "Region": { - "title": "Region", - "type": "object", "properties": { "fields": { - "title": "Fields", + "default": null, "description": "list of fields to load for this selection", - "type": "array", "items": { - "$ref": "#/definitions/ytField" - } + "$ref": "#/$defs/ytField" + }, + "title": "Fields", + "type": "array" }, "left_edge": { - "title": "Left Edge", - "description": "the left edge (min x, min y, min z)", "allOf": [ { - "$ref": "#/definitions/Left_Edge" + "$ref": "#/$defs/Left_Edge" } - ] + ], + "default": null, + "description": "the left edge (min x, min y, min z)" }, "right_edge": { - "title": "Right Edge", - "description": "the right edge (max x, max y, max z)", "allOf": [ { - "$ref": "#/definitions/Right_Edge" + "$ref": "#/$defs/Right_Edge" } - ] + ], + "default": null, + "description": "the right edge (max x, max y, max z)" }, "resolution": { - "title": "Resolution", - "description": "the resolution at which to sample between the edges.", "default": [ 400, 400, 400 ], - "type": "array", - "minItems": 3, + "description": "the resolution at which to sample between the edges.", "maxItems": 3, - "items": [ + "minItems": 3, + "prefixItems": [ { "type": "integer" }, @@ -163,27 +159,32 @@ { "type": "integer" } - ] + ], + "title": "Resolution", + "type": "array" }, "rescale": { - "title": "Rescale", - "description": "rescale the final image between 0,1", "default": false, + "description": "rescale the final image between 0,1", + "title": "Rescale", "type": "boolean" } - } + }, + "title": "Region", + "type": "object" }, - "Length_Tuple": { - "title": "Length_Tuple", - "type": "object", + "Right_Edge": { "properties": { "value": { - "title": "Value", + "default": [ + 1.0, + 1.0, + 1.0 + ], "description": "3-element unitful tuple.", - "type": "array", - "minItems": 3, "maxItems": 3, - "items": [ + "minItems": 3, + "prefixItems": [ { "type": "number" }, @@ -193,187 +194,152 @@ { "type": "number" } - ] + ], + "title": "Value", + "type": "array" }, "unit": { - "title": "Unit", - "description": "the unit length string.", "default": "code_length", + "description": "the unit length string.", + "title": "Unit", "type": "string" } - } + }, + "title": "Right_Edge", + "type": "object" }, - "Length_Value": { - "title": "Length_Value", - "type": "object", + "SelectionObject": { "properties": { - "value": { - "title": "Value", - "description": "Single unitful value.", - "type": "number" + "regions": { + "default": null, + "description": "a list of regions to load", + "items": { + "$ref": "#/$defs/Region" + }, + "title": "Regions", + "type": "array" }, - "unit": { - "title": "Unit", - "description": "the unit length string.", - "default": "code_length", - "type": "string" + "slices": { + "default": null, + "description": "a list of slices to load", + "items": { + "$ref": "#/$defs/Slice" + }, + "title": "Slices", + "type": "array" } - } + }, + "title": "SelectionObject", + "type": "object" }, "Slice": { - "title": "Slice", - "type": "object", "properties": { "fields": { - "title": "Fields", + "default": null, "description": "list of fields to load for this selection", - "type": "array", "items": { - "$ref": "#/definitions/ytField" - } + "$ref": "#/$defs/ytField" + }, + "title": "Fields", + "type": "array" }, "normal": { - "title": "Normal", + "default": null, "description": "the normal axis of the slice", + "title": "Normal", "type": "string" }, "center": { - "title": "Center", - "description": "The center point of the slice, default domain center", "allOf": [ { - "$ref": "#/definitions/Length_Tuple" + "$ref": "#/$defs/Length_Tuple" } - ] + ], + "default": null, + "description": "The center point of the slice, default domain center" }, "slice_width": { - "title": "Slice Width", - "description": "The slice width, defaults to full domain", "allOf": [ { - "$ref": "#/definitions/Length_Value" + "$ref": "#/$defs/Length_Value" } - ] + ], + "default": null, + "description": "The slice width, defaults to full domain" }, "slice_height": { - "title": "Slice Height", - "description": "The slice width, defaults to full domain", "allOf": [ { - "$ref": "#/definitions/Length_Value" + "$ref": "#/$defs/Length_Value" } - ] + ], + "default": null, + "description": "The slice width, defaults to full domain" }, "resolution": { - "title": "Resolution", - "description": "the resolution at which to sample the slice", "default": [ 400, 400 ], - "type": "array", - "minItems": 2, + "description": "the resolution at which to sample the slice", "maxItems": 2, - "items": [ + "minItems": 2, + "prefixItems": [ { "type": "integer" }, { "type": "integer" } - ] + ], + "title": "Resolution", + "type": "array" }, "periodic": { - "title": "Periodic", - "description": "should the slice be periodic? default False.", "default": false, + "description": "should the slice be periodic? default False.", + "title": "Periodic", "type": "boolean" }, "rescale": { - "title": "Rescale", - "description": "rescale the final image between 0,1", "default": false, + "description": "rescale the final image between 0,1", + "title": "Rescale", "type": "boolean" } - } - }, - "SelectionObject": { - "title": "SelectionObject", - "type": "object", - "properties": { - "regions": { - "title": "Regions", - "description": "a list of regions to load", - "type": "array", - "items": { - "$ref": "#/definitions/Region" - } - }, - "slices": { - "title": "Slices", - "description": "a list of slices to load", - "type": "array", - "items": { - "$ref": "#/definitions/Slice" - } - } - } - }, - "DataContainer": { - "title": "DataContainer", - "type": "object", - "properties": { - "filename": { - "title": "Filename", - "description": "the filename for the dataset", - "type": "string" - }, - "selections": { - "title": "Selections", - "description": "selections to load in this dataset", - "allOf": [ - { - "$ref": "#/definitions/SelectionObject" - } - ] - }, - "store_in_cache": { - "title": "Store In Cache", - "description": "if enabled, will store references to yt datasets.", - "default": true, - "type": "boolean" - } - } + }, + "title": "Slice", + "type": "object" }, "TimeSeriesFileSelection": { - "title": "TimeSeriesFileSelection", - "type": "object", "properties": { "directory": { - "title": "Directory", + "default": null, "description": "The directory of the timseries", + "title": "Directory", "type": "string" }, "file_pattern": { - "title": "File Pattern", + "default": null, "description": "The file pattern to match", + "title": "File Pattern", "type": "string" }, "file_list": { - "title": "File List", + "default": null, "description": "List of files to load.", - "type": "array", "items": { "type": "string" - } + }, + "title": "File List", + "type": "array" }, "file_range": { - "title": "File Range", + "default": null, "description": "Given files matched by file_pattern, this option will select a range. Argument orderis taken as start:stop:step.", - "type": "array", - "minItems": 3, "maxItems": 3, - "items": [ + "minItems": 3, + "prefixItems": [ { "type": "integer" }, @@ -383,36 +349,86 @@ { "type": "integer" } - ] + ], + "title": "File Range", + "type": "array" } - } + }, + "title": "TimeSeriesFileSelection", + "type": "object" }, "Timeseries": { - "title": "Timeseries", - "type": "object", "properties": { "file_selection": { - "$ref": "#/definitions/TimeSeriesFileSelection" + "$ref": "#/$defs/TimeSeriesFileSelection" }, "selections": { - "title": "Selections", - "description": "selections to load in this dataset", "allOf": [ { - "$ref": "#/definitions/SelectionObject" + "$ref": "#/$defs/SelectionObject" } - ] + ], + "default": null, + "description": "selections to load in this dataset" }, "load_as_stack": { - "title": "Load As Stack", - "description": "If True, will stack images along a new dimension.", "default": false, + "description": "If True, will stack images along a new dimension.", + "title": "Load As Stack", "type": "boolean" } }, "required": [ "file_selection" - ] + ], + "title": "Timeseries", + "type": "object" + }, + "ytField": { + "properties": { + "field_type": { + "default": null, + "description": "a field type in the yt dataset", + "title": "Field Type", + "type": "string" + }, + "field_name": { + "default": null, + "description": "a field in the yt dataset", + "title": "Field Name", + "type": "string" + }, + "take_log": { + "default": true, + "description": "if true, will apply log10 to the selected data", + "title": "Take Log", + "type": "boolean" + } + }, + "title": "ytField", + "type": "object" } - } + }, + "properties": { + "datasets": { + "default": null, + "description": "list of dataset containers to load", + "items": { + "$ref": "#/$defs/DataContainer" + }, + "title": "Datasets", + "type": "array" + }, + "timeseries": { + "default": null, + "description": "List of timeseries to load", + "items": { + "$ref": "#/$defs/Timeseries" + }, + "title": "Timeseries", + "type": "array" + } + }, + "title": "InputModel", + "type": "object" } diff --git a/docs/schema.rst b/docs/schema.rst index f3e4f11..8b8b599 100644 --- a/docs/schema.rst +++ b/docs/schema.rst @@ -17,6 +17,8 @@ The following versions are available (latest first): .. schemalistanchor! the following table is auto-generated by repo_utilites/update_schema_docs.py, Do not edit below this line. +yt-napari_0.4.0.json : `view <_static/yt-napari_0.4.0.json>`_ , :download:`download <_static/yt-napari_0.4.0.json>` + yt-napari_0.3.0.json : `view <_static/yt-napari_0.3.0.json>`_ , :download:`download <_static/yt-napari_0.3.0.json>` yt-napari_0.2.1.json : `view <_static/yt-napari_0.2.1.json>`_ , :download:`download <_static/yt-napari_0.2.1.json>` diff --git a/repo_utilities/update_schema_docs.py b/repo_utilities/update_schema_docs.py index 4386bf2..952955e 100644 --- a/repo_utilities/update_schema_docs.py +++ b/repo_utilities/update_schema_docs.py @@ -13,7 +13,7 @@ def run_update(source_dir, schema_dir): if __name__ == "__main__": parser = argparse.ArgumentParser() msg = ( - "the schema version to write (form X.X.X). If not provided, " + "the schema version to write (form X.X.X or vX.X.X). If not provided, " "will only copy over the current schema without writing a new one." ) parser.add_argument("-v", "--version", type=str, default=None, help=msg) diff --git a/repo_utilities/validate.py b/repo_utilities/validate.py index 4a4c452..ddb25ea 100644 --- a/repo_utilities/validate.py +++ b/repo_utilities/validate.py @@ -97,8 +97,7 @@ def validate(version: str): if __name__ == "__main__": parser = argparse.ArgumentParser() - parser.add_argument( - "version", help="The upcoming release string to check", type=str - ) + deets = "The upcoming release string to check (format as vX.X.X)" + parser.add_argument("version", help=deets, type=str) args = parser.parse_args() validate(args.version) diff --git a/src/yt_napari/schemas/yt-napari_0.4.0.json b/src/yt_napari/schemas/yt-napari_0.4.0.json new file mode 100644 index 0000000..0ca45c4 --- /dev/null +++ b/src/yt_napari/schemas/yt-napari_0.4.0.json @@ -0,0 +1,434 @@ +{ + "$defs": { + "DataContainer": { + "properties": { + "filename": { + "default": null, + "description": "the filename for the dataset", + "title": "Filename", + "type": "string" + }, + "selections": { + "allOf": [ + { + "$ref": "#/$defs/SelectionObject" + } + ], + "default": null, + "description": "selections to load in this dataset" + }, + "store_in_cache": { + "default": true, + "description": "if enabled, will store references to yt datasets.", + "title": "Store In Cache", + "type": "boolean" + } + }, + "title": "DataContainer", + "type": "object" + }, + "Left_Edge": { + "properties": { + "value": { + "default": [ + 0.0, + 0.0, + 0.0 + ], + "description": "3-element unitful tuple.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ], + "title": "Value", + "type": "array" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Left_Edge", + "type": "object" + }, + "Length_Tuple": { + "properties": { + "value": { + "default": null, + "description": "3-element unitful tuple.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ], + "title": "Value", + "type": "array" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Length_Tuple", + "type": "object" + }, + "Length_Value": { + "properties": { + "value": { + "default": null, + "description": "Single unitful value.", + "title": "Value", + "type": "number" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Length_Value", + "type": "object" + }, + "Region": { + "properties": { + "fields": { + "default": null, + "description": "list of fields to load for this selection", + "items": { + "$ref": "#/$defs/ytField" + }, + "title": "Fields", + "type": "array" + }, + "left_edge": { + "allOf": [ + { + "$ref": "#/$defs/Left_Edge" + } + ], + "default": null, + "description": "the left edge (min x, min y, min z)" + }, + "right_edge": { + "allOf": [ + { + "$ref": "#/$defs/Right_Edge" + } + ], + "default": null, + "description": "the right edge (max x, max y, max z)" + }, + "resolution": { + "default": [ + 400, + 400, + 400 + ], + "description": "the resolution at which to sample between the edges.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "integer" + }, + { + "type": "integer" + }, + { + "type": "integer" + } + ], + "title": "Resolution", + "type": "array" + }, + "rescale": { + "default": false, + "description": "rescale the final image between 0,1", + "title": "Rescale", + "type": "boolean" + } + }, + "title": "Region", + "type": "object" + }, + "Right_Edge": { + "properties": { + "value": { + "default": [ + 1.0, + 1.0, + 1.0 + ], + "description": "3-element unitful tuple.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ], + "title": "Value", + "type": "array" + }, + "unit": { + "default": "code_length", + "description": "the unit length string.", + "title": "Unit", + "type": "string" + } + }, + "title": "Right_Edge", + "type": "object" + }, + "SelectionObject": { + "properties": { + "regions": { + "default": null, + "description": "a list of regions to load", + "items": { + "$ref": "#/$defs/Region" + }, + "title": "Regions", + "type": "array" + }, + "slices": { + "default": null, + "description": "a list of slices to load", + "items": { + "$ref": "#/$defs/Slice" + }, + "title": "Slices", + "type": "array" + } + }, + "title": "SelectionObject", + "type": "object" + }, + "Slice": { + "properties": { + "fields": { + "default": null, + "description": "list of fields to load for this selection", + "items": { + "$ref": "#/$defs/ytField" + }, + "title": "Fields", + "type": "array" + }, + "normal": { + "default": null, + "description": "the normal axis of the slice", + "title": "Normal", + "type": "string" + }, + "center": { + "allOf": [ + { + "$ref": "#/$defs/Length_Tuple" + } + ], + "default": null, + "description": "The center point of the slice, default domain center" + }, + "slice_width": { + "allOf": [ + { + "$ref": "#/$defs/Length_Value" + } + ], + "default": null, + "description": "The slice width, defaults to full domain" + }, + "slice_height": { + "allOf": [ + { + "$ref": "#/$defs/Length_Value" + } + ], + "default": null, + "description": "The slice width, defaults to full domain" + }, + "resolution": { + "default": [ + 400, + 400 + ], + "description": "the resolution at which to sample the slice", + "maxItems": 2, + "minItems": 2, + "prefixItems": [ + { + "type": "integer" + }, + { + "type": "integer" + } + ], + "title": "Resolution", + "type": "array" + }, + "periodic": { + "default": false, + "description": "should the slice be periodic? default False.", + "title": "Periodic", + "type": "boolean" + }, + "rescale": { + "default": false, + "description": "rescale the final image between 0,1", + "title": "Rescale", + "type": "boolean" + } + }, + "title": "Slice", + "type": "object" + }, + "TimeSeriesFileSelection": { + "properties": { + "directory": { + "default": null, + "description": "The directory of the timseries", + "title": "Directory", + "type": "string" + }, + "file_pattern": { + "default": null, + "description": "The file pattern to match", + "title": "File Pattern", + "type": "string" + }, + "file_list": { + "default": null, + "description": "List of files to load.", + "items": { + "type": "string" + }, + "title": "File List", + "type": "array" + }, + "file_range": { + "default": null, + "description": "Given files matched by file_pattern, this option will select a range. Argument orderis taken as start:stop:step.", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "integer" + }, + { + "type": "integer" + }, + { + "type": "integer" + } + ], + "title": "File Range", + "type": "array" + } + }, + "title": "TimeSeriesFileSelection", + "type": "object" + }, + "Timeseries": { + "properties": { + "file_selection": { + "$ref": "#/$defs/TimeSeriesFileSelection" + }, + "selections": { + "allOf": [ + { + "$ref": "#/$defs/SelectionObject" + } + ], + "default": null, + "description": "selections to load in this dataset" + }, + "load_as_stack": { + "default": false, + "description": "If True, will stack images along a new dimension.", + "title": "Load As Stack", + "type": "boolean" + } + }, + "required": [ + "file_selection" + ], + "title": "Timeseries", + "type": "object" + }, + "ytField": { + "properties": { + "field_type": { + "default": null, + "description": "a field type in the yt dataset", + "title": "Field Type", + "type": "string" + }, + "field_name": { + "default": null, + "description": "a field in the yt dataset", + "title": "Field Name", + "type": "string" + }, + "take_log": { + "default": true, + "description": "if true, will apply log10 to the selected data", + "title": "Take Log", + "type": "boolean" + } + }, + "title": "ytField", + "type": "object" + } + }, + "properties": { + "datasets": { + "default": null, + "description": "list of dataset containers to load", + "items": { + "$ref": "#/$defs/DataContainer" + }, + "title": "Datasets", + "type": "array" + }, + "timeseries": { + "default": null, + "description": "List of timeseries to load", + "items": { + "$ref": "#/$defs/Timeseries" + }, + "title": "Timeseries", + "type": "array" + } + }, + "title": "InputModel", + "type": "object" +}