Merge pull request #10 from stephanbracke/development

Development
stephanbracke · Jun 30, 2023 · 67a55bf · 67a55bf
2 parents 2e74f09 + a29c068
commit 67a55bf
Show file tree

Hide file tree

Showing 16 changed files with 462 additions and 177 deletions.
diff --git a/appendices/acknowledgements.rst b/appendices/acknowledgements.rst
@@ -0,0 +1,63 @@
+Acknowledgements
+================
+
+We gratefully acknowledge the many and significant contributions to the
+Executive Council and Operations Committee provided by past members.
+
+.. hlist::
+    :columns: 2
+
+    * | **EXCON**
+      | William F. Stuart (UK)
+      | Arthur W. Green Jr. (USA)
+      | Richard L. Coles (Canada)
+      | Jean-Louis LeMouël (France)
+      | Larry Newitt (Canada)
+      | Jeff Love (USA)
+      | David Kerridge (UK)
+      | Arnaud Chulliat (France)
+      | Carol Finn (USA)
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+      |
+
+
+    * | **OPSCOM**
+      | Lanny Wilson (USA)
+      | Doug F. Trigg (Canada)
+      | Francois-Xavier Lalanne (France)
+      | Gerrit Jansen van Beek (Canada)
+      | Michèle Bitterly (France)
+      | Jacques Bitterly (France)
+      | John Riddick (UK)
+      | Edward A. Sauter (USA)
+      | Jennifer Parmelee (Canada)
+      | Toyohisa Kamei (Japan)
+      | Ole Rasmussen (Denmark)
+      | Lee Pankratz (USA)
+      | Donald C. Herzog (USA)
+      | Laszlo Hegymegi (Hungary)
+      | Danielle Fouassier (France)
+      | Jean-Jacques Schott (France)
+      | Manabu Kunitake (Japan)
+      | Luc Decker (France)
+      | Peter Crosthwaite (Australia)
+      | Hans-Joachim Linthe (Germany)
+      | Masahito Nosé (Japan)
+      | Duff Stuart (USA)
+      | Jean Rasson (Belgique)
+      | Tim White (USA)
+
+
diff --git a/appendices/archivedataformats.rst b/appendices/archivedataformats.rst
@@ -4,7 +4,22 @@ Archive Data Formats
 ====================
 
 .. include:: ./includes/adf/imagiaf.rst
+
+.. raw:: latex
+
+    \newpage
+
 .. include:: ./includes/adf/imagdirstructure.rst
+
+.. raw:: latex
+
+    \newpage
+
 .. include:: ./includes/adf/imagiyf.rst
+
+.. raw:: latex
+
+    \newpage
+
 .. include:: ./includes/adf/imagcdsoftware.rst
 
diff --git a/appendices/dataformats.rst b/appendices/dataformats.rst
@@ -5,8 +5,34 @@ Data Formats
 
 
 .. include:: ./includes/dataformats/imagimfv2.rst
+
+.. raw:: latex
+
+    \newpage
+
 .. include:: ./includes/dataformats/satcoding.rst
+
+.. raw:: latex
+
+    \newpage
+
 .. include:: ./includes/dataformats/imagimfv1.rst
+
+.. raw:: latex
+
+    \newpage
+
 .. include:: ./includes/dataformats/imagibf.rst
+
+.. raw:: latex
+
+    \newpage
+
+
 .. include:: ./includes/dataformats/iaga2002.rst
+
+.. raw:: latex
+
+    \newpage
+
 .. include:: ./includes/dataformats/imagcdfformat.rst
diff --git a/appendices/includes/adf/imagiaf.rst b/appendices/includes/adf/imagiaf.rst
diff --git a/appendices/includes/dataformats/iaga2002.rst b/appendices/includes/dataformats/iaga2002.rst
@@ -86,6 +86,7 @@ filled element field).
 - For transmission of incomplete day files include two additional
   optional comment headers stating the start time and duration in
   seconds. These records must have the form:
+
   | #Start Time hh:mm:ss
   | #Duration-in-seconds sssss
 
@@ -101,6 +102,7 @@ filled element field).
   convert angular units into nT or vice versa. The possible conversions
   are:
 
