The yt-napari JSON schema

The yt-napari plugins rely on pydantic models for setting variables and properties required to load in data from yt. The primary pydantic model, is exported as a json-schema to facilitate loading in data (see the json schema example) and to semi-automatically build the widget plugin.

The latest json schema is rendered below, but the raw json can be viewed directly here or downloaded here.

InputModel

type

object

properties

  • data

Data

list of datasets to load

type

array

items

#/definitions/DataContainer

definitions

  • ytField

ytField

type

object

properties

  • field_type

Field Type

a field type in the yt dataset

type

string

  • field_name

Field Name

a field in the yt dataset

type

string

  • take_log

Take Log

if true, will apply log10 to the selected data

type

boolean

default

True

  • SelectionObject

SelectionObject

type

object

properties

  • fields

Fields

list of fields to load for this selection

type

array

items

#/definitions/ytField

  • left_edge

Left Edge

the left edge (min x, min y, min z) in units of edge_units

type

array

default

0.0

0.0

0.0

items

type

number

type

number

type

number

maxItems

3

minItems

3

  • right_edge

Right Edge

the right edge (max x, max y, max z) in units of edge_units

type

array

default

1.0

1.0

1.0

items

type

number

type

number

type

number

maxItems

3

minItems

3

  • resolution

Resolution

the resolution at which to sample between the edges.

type

array

default

400

400

400

items

type

integer

type

integer

type

integer

maxItems

3

minItems

3

  • DataContainer

DataContainer

type

object

properties

  • filename

Filename

the filename for the dataset

type

string

  • selections

Selections

list of selections to load in this dataset

type

array

items

#/definitions/SelectionObject

  • edge_units

Edge Units

the units to use for left_edge and right_edge in the selections

type

string

default

code_length

List of schema versions

The following versions are available (latest first):

yt-napari_0.0.1.json : view , download