Skip to content

Commit

Permalink
Rename master to main branch.
Browse files Browse the repository at this point in the history
refs #58
  • Loading branch information
csjx committed Mar 13, 2022
1 parent a21d60d commit ad6d867
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/_sources/user/user-guide.txt
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ This XML structure provides the necessary metadata for parsing, validating, arch

It's easiest to just copy an existing XML configuration document and add/replace values as need. Here's an `example document`_.

.. _example document: https://github.com/csjx/realtime-data/blob/master/conf/WK01XX_001CTDXXXXR00.xml
.. _`data management plan`: https://github.com/csjx/realtime-data/raw/master/docs/dev/BBL-requirements-document-and-management-plan.pdf
.. _example document: https://github.com/csjx/realtime-data/blob/main/conf/WK01XX_001CTDXXXXR00.xml
.. _`data management plan`: https://github.com/csjx/realtime-data/raw/main/docs/dev/BBL-requirements-document-and-management-plan.pdf

Starting Instrument Drivers
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user/user-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ This XML structure provides the necessary metadata for parsing, validating, arch

It's easiest to just copy an existing XML configuration document and add/replace values as need. Here's an `example document`_.

.. _example document: https://github.com/csjx/realtime-data/blob/master/conf/WK01XX_001CTDXXXXR00.xml
.. _`data management plan`: https://github.com/csjx/realtime-data/raw/master/docs/dev/BBL-requirements-document-and-management-plan.pdf
.. _example document: https://github.com/csjx/realtime-data/blob/main/conf/WK01XX_001CTDXXXXR00.xml
.. _`data management plan`: https://github.com/csjx/realtime-data/raw/main/docs/dev/BBL-requirements-document-and-management-plan.pdf

Starting Instrument Drivers
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/user/manage-instruments/configuration/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Each instrument deployment gets documented in an XML configuration file in the ``${REALTIME_DATA}/conf`` directory with the same name as the instrument name. For instance, the Waikiki Beach CTD is named ``WK01XX_001CTDXXXXR00``, and the corresponding XML file is ``WK01XX_001CTDXXXXR00.xml``.

To create a new instrument configuration, it's easiest to just copy an existing XML configuration document and add/replace values as need. Here's an [example document](https://github.com/csjx/realtime-data/blob/master/conf/online/WK01XX_001CTDXXXXR00.xml).
To create a new instrument configuration, it's easiest to just copy an existing XML configuration document and add/replace values as need. Here's an [example document](https://github.com/csjx/realtime-data/blob/main/conf/online/WK01XX_001CTDXXXXR00.xml).

## Adding an instrument by example

Expand Down
4 changes: 2 additions & 2 deletions docs/user/user-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ <h3>1.1.3. Troubleshooting the DataTurbine<a class="headerlink" href="#troublesh
</div>
<div class="section" id="managing-the-dataturbine-instrument-drivers">
<h2>1.2. Managing the DataTurbine Instrument Drivers<a class="headerlink" href="#managing-the-dataturbine-instrument-drivers" title="Permalink to this headline"></a></h2>
<p>Each instrument type in the water has a corresponding instrument driver used to connect it to the DataTurbine. For instance, for ADCPs, there&#8217;s a Java-based driver called <code class="docutils literal"><span class="pre">ADCPSource</span></code>, and for the CTDs, there&#8217;s a driver called <code class="docutils literal"><span class="pre">CTDSource</span></code>. PacIOOS nearshore instruments use a generic text-based driver called a <code class="docutils literal"><span class="pre">SimpleTextSource</span></code> which handles all delimited text-based data samples. Driver Source naming conventions can be found in the <a class="reference external" href="https://github.com/csjx/realtime-data/raw/master/docs/dev/BBL-requirements-document-and-management-plan.pdf">data management plan</a>. The drivers are managed through a single shell script called <code class="docutils literal"><span class="pre">manage-instruments</span></code>. This script starts and stops drivers and archivers (see below).</p>
<p>Each instrument type in the water has a corresponding instrument driver used to connect it to the DataTurbine. For instance, for ADCPs, there&#8217;s a Java-based driver called <code class="docutils literal"><span class="pre">ADCPSource</span></code>, and for the CTDs, there&#8217;s a driver called <code class="docutils literal"><span class="pre">CTDSource</span></code>. PacIOOS nearshore instruments use a generic text-based driver called a <code class="docutils literal"><span class="pre">SimpleTextSource</span></code> which handles all delimited text-based data samples. Driver Source naming conventions can be found in the <a class="reference external" href="https://github.com/csjx/realtime-data/raw/main/docs/dev/BBL-requirements-document-and-management-plan.pdf">data management plan</a>. The drivers are managed through a single shell script called <code class="docutils literal"><span class="pre">manage-instruments</span></code>. This script starts and stops drivers and archivers (see below).</p>
<div class="section" id="configuring-instrument-drivers">
<h3>1.2.1. Configuring Instrument Drivers<a class="headerlink" href="#configuring-instrument-drivers" title="Permalink to this headline"></a></h3>
<p>Each instrument deployment gets documented in an XML configuration file in the <code class="docutils literal"><span class="pre">${REALTIME_DATA}/conf</span></code> directory with the same name as the instrument name. For instance, the Waikiki Beach CTD is named <code class="docutils literal"><span class="pre">WK01XX_001CTDXXXXR00</span></code>, and the corresponding XML file is <code class="docutils literal"><span class="pre">WK01XX_001CTDXXXXR00.xml</span></code>.</p>
Expand Down Expand Up @@ -367,7 +367,7 @@ <h3>1.2.1. Configuring Instrument Drivers<a class="headerlink" href="#configurin
</tr>
</tbody>
</table>
<p>It&#8217;s easiest to just copy an existing XML configuration document and add/replace values as need. Here&#8217;s an <a class="reference external" href="https://github.com/csjx/realtime-data/blob/master/conf/WK01XX_001CTDXXXXR00.xml">example document</a>.</p>
<p>It&#8217;s easiest to just copy an existing XML configuration document and add/replace values as need. Here&#8217;s an <a class="reference external" href="https://github.com/csjx/realtime-data/blob/main/conf/WK01XX_001CTDXXXXR00.xml">example document</a>.</p>
</div>
<div class="section" id="starting-instrument-drivers">
<h3>1.2.2. Starting Instrument Drivers<a class="headerlink" href="#starting-instrument-drivers" title="Permalink to this headline"></a></h3>
Expand Down

0 comments on commit ad6d867

Please sign in to comment.