+      - E = D \* Ha \* arc(1')
       - V = I \* Fa \* arc(1')
       - X = H \* cos(Da) – E\* sin(Da)
       - Y = H \* sin(Da) + E\* cos(Da)
@@ -111,9 +113,12 @@ filled element field).
       - V = Z \* cos(Ia) – H \* sin(Ia)
 
   X, Y, Z, H, F, E, V in nT; D, I in minutes of arc
+
   arc(1') = 2.9089E-04 = 0.00029089
+
   Ha, Fa, Da, Ia : approximate values of H, F, D, I (eg the most recent
   annual mean value or a value from the IGRF)
+
   The formula and constants are to be given in additional optional
   comment header lines (see sample data header and data record for 1-second values).
 
@@ -238,7 +243,9 @@ Where:
    from Narsarsuaq.
 
 Additional format to handle multiple fragments of data starting at
-different times: iagyyyymmddhhMMsstint.int
+different times:
+
+iagyyyymmddhhMMsstint.int
 
 Where:
 

diff --git a/appendices/includes/dataformats/imagcdfformat.rst b/appendices/includes/dataformats/imagcdfformat.rst
@@ -527,7 +527,7 @@ the StandardsLevel attribute is set to Partial.
 
 .. [#f1]  INTERMAGNET Technical Note 6
 .. [#f2]  :numref:`1min_imo_descr`
-.. [#f3]  Quasi-definitive definition on the INTERMAGNET web site: |q_def|
+.. [#f3]  Quasi-definitive definition on the INTERMAGNET web site: |faq_qd|
 
 If a standard is met in full or not met at all, PartialStandDesc can be
 omitted. Where a standard is partially met (e.g. the time stamp accuracy
@@ -644,8 +644,8 @@ ImagCDF file and the value of that entry applies only to that field
 element or temperature. The "Entries" column shows whether the attribute
 is:
 
--  Mandatory (number of entries per variable is exactly 1)
--  Optional (number of entries per variable may be 0 or 1)
+-  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:
 
@@ -796,7 +796,7 @@ A number of packages provide access to CDF data. These include Matlab and IDL. A
 on the NASA CDF website: |cdf_software_list|
 
 Octave may be able to read CDF data:|octave|. The Wolfram Language can
-use CDF data via its NASACDF data format - |wolfgram|
+use CDF data via its NASACDF data format - |wolfram|.
 
 Example Data File
 `````````````````

diff --git a/appendices/includes/dataformats/imagimfv2.rst b/appendices/includes/dataformats/imagimfv2.rst
@@ -171,6 +171,25 @@ in 3-byte strings formed from two 12-bit fields combined as described below:
     Minute 684 (second item) 0  0  1 0 1 0 1 0 1 1 0 0 2AC
     ======================== == == = = = = = = = = = = ===
 
+
+.. table:: Output Encoded field
+    :widths: auto
+    :align: center
+
+
+    +--------+--------+-------------+----------------+-----------+--------+----------------+
+    |        | .. centered:: Byte 0 |  .. centered:: Byte 1      | .. centered:: Byte 2    |
+    +========+========+=============+================+===========+========+================+
+    | Byte   | 0001   | 1110        |1100            | 0000      |0010    | 1001           |
+    +--------+--------+-------------+----------------+-----------+--------+----------------+
+    | Hex    | 1      | E           | C              | 0         | 2      | A              |
+    +--------+--------+-------------+----------------+-----------+--------+----------------+
+    | Value  | 8 LSB Day            | 4 LSB Minute   | 4 MSB Day | 8 MSB Minute            |
+    +--------+--------+-------------+----------------+-----------+--------+----------------+
+
+
+
+
 IMFV2.83 Data Value Encoding
 ````````````````````````````
 

diff --git a/appendices/includes/dataformats/satcoding.rst b/appendices/includes/dataformats/satcoding.rst
@@ -31,10 +31,15 @@ Step 2 - sign extend in byte 1, bit 6=1, bit 7=odd parity.
 .. figure:: ../img/ness.png
     :align: center
 
+
+After encoding, the 12-minute block is sent to the data collection platform (DCP) to be transmitted.
+
 .. raw:: latex
 
     \newpage
 
+
+
 Consider the following data set:
 
 .. highlight:: none
@@ -329,7 +334,7 @@ would be:
 
 The following table shows time slots assigned to DCPs. Each table line represents 60 seconds,
 the station ID is placed at the beginning of a data transmission block, '....' is for the
-no-signal (carrier only) period, '--' is for synchronization sequence, and '==' is for the
+no-signal (carrier only) period, '- -' is for synchronization sequence, and '==' is for the
 data block.
 
 Assigned time slots for the GMS coding would allow 58 seconds per transmission and 7 seconds

diff --git a/chapters/intermagnet/condofuse.rst b/chapters/intermagnet/condofuse.rst
@@ -43,3 +43,12 @@ directly.
 INTERMAGNET accepts no liability in respect of
 loss, damage, injury or other occurrence arising from
 the provision of these data.
+
+The Operations Committee advises the Executive
+Council on matters relating to magnetic sensors, data
+capture and data processing, and on communications
+options, protocols, etc. The Operations Committee
+is also responsible for establishing and maintaining
+standards of operation and uniform data formats and
+transmission characteristics which optimize global
+exchange.
diff --git a/chapters/submitdata/introduction.rst b/chapters/submitdata/introduction.rst
@@ -4,6 +4,7 @@ Introduction
 ============
 
 .. include:: ../../appendices/appendices.rst
+.. include:: ../../shared/variables.rst
 
 
 Observatories send their data to INTERMAGNET via two different
@@ -459,11 +460,11 @@ INTERMAGNET GIN Manager at the following addresses:
 GIN Email Addresses
 ```````````````````
 
--  Ottawa: [email protected]
--  Paris: [email protected]
--  Golden: [email protected]
--  Edinburgh: [email protected]
--  Kyoto: [email protected]
+-  Ottawa: |contact_gin_ottawa|
+-  Paris: |contact_gin_paris|
+-  Golden: |contact_gin_golden|
+-  Edinburgh:|contact_gin_edin|
+-  Kyoto: |contact_gin_kyoto|
 
 
 

diff --git a/chapters/submitdata/subpreldata.rst b/chapters/submitdata/subpreldata.rst
@@ -241,7 +241,7 @@ are available here:
 Note that this web site is password protected – for access
 apply to the GIN manager.
 
-For more detailed information see INTERMAGNET Technical Note 9: |tn_9|
+For more detailed information see INTERMAGNET Technical Note 9: |tn_9|.
 
 .. _sub_dat_prel_email:
 

diff --git a/conf.py b/conf.py
@@ -23,13 +23,16 @@
 
 
 project = 'Technical Reference Manual'
-copyright = '2020, INTERMAGNET'
+copyright = ', INTERMAGNET'
 author = 'Technical Manual Team'
-release = re.sub('^v', '', os.popen('git describe').read().strip())
+#release = re.sub('^v', '', os.popen('git describe').read().strip())
+release ='5.1.0-draft'
 version = release
+
+
 file_dir = os.path.dirname(os.path.realpath(__file__))
 year = dt.datetime.now().year
-print(str(year))
+copyright = str(year) + copyright
 variables_to_export = [
     "project",
     "copyright",
@@ -97,22 +100,23 @@
                     'appendices/archivedataformats',
                     'appendices/imagaddresses',
                     'appendices/dataformats',
-                    'appendices/filters'
+                    'appendices/filters',
+                    'appendices/acknowledgements'
                     ]
 
-preamble = '''\
-    \\makeatletter
-      \\fancypagestyle{normal}{
-        \\fancyhf{}
-        \\fancyfoot[LE,RO]{{\\py@HeaderFamily\\thepage}}
-        \\fancyfoot[LO]{{\\py@HeaderFamily\\nouppercase{\\leftmark}}}
-        \\fancyfoot[RE]{{\\py@HeaderFamily\\nouppercase{\\leftmark}}}
-        \\fancyhead[LE,RO]{{\\py@HeaderFamily \\@title, \\py@release}}
-        \\renewcommand{\\headrulewidth}{0.4pt}
-        \\renewcommand{\\footrulewidth}{0.4pt}
-
+preamble = r'''
+    \makeatletter
+      \fancypagestyle{normal}{
+        \fancyhf{}
+        \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}
+        \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\leftmark}}}
+        \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
+        \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}}
+        \renewcommand{\headrulewidth}{0.4pt}
+        \renewcommand{\footrulewidth}{0.4pt}
       }
-    \makeatother
+    \usepackage[none]{hyphenat}
+    \setlength\parindent{12pt}
     '''
 
 latex_maketitle =  r'''
@@ -129,6 +133,12 @@
             \vspace{70mm}
             \Large version : \version \ (''' + str(year) +r''') 
             \vspace*{0mm}
+            \break     
+            \break     
+            \break     
+            \break     
+            \break     
+            \break     
         \end{titlepage}
         \clearpage
         \pagenumbering{roman}