Skip to content

Commit

Permalink
Switch to MyST Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
ajelenak committed Apr 11, 2024
1 parent 73bfbdf commit 02e736f
Show file tree
Hide file tree
Showing 71 changed files with 637 additions and 537 deletions.
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
Attribute
=========
# Attribute

```{eval-rst}
.. productionlist::
attribute_collection: "[" `attribute_list` "]"
attribute_list: `attribute` ("," `attribute`)*
attribute: "{"
: "name" ":" `ascii_string` | `unicode_string` ","
: "type" ":" `datatype` | `datatype_ref` ","
: "shape" ":" `dataspace` ","
: "value" ":" `json_value` ","
: "type" ":" `datatype` | `datatype_ref` ","
: "shape" ":" `dataspace` ","
: "value" ":" `json_value` ","
: "creationProperties" ":" `acpl`
: "}"
: "}"
acpl: "{"
: "nameCharEncoding" ":" `char_encoding`
: "}"
```
33 changes: 18 additions & 15 deletions docs/bnf/dataset.rst → docs/bnf/dataset.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
Dataset
=======
# Dataset

```{eval-rst}
.. productionlist::
dataset: `identifier` ":" "{"
: "alias" ":" `hdf5_path_name_array`
: "attributes" ":" `attribute_collection` ","
: "type" ":" `datatype` | `datatype_ref` ","
: "shape" ":" `dataspace` ","
: "value" ":" `json_value` ","
: "creationProperties" ":" `dcpl`
: "}"
: "attributes" ":" `attribute_collection` ","
: "type" ":" `datatype` | `datatype_ref` ","
: "shape" ":" `dataspace` ","
: "value" ":" `json_value` ","
: "creationProperties" ":" `dcpl`
: "}"
json_value: `json_string`
:| `json_number`
:| `json_array`
:| `json_null`
```

```{eval-rst}
.. productionlist::
dcpl: "{"
: "allocTime" ":" `alloc_time` ","
Expand All @@ -28,11 +30,11 @@ Dataset
: "}"
alloc_time: "H5D_ALLOC_TIME_DEFAULT"
:| "H5D_ALLOC_TIME_EARLY"
:| "H5D_ALLOC_TIME_INCR"
:| "H5D_ALLOC_TIME_LATE"
:| "H5D_ALLOC_TIME_INCR"
:| "H5D_ALLOC_TIME_LATE"
fill_time: "H5D_FILL_TIME_IFSET"
:| "H5D_FILL_TIME_ALLOC"
:| "H5D_FILL_TIME_NEVER"
:| "H5D_FILL_TIME_NEVER"
fill_value: `json_value`
layout: `chunked_layout` | `compact_layout` | `contiguous_layout`
chunked_layout: "{"
Expand All @@ -44,12 +46,13 @@ Dataset
: "}"
contiguous_layout: "{"
: "class" ":" "H5D_CONTIGUOUS" ","
: "externalStorage" ":" `external`
: "externalStorage" ":" `external`
: "}"
external: "[" `file_extent_list` "]"
file_extent_list: `file_extent` ("," `file_extent`)*
file_extent: "{"
: "name" ":" `ascii_string` ","
: "offset" ":" `non_negative_integer`
: "size" ":" `positive_integer`
: "}"
: "offset" ":" `non_negative_integer`
: "size" ":" `positive_integer`
: "}"
```
27 changes: 15 additions & 12 deletions docs/bnf/dataspace.rst → docs/bnf/dataspace.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
Dataspace
=========
# Dataspace

```{eval-rst}
.. productionlist::
dataspace: `null_dataspace` | `scalar_dataspace` | `simple_dataspace`
null_dataspace: "{"
: "class" ":" "H5S_NULL"
: "}"
: "class" ":" "H5S_NULL"
: "}"
scalar_dataspace: "{"
: "class" ":" "H5S_SCALAR"
: "}"
: "class" ":" "H5S_SCALAR"
: "}"
simple_dataspace: "{"
: "class" ":" "H5S_SIMPLE" ","
: "class" ":" "H5S_SIMPLE" ","
: "dims" ":" `dims_array` ","
: "maxdims" ":" `maxdims_array`
: "}"
: "}"
```

```{eval-rst}
.. productionlist::
dataspace_selection: "{"
: "class" ":" `selection_class` ","
: "selection" ":" ( `hyperslab_selection`
: | `point_selection`)
: "selection" ":" ( `hyperslab_selection`
: | `point_selection`)
selection_class: "H5S_SEL_HYPERSLABS"
:| "H5S_SEL_POINTS"
hyperslab_selection: "[" `block_list` "]"
block_list: `block` ("," `block`)*
block: "{"
: "start" ":" `coordinate` ","
: "opposite" ":" `coordinate`
: "}"
: "opposite" ":" `coordinate`
: "}"
point_selection: "[" `coordinate_list` "]"
coordinate_list: `coordinate` ("," `coordinate`)*
coordinate: `non_negative_integer_array`
```
131 changes: 76 additions & 55 deletions docs/bnf/datatype.rst → docs/bnf/datatype.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Datatype
========
# Datatype

