Skip to content

Add NcML to supported FORMATS #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jachym merged 2 commits into from
Feb 9, 2020
Merged

Add NcML to supported FORMATS #515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f283e3
added ncml to supported formats
huard Feb 7, 2020
b4b5801
added ncml schema
huard Feb 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pywps/inout/formats/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
_FORMATS = namedtuple('FORMATS', 'GEOJSON, JSON, SHP, GML, METALINK, META4, KML, KMZ, GEOTIFF,'
'WCS, WCS100, WCS110, WCS20, WFS, WFS100,'
'WFS110, WFS20, WMS, WMS130, WMS110,'
'WMS100, TEXT, DODS, NETCDF, LAZ, LAS, ZIP,'
'WMS100, TEXT, DODS, NETCDF, NCML, LAZ, LAS, ZIP,'
'XML')


Expand Down Expand Up @@ -187,6 +187,7 @@ def json(self, jsonin):
Format('text/plain', extension='.txt'),
Format('application/x-ogc-dods', extension='.nc'),
Format('application/x-netcdf', extension='.nc', encoding='base64'),
Format('application/ncML+xml', extension='.ncml', schema="ncml/2.2/ncml-2.2.xsd"),
Format('application/octet-stream', extension='.laz'),
Format('application/octet-stream', extension='.las'),
Format('application/zip', extension='.zip', encoding='base64'),
Expand Down
288 changes: 288 additions & 0 deletions pywps/schemas/ncml/2.2/ncml-2.2.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,288 @@
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema targetNamespace="http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.unidata.ucar.edu/namespaces/netcdf/ncml-2.2"
elementFormDefault="qualified">

<!-- XML encoding of Netcdf container object -->
<xsd:element name="netcdf">
<xsd:complexType>
<xsd:sequence>
<xsd:choice minOccurs="0">
<xsd:element name="readMetadata"/>
<xsd:element name="explicit"/>
</xsd:choice>

<xsd:element name="iospParam" minOccurs="0" />

<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="enumTypedef"/>
<xsd:element ref="group"/>
<xsd:element ref="dimension"/>
<xsd:element ref="variable"/>
<xsd:element ref="attribute"/>
<xsd:element ref="remove"/>
</xsd:choice>

<xsd:element ref="aggregation" minOccurs="0"/>
</xsd:sequence>

<xsd:attribute name="location" type="xsd:anyURI"/>
<xsd:attribute name="id" type="xsd:string"/>
<xsd:attribute name="title" type="xsd:string"/>
<xsd:attribute name="enhance" type="xsd:string"/>
<xsd:attribute name="addRecords" type="xsd:boolean"/>

<!-- iosp class name -->
<xsd:attribute name="iosp" type="xsd:string"/>
<!-- iosp parameter -->
<xsd:attribute name="iospParam" type="xsd:string"/>
<!-- raf buffer size -->
<xsd:attribute name="bufferSize" type="xsd:int"/>

<!-- for aggregations -->
<xsd:attribute name="ncoords" type="xsd:string"/>
<xsd:attribute name="coordValue" type="xsd:string"/>
<xsd:attribute name="section" type="xsd:string"/>
</xsd:complexType>
</xsd:element>

<!-- XML encoding of group object -->
<xsd:element name="group">
<xsd:complexType>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="enumTypedef"/>
<xsd:element ref="dimension"/>
<xsd:element ref="variable"/>
<xsd:element ref="attribute"/>
<xsd:element ref="group"/>
<xsd:element ref="remove"/>
</xsd:choice>
<xsd:attribute name="name" type="xsd:string" use="required"/>
<xsd:attribute name="orgName" type="xsd:string"/>
</xsd:complexType>
</xsd:element>

<!-- XML encoding of dimension object -->
<xsd:element name="dimension">
<xsd:complexType>
<xsd:attribute name="name" type="xsd:token" use="required"/>
<xsd:attribute name="length" type="xsd:string"/>
<xsd:attribute name="isUnlimited" type="xsd:boolean" default="false"/>
<xsd:attribute name="isVariableLength" type="xsd:boolean" default="false"/>
<xsd:attribute name="isShared" type="xsd:boolean" default="true"/>
<xsd:attribute name="orgName" type="xsd:string"/>
</xsd:complexType>
</xsd:element>

<!-- XML encoding of Variable object -->
<xsd:element name="variable">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="attribute" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="values" minOccurs="0"/>
<xsd:element ref="variable" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="logicalSection" minOccurs="0"/>
<xsd:element ref="logicalSlice" minOccurs="0"/>
<xsd:element ref="logicalReduce" minOccurs="0"/>
<xsd:element ref="remove" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:token" use="required"/>
<xsd:attribute name="type" type="DataType"/>
<xsd:attribute name="typedef" type="xsd:string"/>
<xsd:attribute name="shape" type="xsd:token"/>
<xsd:attribute name="orgName" type="xsd:string"/>
</xsd:complexType>
</xsd:element>

<!-- XML encoding of values -->
<xsd:element name="values">
<xsd:complexType mixed="true">
<xsd:attribute name="start" type="xsd:float"/>
<xsd:attribute name="increment" type="xsd:float"/>
<xsd:attribute name="npts" type="xsd:int"/>
<xsd:attribute name="separator" type="xsd:string"/>
<xsd:attribute name="fromAttribute" type="xsd:string"/>
</xsd:complexType>
</xsd:element>

<!-- XML encoding of Attribute object -->
<xsd:element name="attribute">
<xsd:complexType mixed="true">
<xsd:attribute name="name" type="xsd:token" use="required"/>
<xsd:attribute name="type" type="DataType" default="String"/>
<xsd:attribute name="value" type="xsd:string"/>
<xsd:attribute name="separator" type="xsd:string"/>
<xsd:attribute name="orgName" type="xsd:string"/>
<xsd:attribute name="isUnsigned" type="xsd:boolean"/>
</xsd:complexType>
</xsd:element>

