source: TI01-discovery/trunk/schema/numsim/NumSim.xsd @ 887

Subversion URL:
Revision 887, 17.5 KB checked in by lawrence, 15 years ago (diff)

Candidate NumSimV007 (includes schema split to support
model+deployment, an example instance, a completed standalone
html viewer, and oxygen generated documentation)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
1<?xml version="1.0" encoding="UTF-8"?>
2<xs:schema xmlns:xs="" xmlns:xlink=""
3    xmlns:gco="" xmlns:gmd=""
4    version="00800">
5    <xs:annotation>
6        <xs:documentation> Author: Bryan Lawrence Version date: May 4th, 2006 </xs:documentation>
7    </xs:annotation>
8    <xs:annotation>
9        <xs:documentation>The expectation is that this schema will be used initially by import into
10            DIF discovery records and eventually into ISO19115 based discovery records. While such
11            discovery records already include adequate possibilities to include free text
12            information and/or URI references which would allow such discrimination for a human
13            reader, they do not allow the construction of sensible automatic discriminants, which
14            would allow a software agent to identify, for example, all simulation datasets based on
15            the IPCC SRESA1 forcing specification by the HADCM3 model. Such a software agent is
16            necessary to provide meaningful discovery services on an archive holding multiple
17            simulation datasets, and thus, there is a requirement to build information structures to
18            support such software agents. The NumSim schema provides a minimum set of such metadata
19            structures aimed at supporting the widest possible set of simulation codes. It is
20            expected that more detailed discipline specific metadata schema will exist, such as the
21            Numerical Model Metadata Suite (hereafter the NMM). Where such schema and instances
22            exist, it is desirable that the NumSim instances are automatically generated from the
23            more detailed metadata. </xs:documentation>
24        <xs:documentation>The NumSim schema exists in a context where NumSim compliant xml metadata
25            is to included in a document conforming to an (extensible) parent schema. That parent
26            schema is assumed to have adequate tags to fully describe the data produced by the
27            simulation, the point of the NumSim metadata is to discriminate between such datasets,
28            as a consequence all dataset description is offloaded to the parent schema, but there
29            are some tags which might appear in both the parent and the NumSim schema. In such a
30            case, the scope of the tag in the NumSim schema is simply the scope of the parent
31            element, while the scope of the tag in the parent document should be assumed to be
32            either that of the parent element, or in regard to the data, not the simulation. (For
33            example, reference lists may appear in multiple places in a discovery document, but
34            their scope and applicability is related to where they appear. By doing this it is
35            possible to search for datasets created by simulations with a particular model component
36            which was described in a particular </xs:documentation>
37        <xs:documentation>The simulated element is intended to appear as part of a dataset
38            description, and is used to discriminate between differing simulations of the same
39            phenomena. There are essentially three different cases where it is expected be used, and
40            for which it has been designed: (1) Where the dataset consists of one realization of the
41            simulated phenomena (a single integration of a numerical code). (2) Where the dataset
42            consists of multiple realizations of the phenomena (an ensemble), and (3) Where the
43            dataset consists of a single realization of the simulated phenomena, but where that
44            realization has been generated from an ensemble average (an ensemble “climatology”). </xs:documentation>
45        <xs:documentation>There are a number of schema which are imported here, copies of which are
46            loaded into a directory of schema. These include xlinks.xsd and a number of draft
47            ISO19139 schema components. </xs:documentation>
48    </xs:annotation>
49    <xs:import namespace=""
50        schemaLocation="../"/>
51    <xs:import namespace=""
52        schemaLocation="../iso19139/gml3.1.1version/gco/gco.xsd"/>
53    <xs:import namespace=""
54        schemaLocation="../iso19139/gml3.1.1version/gmd/citation.xsd"/>
55    <xs:attributeGroup name="NS_link">
56        <xs:annotation>
57            <xs:documentation> The attributes are those of a hyperlink, with the addition of a role
58                which we might later want to control in a vocabulary</xs:documentation>
59        </xs:annotation>
60        <xs:attribute ref="xlink:href" use="required"/>
61        <xs:attribute ref="xlink:title" use="required"/>
62        <xs:attribute ref="xlink:role" use="optional"/>
63        <xs:attribute name="dateOfCitation" type="gco:Date_Type" use="optional"/>
64    </xs:attributeGroup>
65    <xs:complexType name="NS_RelatedTo">
66        <xs:annotation>
67            <xs:documentation> Used for any relationships.</xs:documentation>
68        </xs:annotation>
69        <xs:sequence>
70            <xs:element name="NS_Relationship" type="xs:string"/>
71        </xs:sequence>
72        <xs:attributeGroup ref="NS_link"/>
73    </xs:complexType>
74    <xs:complexType name="NS_Description" mixed="true">
75        <xs:sequence>
76            <xs:element name="NS_RelatedURI" type="NS_RelatedTo" minOccurs="0" maxOccurs="unbounded"
77            />
78        </xs:sequence>
79    </xs:complexType>
80    <xs:complexType name="NS_ReferenceList">
81        <xs:choice>
82            <xs:element name="NS_Reference" type="xs:string" minOccurs="1" maxOccurs="unbounded"/>
83            <xs:element name="NS_Citation" type="gmd:CI_Citation_Type" minOccurs="1"
84                maxOccurs="unbounded"/>
85        </xs:choice>
86    </xs:complexType>
87    <xs:complexType name="NS_ControlledParameters">
88        <xs:sequence>
89            <xs:element name="NS_NamespaceURI" type="xs:anyURI">
90                <xs:annotation>
91                    <xs:documentation>Rather than rely on including xml namespaces, which can be
92                        done in the element values below, we've also allowed an explicitly labelled
93                        link to such namespaces, and to namespaces which are not XML
94                    namespaces.</xs:documentation>
95                </xs:annotation>
96            </xs:element>
97            <xs:element name="NS_Value" type="xs:string" minOccurs="1" maxOccurs="unbounded"/>
98        </xs:sequence>
99    </xs:complexType>
100    <xs:simpleType name="NS_InitialConditionTypes">
101        <xs:restriction base="xs:string">
102            <xs:enumeration value="Objective Analysis"/>
103            <xs:enumeration value="Assimilation Analysis"/>
104            <xs:enumeration value="Unknown"/>
105            <xs:enumeration value="Climatology"/>
106            <xs:enumeration value="Random"/>
107        </xs:restriction>
108    </xs:simpleType>
109    <xs:simpleType name="NS_ModelComponents">
110        <xs:annotation>
111            <xs:documentation>This the controlled vocabulary for the various model sub components
112                which might be able to run independently but could be coupled</xs:documentation>
113        </xs:annotation>
114        <xs:restriction base="xs:string">
115            <xs:enumeration value="Atmosphere"/>
116            <xs:enumeration value="Ocean"/>
117            <xs:enumeration value="Cryosphere"/>
118            <xs:enumeration value="LandSurface"/>
119            <xs:enumeration value="Chemistry"/>
120            <xs:enumeration value="Aerosol"/>
121            <xs:enumeration value="Coupler"/>
122        </xs:restriction>
123    </xs:simpleType>
124    <xs:simpleType name="NS_ModelCategories">
125        <xs:annotation>
126            <xs:documentation>This the controlled vocabulary that categorises how the model is set
127                up</xs:documentation>
128        </xs:annotation>
129        <xs:restriction base="xs:string">
130            <xs:enumeration value="GCM"/>
131            <xs:enumeration value="Standalone"/>
132            <xs:enumeration value="Idealised"/>
133            <xs:enumeration value="Energy Balance"/>
134            <xs:enumeration value="Assimilation"/>
135            <xs:enumeration value="Beta-plane"/>
136            <xs:enumeration value="Aqua-planet"/>
137            <xs:enumeration value="Column Mean"/>
138            <xs:enumeration value="Slab"/>
139            <xs:enumeration value="Trajectory"/>
140        </xs:restriction>
141    </xs:simpleType>
142    <xs:simpleType name="NS_BoundaryConditionNames">
143        <xs:annotation>
144            <xs:documentation>This the controlled vocabulary for Forcing
145            Specifications</xs:documentation>
146        </xs:annotation>
147        <xs:restriction base="xs:string">
148            <xs:enumeration value="IPCC SRES A1"/>
149            <xs:enumeration value="IPCC SRES A2"/>
150            <xs:enumeration value="IPCC SRES B1"/>
151            <xs:enumeration value="IPCC SRES B2"/>
152            <xs:enumeration value="IS92A"/>
153            <xs:enumeration value="Preindustrial"/>
154            <xs:enumeration value="Present Day"/>
155            <xs:enumeration value="Double Preindustrial"/>
156            <xs:enumeration value="Double Present Day"/>
157            <xs:enumeration value="Background"/>
158            <xs:enumeration value="Historical"/>
159            <xs:enumeration value="% per annum increase"/>
160            <xs:enumeration value="Lateral Boundary Global Model"/>
161            <xs:enumeration value="User Specified"/>
162        </xs:restriction>
163    </xs:simpleType>
164    <xs:simpleType name="NS_EnsembleTypes">
165        <xs:annotation>
166            <xs:documentation>This the controlled vocabulary for the types of ensemble. Note that a
167                Grand ensemble is a combination of two or more other ensemble
168            types.</xs:documentation>
169        </xs:annotation>
170        <xs:restriction base="xs:string">
171            <xs:enumeration value="Initial Condition"/>
172            <xs:enumeration value="Perturbed Physics"/>
173            <xs:enumeration value="Arbitrary Collection"/>
174            <xs:enumeration value="Single Model"/>
175            <xs:enumeration value="Multiple Model"/>
176            <xs:enumeration value="Multiple Forcing"/>
177            <xs:enumeration value="Grand"/>
178        </xs:restriction>
179    </xs:simpleType>
180    <xs:complexType name="NS_InitialCondition" mixed="false">
181        <xs:annotation>
182            <xs:documentation> Multiple initial condition elements can appear to cover how different
183                parts of the model system were initialized. If present, the main requirement is that
184                the initial condition be described in the description element and those parameters
185                which are controlled by the initial condition be identified if possible. Failing a
186                description (or as well as) the type attribute can identify the sort of initial
187                condition from the InitialConditionTypes controlled vocabulary.</xs:documentation>
188            <xs:documentation> Where the initial condition is in fact a perturbed version of the
189                “real” values for the starting time (perhaps as part of an ensemble), the perturbed
190                Boolean attribute can be set true (the default is false). Where the perturbation is
191                physically meaningful (for example, using singular vectors), this can be indicated
192                in the description. </xs:documentation>
193        </xs:annotation>
194        <xs:sequence>
195            <xs:element name="NS_Description" type="NS_Description" minOccurs="0" maxOccurs="1"/>
196            <xs:element name="NS_ControlledParameters" type="NS_ControlledParameters" minOccurs="0"
197                maxOccurs="unbounded"/>
198            <xs:element name="NS_References" type="NS_ReferenceList" minOccurs="0" maxOccurs="1"/>
199        </xs:sequence>
200        <xs:attribute name="NS_Type" type="NS_InitialConditionTypes"/>
201        <xs:attribute name="NS_Perturbed" type="xs:boolean"/>
202    </xs:complexType>
203    <xs:complexType name="NS_BoundaryCondition">
204        <xs:sequence>
205            <xs:element name="NS_Description" type="NS_Description" minOccurs="1"/>
206            <xs:element name="NS_ControlledParameters" type="NS_ControlledParameters" minOccurs="0"
207                maxOccurs="unbounded"/>
208            <xs:element name="NS_References" type="NS_ReferenceList" minOccurs="0" maxOccurs="1"/>
209            <xs:element name="NS_BoundaryDataset" type="NS_RelatedTo" minOccurs="0" maxOccurs="1"/>
210        </xs:sequence>
211        <xs:attribute name="NS_Type" type="NS_BoundaryConditionNames"/>
212    </xs:complexType>
213    <xs:complexType name="NS_EnsembleDetails">
214        <xs:annotation>
215            <xs:documentation>If not present, the default assumption should be that the simulation
216                is a single realization. If present, the attribute can identify that the data
217                represents an ensemble climatology by setting the Boolean EnsembleStatistics to
218                True, otherwise the default is that the data are multiple realizations. This element
219                may include multiple EnsembleType elements, which are drawn from the EnsembleTypes
220                controlled vocabulary: o Initial Condition o Perturbed Physics o Arbitrary
221                Collection o Single Mode o Multiple Model o Multiple Forcing o GrandEnsemble (any
222                combination of the others, in which case the exact combination should be recorded in
223                the EnsembleDescription element - itself including both a textural component and an
224                optional related URI for more information). If only one integration is included,
225                just one model element should be used. Whether an ensemble or a single integration
226                is described by this element, multiple boundary and initial conditions elements are
227                allowed (in the case of single integrations to support multiple components of the
228                model having different initial and/or boundary conditions, and for ensembles to
229                potentially include multiple boundary conditions associated with multiple forcings).
230                (Note that more complex ensemble statistics, such as, for example probability
231                distribution functions, are likely to be more fully described by the data
232                attributes, this attribute is simply used to aid users in finding ensemble averages
233                and avoid them being mistaken for instances and used inappropriately).
234            </xs:documentation>
235        </xs:annotation>
236        <xs:sequence>
237            <xs:element name="NS_EnsembleDescription" type="NS_Description" minOccurs="0"
238                maxOccurs="1"/>
239            <xs:element name="NS_EnsembleType" type="NS_EnsembleTypes" minOccurs="1"
240                maxOccurs="unbounded"/>
241        </xs:sequence>
242        <xs:attribute name="NS_EnsembleStatistics" type="xs:boolean" default="0"/>
243    </xs:complexType>
244    <xs:complexType name="NS_Model">
245        <xs:annotation>
246            <xs:documentation> The NS_Model complex type is used to both as the type of the overall
247                model description (forming a compulsory element within the NumSIm element itself),
248                and as the type of any sub component of that model. </xs:documentation>
249        </xs:annotation>
250        <xs:sequence>
251            <xs:element name="NS_Name" type="xs:string" minOccurs="1" maxOccurs="1"/>
252            <xs:element name="NS_Category" type="NS_ModelCategories" minOccurs="0"
253                maxOccurs="unbounded"/>
254            <xs:element name="NS_ComponentType" type="NS_ModelComponents" minOccurs="0"
255                maxOccurs="unbounded"/>
256            <xs:element name="NS_Description" type="NS_Description" minOccurs="0" maxOccurs="1"/>
257            <xs:element name="NS_Resolution" type="NS_Description" minOccurs="0" maxOccurs="1"/>
258            <xs:element name="NS_RelatedModel" type="NS_RelatedTo" minOccurs="0"
259                maxOccurs="unbounded"/>
260            <xs:element name="NS_References" type="NS_ReferenceList" minOccurs="0" maxOccurs="1"/>
261            <xs:element name="NS_Component" type="NS_Model" minOccurs="0" maxOccurs="unbounded"/>
262        </xs:sequence>
263    </xs:complexType>
264    <xs:complexType name="NS_CodeBase">
265        <xs:sequence>
266            <xs:element name="NS_Description" type="NS_Description"/>
267            <xs:element name="NS_Model" type="NS_Model" minOccurs="1" maxOccurs="unbounded"/>
268        </xs:sequence>
269    </xs:complexType>
270    <xs:complexType name="NS_Experiment">
271        <xs:annotation>
272            <xs:documentation>Used to define how the codebase has been used. Note that the
273                NS_ParentEnsemble can be used when an integration is available as in independant
274                dataset to point back to the parent ensemble dataset.</xs:documentation>
275        </xs:annotation>
276        <xs:sequence>
277            <xs:element name="NS_Description" type="NS_Description"/>
278            <xs:element name="NS_BoundaryCondition" type="NS_BoundaryCondition" minOccurs="0"
279                maxOccurs="unbounded"/>
280            <xs:element name="NS_InitialCondition" type="NS_InitialCondition" minOccurs="0"
281                maxOccurs="unbounded"/>
282            <xs:element name="NS_Ensemble" type="NS_EnsembleDetails" minOccurs="0" maxOccurs="1"/>
283            <xs:element name="NS_ParentEnsemble" type="NS_RelatedTo" minOccurs="0"
284                maxOccurs="unbounded"/>
285        </xs:sequence>
286    </xs:complexType>
287    <xs:complexType name="NS_NumSim">
288        <xs:sequence>
289            <xs:element name="NS_CodeBase" type="NS_CodeBase"/>
290            <xs:element name="NS_Experiment" type="NS_Experiment"/>
291        </xs:sequence>
292    </xs:complexType>
293    <xs:element name="NS_Simulated" type="NS_NumSim"/>
Note: See TracBrowser for help on using the repository browser.