```{eval-rst}
.. productionlist::
datatype_object: `identifier` ":" "{"
: "alias" ":" `hdf5_path_name_array`
Expand All @@ -17,15 +17,19 @@ Datatype
:| `string_datatype`
:| `vlen_datatype`
```

```{eval-rst}
.. productionlist::
array_datatype: "{"
: "class" ":" "H5T_ARRAY" ","
: "base" ":" `datatype` | `datatype_ref` ","
: "dims" ":" `dims_array`
: "}"
: "dims" ":" `dims_array`
: "}"
```

```{eval-rst}
.. productionlist::
bitfield_datatype: "{"
: "class" ":" "H5T_BITFIELD" ","
Expand All @@ -34,46 +38,52 @@ Datatype
bitfield_predef: "base" ":"
: ( "H5T_STD_B8BE" | "H5T_STD_B8LE"
:| "H5T_STD_B16BE" | "H5T_STD_B16LE"
:| "H5T_STD_B32BE" | "H5T_STD_B32LE"
:| "H5T_STD_B64BE" | "H5T_STD_B64LE" )
:| "H5T_STD_B32BE" | "H5T_STD_B32LE"
:| "H5T_STD_B64BE" | "H5T_STD_B64LE" )
bitfield_user : "bitOffset" ":" `non_negative_integer` ","
: "byteOrder" ":" `byte_order` ","
: "lsbPad" ":" `bit_padding` ","
: "msbPad" ":" `bit_padding` ","
: "precision" ":" `positive_integer` ","
: "size" ":" `positive_integer`
: "byteOrder" ":" `byte_order` ","
: "lsbPad" ":" `bit_padding` ","
: "msbPad" ":" `bit_padding` ","
: "precision" ":" `positive_integer` ","
: "size" ":" `positive_integer`
bit_padding : "H5T_PAD_ZERO"
:| "H5T_PAD_ONE"
:| "H5T_PAD_BACKGROUND"
:| "H5T_PAD_BACKGROUND"
byte_order : "H5T_ORDER_LE" | "H5T_ORDER_BE"
```

```{eval-rst}
.. productionlist::
compound_datatype: "{"
: "class" ":" "H5T_COMPOUND" ","
: "fields" ":" "[" `field_list` "]"
: "}"
: "fields" ":" "[" `field_list` "]"
: "}"
field_list: `field_def` ("," `field_def`)*
field_def: "{"
: "name" ":" `ascii_string` ","
: "type" ":" `datatype` | `datatype_ref` ","
: "}"
: "type" ":" `datatype` | `datatype_ref` ","
: "}"
```

```{eval-rst}
.. productionlist::
enumeration_datatype: "{"
: "base" ":" ( `integer_datatype` |
: "base" ":" ( `integer_datatype` |
: `datatype_reference` ) ","
: "class" ":" "H5T_ENUM" ","
: "members" ":" "[" `enum_member_list` "]"
: "}"
: "members" ":" "[" `enum_member_list` "]"
: "}"
enum_member_list: `enum_member` ("," `enum_member`)*
enum_member: "{"
: "name" ":" `ascii_string` ","
: "value" ":" `integer`
: "}"
```

```{eval-rst}
.. productionlist::
floating_point_datatype: "{"
: "class" ":" "H5T_FLOAT" ","
Expand All @@ -84,24 +94,26 @@ Datatype
:| "H5T_IEEE_F64BE" | "H5T_IEEE_F64LE" )
float_user: "{"
: "bitOffset" ":" `non_negative_integer` ","
: "byteOrder" ":" `byte_order` ","
: "expBias" ":" `positive_integer` ","
: "expBits" ":" `positive_integer` ","
: "expBitPos" ":" `positive_integer` ","
: "intlbPad" ":" `bit_padding` ","
: "lsbPad" ":" `bit_padding` ","
: "mantBits" ":" `positive_integer` ","
: "mantBitPos" ":" `non_negative_integer` ","
: "mantNorm" ":" `mant_norm` ","
: "msbitPad" ":" `bit_padding` ","
: "precision" ":" `positive_integer` ","
: "signBitPos" ":" `positive_integer` ","
: "size" ":" `positive_integer`
: "}"
: "byteOrder" ":" `byte_order` ","
: "expBias" ":" `positive_integer` ","
: "expBits" ":" `positive_integer` ","
: "expBitPos" ":" `positive_integer` ","
: "intlbPad" ":" `bit_padding` ","
: "lsbPad" ":" `bit_padding` ","
: "mantBits" ":" `positive_integer` ","
: "mantBitPos" ":" `non_negative_integer` ","
: "mantNorm" ":" `mant_norm` ","
: "msbitPad" ":" `bit_padding` ","
: "precision" ":" `positive_integer` ","
: "signBitPos" ":" `positive_integer` ","
: "size" ":" `positive_integer`
: "}"
mant_norm: "H5T_NORM_IMPLIED"
:| "H5T_NORM_MSBSET"
:| "H5T_NORM_NONE"
:| "H5T_NORM_NONE"
```

