Skip to content

Commit

Permalink
Merge pull request #15 from stephanbracke/development
Browse files Browse the repository at this point in the history
Development
  • Loading branch information
stephanbracke authored May 17, 2024
2 parents 7c4da2d + 0f3f445 commit c79ba43
Show file tree
Hide file tree
Showing 18 changed files with 160 additions and 146 deletions.
77 changes: 39 additions & 38 deletions appendices/includes/dataformats/imagcdfformat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ the data correctly.
================= ====== ======= ================================================
FormatDescription String 1 Always set to "INTERMAGNET CDF Format"
FormatVersion String 1 Set to the current version of the format – "1.2"
Title1 String 1 Always set to "Geomagnetic time series data"
Title String 1 Always set to "Geomagnetic time series data"
================= ====== ======= ================================================


Expand Down Expand Up @@ -647,53 +647,54 @@ is:
- Mandatory (number of entries per variable is exactly :sup:`1`)
- Optional (number of entries per variable may be :sup:`0` or :sup:`1`)

Superscript numbers following the attribute name show:

#. That the attribute is a recommended attribute for use with NASA's CDF
tools
#. That the attribute is part of the ISTP/IACG guidelines - |istp_vattr|
.. raw:: latex

\newpage

None of these attributes are required for the time stamp variables
GeomagneticVectorTimes and GeomagneticScalarTimes.

.. tabularcolumns:: |p{3cm}|p{1.5cm}|>{\centering\arraybackslash}p{1.5cm}|p{8cm}|

.. table::
:widths: auto
:widths: 24,10,6,60
:align: center

