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

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

First tranch of modifications following Exeter Metadata Meeting

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