```{eval-rst}
.. productionlist::
integer_datatype: "{"
: "class" ":" "H5T_INTEGER" ","
Expand All @@ -110,31 +122,35 @@ Datatype
integer_predef: "base" ":"
: ( "H5T_STD_I8BE" | "H5T_STD_I8LE"
:| "H5T_STD_I16BE" | "H5T_STD_I16LE"
:| "H5T_STD_I32BE" | "H5T_STD_I32LE"
:| "H5T_STD_I64BE" | "H5T_STD_I64LE"
:| "H5T_STD_U8BE" | "H5T_STD_U8LE"
:| "H5T_STD_U16BE" | "H5T_STD_U16LE"
:| "H5T_STD_U32BE" | "H5T_STD_U32LE"
:| "H5T_STD_U64BE" | "H5T_STD_U64LE" )
:| "H5T_STD_I32BE" | "H5T_STD_I32LE"
:| "H5T_STD_I64BE" | "H5T_STD_I64LE"
:| "H5T_STD_U8BE" | "H5T_STD_U8LE"
:| "H5T_STD_U16BE" | "H5T_STD_U16LE"
:| "H5T_STD_U32BE" | "H5T_STD_U32LE"
:| "H5T_STD_U64BE" | "H5T_STD_U64LE" )
integer_user: "{"
: "bitOffset" ":" `non_negative_integer` ","
: "byteOrder" ":" `byte_order` ","
: "lsbPad" ":" `bit_padding` ","
: "msbPad" ":" `bit_padding` ","
: "precision" ":" `positive_integer` ","
: "signType" ":" `sign_type` ","
: "size" ":" `positive_integer`
: "}"
: "bitOffset" ":" `non_negative_integer` ","
: "byteOrder" ":" `byte_order` ","
: "lsbPad" ":" `bit_padding` ","
: "msbPad" ":" `bit_padding` ","
: "precision" ":" `positive_integer` ","
: "signType" ":" `sign_type` ","
: "size" ":" `positive_integer`
: "}"
sign_type: "H5T_SGN_NONE" | "H5T_SGN_2"
```

```{eval-rst}
.. productionlist::
opaque_datatype: "{"
: "class" ":" "H5T_OPAQUE" ","
: "size" ":" `positive_integer` ","
: "tag" ":" `ascii_string`
: "tag" ":" `ascii_string`
: "}"
```

```{eval-rst}
.. productionlist::
reference_datatype: "{"
: "class" ":" "H5T_REFERENCE" ","
Expand All @@ -144,28 +160,33 @@ Datatype
object_reference_value: `path`
region_reference_value: "{"
: "dataset" ":" `dataset_ref` ";"
: "selection" ":" `dataspace_selection`
: "selection" ":" `dataspace_selection`
: "}"
dataset_ref: "datasets/" `id_reference`
datatype_ref: "datatypes/" `id_reference`
group_ref: "groups/" `id_reference`
```

```{eval-rst}
.. productionlist::
string_datatype: "{"
: "charSet" ":" `char_encoding`
: "class" ":" "H5T_STRING" ","
: "length" " ":" `string_length`
: "strPad" ":" `string_padding` ","
: "length" " ":" `string_length`
: "strPad" ":" `string_padding` ","
: "}"
char_encoding: "H5T_CSET_ASCII" | "H5T_CSET_UTF8"
string_length: `positive_integer` | "H5T_VARIABLE"
string_padding: "H5T_STR_NULLTERM"
:| "H5T_STR_NULLPAD"
:| "H5T_STR_SPACEPAD"
:| "H5T_STR_SPACEPAD"
```

```{eval-rst}
.. productionlist::
vlen_datatype: "{"
: "class" ":" "H5T_VLEN" ","
: "base" ":" `datatype` | `datatype_ref` ","
: "}"
: "base" ":" `datatype` | `datatype_ref` ","
: "}"
```
Loading

0 comments on commit 02e736f

Please sign in to comment.