+----------------+--------+---------+-----------------------------------------------------------+
| Attribute Name | Type | Entries | Description |
+----------------+--------+---------+-----------------------------------------------------------+
| FIELDNAM1 | String | 1 | Set to "Geomagnetic Field Element " + the element code |
| | | | (e.g. H, D, Z,… - see section |
| | | | :ref:`app_cdf_gattr_valid_codes` for a list of valid |
| | | | codes); or set to "Temperature " + the name of the |
| | | | location where the temperature was recorded. |
+----------------+--------+---------+-----------------------------------------------------------+
| UNITS1 | String | 1 | Must be one of "nT", "Degrees of arc" or "Celsius" |
+----------------+--------+---------+-----------------------------------------------------------+
| FILLVAL1 | Double | 1 | The value used to show that a data sample is missing. Set |
| | | | to 99999.0 for compatibility with other formats. The |
| | | | values must either less than VALIDMIN or greater than |
| | | | VALIDMAX. |
+----------------+--------+---------+-----------------------------------------------------------+
| VALIDMIN1 | Double | 1 | The smallest allowed numeric value for the data in the |
| | | | corresponding variable. |
+----------------+--------+---------+-----------------------------------------------------------+
| VALIDMAX1 | Double | 1 | The largest allowed numeric value for the data in the |
| | | | corresponding variable. |
+----------------+--------+---------+-----------------------------------------------------------+
| DEPEND_02 | String | 0 - 1 | For geomagnetic data, set this to the name of the |
| | | | variable that holds time stamps for this time series. For |
| | | | records containing time stamps, do not set this variable. |
+----------------+--------+---------+-----------------------------------------------------------+
| DISPLAY_TYPE2 | String | 1 | Set to "time_series" |
+----------------+--------+---------+-----------------------------------------------------------+
| LABLAXIS2 | String | 1 | Set to the element code (as defined in section |
| | | | :ref:`app_cdf_gattr_valid_codes` ) |
+----------------+--------+---------+-----------------------------------------------------------+
+--------------------------+--------+---------+-----------------------------------------------------------+
| Attribute Name | Type | Entries | Description |
+--------------------------+--------+---------+-----------------------------------------------------------+
| FIELDNAM [#f5]_ | String | 1 | Set to "Geomagnetic Field Element " + the element code |
| | | | (e.g. H, D, Z,… - see section |
| | | | :ref:`app_cdf_gattr_valid_codes` for a list of valid |
| | | | codes); or set to "Temperature " + the name of the |
| | | | location where the temperature was recorded. |
+--------------------------+--------+---------+-----------------------------------------------------------+
| UNITS [#f5]_ | String | 1 | Must be one of "nT", "Degrees of arc" or "Celsius" |
+--------------------------+--------+---------+-----------------------------------------------------------+
| FILLVAL [#f5]_ | Double | 1 | The value used to show that a data sample is missing. Set |
| | | | to 99999.0 for compatibility with other formats. The |
| | | | values must either less than VALIDMIN or greater than |
| | | | VALIDMAX. |
+--------------------------+--------+---------+-----------------------------------------------------------+
| VALIDMIN [#f5]_ | Double | 1 | The smallest allowed numeric value for the data in the |
| | | | corresponding variable. |
+--------------------------+--------+---------+-----------------------------------------------------------+
| VALIDMAX [#f5]_ | Double | 1 | The largest allowed numeric value for the data in the |
| | | | corresponding variable. |
+--------------------------+--------+---------+-----------------------------------------------------------+
| DEPEND_0 [#f6]_ | String | 0 - 1 | For geomagnetic data, set this to the name of the |
| | | | variable that holds time stamps for this time series. For |
| | | | records containing time stamps, do not set this variable. |
+--------------------------+--------+---------+-----------------------------------------------------------+
| DISPLAY_TYPE [#f6]_ | String | 1 | Set to "time_series" |
+--------------------------+--------+---------+-----------------------------------------------------------+
| LABLAXIS [#f6]_ | String | 1 | Set to the element code (as defined in section |
| | | | :ref:`app_cdf_gattr_valid_codes` ) |
+--------------------------+--------+---------+-----------------------------------------------------------+

.. [#f5] The attribute is a recommended attribute for use with NASA's CDF tools
.. [#f6] The attribute is part of the ISTP/IACG guidelines - |istp_vattr|
ImagCDF File Names
``````````````````
Expand Down
3 changes: 1 addition & 2 deletions chapters/intermagnet/principles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ commercial users.
#. Each INTERMAGNET GIN will provide annually to each
participating institution or observatory a statement of data
received by the GIN. Each week, INTERMAGNET will provide
data download statistics to the community via FTP (see
:numref:`use_dat_ftp`).
data download statistics to the community.



Expand Down
3 changes: 2 additions & 1 deletion chapters/membership/imagparticipationpolicy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ the INTERMAGNET data delivery requirements and the observatory
will be notified of the breach by the Operations Committee.

The Operations Committee will also assess definitive data
submitted for inclusion on the annual DVD against the data
submitted for inclusion in the INTERMAGNET Reference Data Set
(IRDS) against the data
quality standards for one-minute data as defined in the
Technical Manual. The deadline for submission of definitive
data will be communicated by the Operations Committee in
Expand Down
5 changes: 2 additions & 3 deletions chapters/oneminuteimos/description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,8 @@ received within 72 hours of recording, but ideally faster (see

At the end of a calendar year, data are to be prepared using
final baselines and submitted as definitive data for inclusion
on the INTERMAGNET DVD. The deadline for submission will be
communicated by INTERMAGNET. Definitive data published on the
DVD are also made available on the INTERMAGNET web site.
in the INTERMAGNET Reference Data Set (IRDS). The deadline for submission will be
communicated by INTERMAGNET.

An observatory intending to participate in INTERMAGNET as an
IMO must be able to meet the INTERMAGNET standards for
Expand Down
6 changes: 3 additions & 3 deletions chapters/oneminuteimos/instrumentationspecs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,13 +144,13 @@ Other
| | for satellite) |
+--------------------------+------------------------------------------+
| Definitive data | to be submitted annually for inclusion |
| | on the DVD in IAFV2.11 format |
| | in the IRDS in IAFV2.11 format |
+--------------------------+------------------------------------------+
| Instrument baseline data | to be submitted annually for inclusion |
| | on the DVD in IBFV2.00 format |
| | in the IRDS in IBFV2.00 format |
+--------------------------+------------------------------------------+
| Annual means | to be submitted annually for inclusion |
| | on the DVD in IYFV1.02 format |
| | in the IRDS in IYFV1.02 format |
+--------------------------+------------------------------------------+
| Filtering | to INTERMAGNET standard |
| | (:numref:`1min_imo_sampling` ) |
Expand Down
6 changes: 3 additions & 3 deletions chapters/oneminuteimos/toc_oneminuteimos.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _1min_imo:

***************
One Minute IMOs
***************
****************************************************
INTERMAGNET Magnetic Observatories - One Minute IMOs
****************************************************

.. toctree::
:maxdepth: 4
Expand Down
6 changes: 3 additions & 3 deletions chapters/onesecondimos/toc_onesecondimos.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _1sec_imo:

***************
One Second IMOs
***************
****************************************************
INTERMAGNET Magnetic Observatories - One Second IMOs
****************************************************

.. toctree::
:maxdepth: 4
Expand Down
4 changes: 2 additions & 2 deletions chapters/processdata/adoptbaseline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ INTERMAGNET baseline format IBFV2.00, (|app_imag_ibf|). The
format includes a section for comments pertaining to dates and
times of baseline adjustments or changes in instrumentation.
These files must be transmitted annually to INTERMAGNET along
with 1-minute data for DVD production.
with 1-minute data for the IRDS production.

Statistics of the difference between the adopted and observed
baseline can be generated to verify that confidence limits for
Expand Down Expand Up @@ -60,4 +60,4 @@ in total field differences. Also, this will show up when you
calculate the differences between the absolute field values
determined in the absolute measurements minus the calibrated
data from the final data product (e.g. from the IAF files, see
|app_iaf| ) at the time of absolute measurements.
|app_iaf| ) at the time of absolute measurements.
7 changes: 3 additions & 4 deletions chapters/processdata/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ values for long-period, non-random error. A baseline adoption
process may be used that provides confidence limits for
component 1-minute and 1-second values. A tabular listing of
annual baseline values and a description of baseline
adjustments accompany the absolute data contained on
INTERMAGNET DVDs/CD-ROMs. A graphic display of baselines and
adjustments accompany the absolute data contained in
the INTERMAGNET Reference data set (IRDS). A graphic display of baselines and
differences in computed and recorded total field values are
available to users for stations on the INTERMAGNET
DVDs/CD-ROMs.
available to users.
Loading

0 comments on commit c79ba43

Please sign in to comment.