<!-- possible data types for Variable, Attribute objects -->
<xsd:simpleType name="DataType">
<xsd:restriction base="xsd:token">
<xsd:enumeration value="byte"/>
<xsd:enumeration value="char"/>
<xsd:enumeration value="short"/>
<xsd:enumeration value="int"/>
<xsd:enumeration value="long"/>
<xsd:enumeration value="float"/>
<xsd:enumeration value="double"/>
<xsd:enumeration value="String"/>
<xsd:enumeration value="string"/>
<xsd:enumeration value="Structure"/>
<xsd:enumeration value="Sequence"/>
<xsd:enumeration value="opaque"/>
<xsd:enumeration value="enum1"/>
<xsd:enumeration value="enum2"/>
<xsd:enumeration value="enum4"/>
</xsd:restriction>
</xsd:simpleType>

<!-- XML encoding of enum typedef object -->
<xsd:element name="enumTypedef">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="enum" minOccurs="1" maxOccurs="unbounded">
<xsd:complexType mixed="true">
<xsd:attribute name="key" type="xsd:int" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:token" use="required"/>
<xsd:attribute name="type" type="DataType" default="enum1"/>
</xsd:complexType>
</xsd:element>


<!-- Dataset **********************************************************************-->

<xsd:element name="remove">
<xsd:complexType>
<xsd:attribute name="type" type="ObjectType" use="required"/>
<xsd:attribute name="name" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>

<xsd:simpleType name="ObjectType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="attribute"/>
<xsd:enumeration value="dimension"/>
<xsd:enumeration value="variable"/>
<xsd:enumeration value="group"/>
</xsd:restriction>
</xsd:simpleType>

<!-- logical view: use only a section of original -->
<xsd:element name="logicalSection">
<xsd:complexType>
<xsd:attribute name="section" type="xsd:token" use="required"/> <!-- creates anonymous dimension -->
</xsd:complexType>
</xsd:element>

<xsd:element name="logicalSlice">
<xsd:complexType>
<xsd:attribute name="dimName" type="xsd:token" use="required"/>
<xsd:attribute name="index" type="xsd:int" use="required"/>
</xsd:complexType>
</xsd:element>

<xsd:element name="logicalReduce">
<xsd:complexType>
<xsd:attribute name="dimNames" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>

<!-- aggregation -->
<xsd:element name="aggregation">
<xsd:complexType>
<xsd:sequence>

<!-- experimental - modify each dataset in aggregation -->
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="group"/>
<xsd:element ref="dimension"/>
<xsd:element ref="variable"/>
<xsd:element ref="attribute"/>
<xsd:element ref="remove"/>
</xsd:choice>

<xsd:element name="variableAgg" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="name" type="xsd:string" use="required"/>
</xsd:complexType>
</xsd:element>

<xsd:element ref="promoteGlobalAttribute" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="cacheVariable" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="netcdf" minOccurs="0" maxOccurs="unbounded"/>

<xsd:element name="scan" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="location" type="xsd:string" use="required"/>
<xsd:attribute name="regExp" type="xsd:string"/>
<xsd:attribute name="suffix" type="xsd:string"/>
<xsd:attribute name="subdirs" type="xsd:boolean" default="true"/>
<xsd:attribute name="olderThan" type="xsd:string"/>

<xsd:attribute name="dateFormatMark" type="xsd:string"/>
<xsd:attribute name="enhance" type="xsd:boolean"/>
</xsd:complexType>
</xsd:element>

<!-- fmrcSingle only -->
<xsd:element name="scanFmrc" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="location" type="xsd:string" use="required"/>
<xsd:attribute name="regExp" type="xsd:string"/>
<xsd:attribute name="suffix" type="xsd:string"/>
<xsd:attribute name="subdirs" type="xsd:boolean" default="true"/>
<xsd:attribute name="olderThan" type="xsd:string"/>

<xsd:attribute name="runDateMatcher" type="xsd:string"/>
<xsd:attribute name="forecastDateMatcher" type="xsd:string"/>
<xsd:attribute name="forecastOffsetMatcher" type="xsd:string"/>
</xsd:complexType>
</xsd:element>

</xsd:sequence>

<xsd:attribute name="type" type="AggregationType" use="required"/>
<xsd:attribute name="dimName" type="xsd:token"/>
<xsd:attribute name="recheckEvery" type="xsd:string"/>
<xsd:attribute name="timeUnitsChange" type="xsd:boolean"/>

<!-- fmrc, fmrcSingle only -->
<xsd:attribute name="fmrcDefinition" type="xsd:string"/>

</xsd:complexType>
</xsd:element>

<!-- type of aggregation -->
<xsd:simpleType name="AggregationType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="forecastModelRunCollection"/>
<xsd:enumeration value="forecastModelRunSingleCollection"/>
<xsd:enumeration value="joinExisting"/>
<xsd:enumeration value="joinNew"/>
<xsd:enumeration value="tiled"/>
<xsd:enumeration value="union"/>
</xsd:restriction>
</xsd:simpleType>

<!-- promote global attribute to variable -->
<xsd:element name="promoteGlobalAttribute">
<xsd:complexType>
<xsd:attribute name="name" type="xsd:token" use="required"/>
<xsd:attribute name="orgName" type="xsd:string"/>
</xsd:complexType>
</xsd:element>

<!-- cache a Variable for efficiency -->
<xsd:element name="cacheVariable">
<xsd:complexType>
<xsd:attribute name="name" type="xsd:token" use="required"/>
</xsd:complexType>
</xsd:element>

</xsd:schema>