From ad6d8670297e8404a23b90d58edb19e56f237a32 Mon Sep 17 00:00:00 2001 From: Christopher Jones Date: Sun, 13 Mar 2022 13:47:30 -0600 Subject: [PATCH] Rename master to main branch. refs https://github.com/csjx/realtime-data/issues/58 --- docs/_sources/user/user-guide.txt | 4 ++-- docs/source/user/user-guide.rst | 4 ++-- docs/user/manage-instruments/configuration/configure.md | 2 +- docs/user/user-guide.html | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/_sources/user/user-guide.txt b/docs/_sources/user/user-guide.txt index a71cb76..eef0bc7 100644 --- a/docs/_sources/user/user-guide.txt +++ b/docs/_sources/user/user-guide.txt @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/user/user-guide.rst b/docs/source/user/user-guide.rst index a71cb76..eef0bc7 100644 --- a/docs/source/user/user-guide.rst +++ b/docs/source/user/user-guide.rst @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/user/manage-instruments/configuration/configure.md b/docs/user/manage-instruments/configuration/configure.md index 14bfee0..8daf6c2 100644 --- a/docs/user/manage-instruments/configuration/configure.md +++ b/docs/user/manage-instruments/configuration/configure.md @@ -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 diff --git a/docs/user/user-guide.html b/docs/user/user-guide.html index 0e3f8ea..b01f696 100644 --- a/docs/user/user-guide.html +++ b/docs/user/user-guide.html @@ -200,7 +200,7 @@

1.1.3. Troubleshooting the DataTurbine

1.2. Managing the DataTurbine Instrument Drivers

-

Each instrument type in the water has a corresponding instrument driver used to connect it to the DataTurbine. For instance, for ADCPs, there’s a Java-based driver called ADCPSource, and for the CTDs, there’s a driver called CTDSource. PacIOOS nearshore instruments use a generic text-based driver called a SimpleTextSource which handles all delimited text-based data samples. Driver Source naming conventions can be found in the data management plan. The drivers are managed through a single shell script called manage-instruments. This script starts and stops drivers and archivers (see below).

+

Each instrument type in the water has a corresponding instrument driver used to connect it to the DataTurbine. For instance, for ADCPs, there’s a Java-based driver called ADCPSource, and for the CTDs, there’s a driver called CTDSource. PacIOOS nearshore instruments use a generic text-based driver called a SimpleTextSource which handles all delimited text-based data samples. Driver Source naming conventions can be found in the data management plan. The drivers are managed through a single shell script called manage-instruments. This script starts and stops drivers and archivers (see below).

1.2.1. Configuring Instrument Drivers

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.

@@ -367,7 +367,7 @@

1.2.1. Configuring Instrument Driversexample document.

+

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

1.2.2. Starting Instrument Drivers