NDTS Daemon Installation - Revision history

Mmaciejewski: /* Starting the Service */

2025-06-22T23:27:22Z

Starting the Service

← Older revision		Revision as of 23:27, 22 June 2025
Line 149:		Line 149:
	# highest_job_number=9999 # (override default)		# highest_job_number=9999 # (override default)
	</pre>		</pre>

	~~=== Starting the service ===~~
	The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. See the [[NDTS Daemon Operation\|NDTS Daemon Operation guide]] for more information on running and monitoring the Daemon<pre>
	~~sudo /sbin/service data-transport-daemon start~~
	~~sudo /sbin/service data-transport-daemon status~~
	~~</pre>~~
	~~If the Daemon configuration file is adjusted the daemon service should be restarted with <pre>sudo /sbin/service data-transport-daemon status</pre>~~

	=== Starting the Service ===		=== Starting the Service ===
Line 174:		Line 167:
	sudo systemctl restart data-transport-daemon		sudo systemctl restart data-transport-daemon
	</pre>		</pre>

			=== Restarting the Service ===
			If the Daemon configuration file is adjusted the daemon service should be restarted for the changes to take effect.

	=== Determining Which Command to Use ===		=== Determining Which Command to Use ===

Mmaciejewski: /* Starting the service */

2025-06-22T23:23:34Z

Starting the service

@@ Line 156: / Line 156: @@
 </pre>
 If the Daemon configuration file is adjusted the daemon service should be restarted with <pre>sudo /sbin/service data-transport-daemon status</pre>
 == Installed NDTS Files and Directory Structure ==

Lmorris at 19:50, 20 June 2025

2025-06-20T19:50:45Z

← Older revision		Revision as of 19:50, 20 June 2025
Line 10:		Line 10:
	# '''Workstation UUID''' (generated when the spectrometer was added)		# '''Workstation UUID''' (generated when the spectrometer was added)
	<mark>WARNING: If you are installing on Alma Linux make sure that the <code>'''chkconfig'''</code> package is installed before proceeding. Without this service package, the NDTS Workstation will not properly install or run on Alma.</mark>		<mark>WARNING: If you are installing on Alma Linux make sure that the <code>'''chkconfig'''</code> package is installed before proceeding. Without this service package, the NDTS Workstation will not properly install or run on Alma.</mark>

			===== [[Alma Linux 9.6 - Creating systemctl capability]] =====

	=== Installation Steps ===		=== Installation Steps ===
	<pre>		<pre>

Mmaciejewski at 20:04, 9 June 2025

2025-06-09T20:04:59Z

← Older revision		Revision as of 20:04, 9 June 2025
Line 1:		Line 1:
			{{NDTS_Navbox}}

	== NDTS Daemon & GUI Installation (Spectrometer Workstation) ==		== NDTS Daemon & GUI Installation (Spectrometer Workstation) ==
	The NDTS Daemon and GUI must be installed separately on each NAN connected spectrometer		The NDTS Daemon and GUI must be installed separately on each NAN connected spectrometer

Mmaciejewski: /* Configuration Parameters */

2025-06-09T17:19:20Z

Configuration Parameters

← Older revision		Revision as of 17:19, 9 June 2025
Line 99:		Line 99:
	\|No		\|No
	\|}		\|}
			'''''NOTE: <code>use_accounting=true</code> must be set for versions of TopSpin prior to 4.x'''''

	==== Log levels ====		==== Log levels ====

Mmaciejewski at 12:59, 4 June 2025

2025-06-04T12:59:44Z

← Older revision		Revision as of 12:59, 4 June 2025
Line 1:		Line 1:
	== ~~'''~~NDTS Daemon & GUI Installation (Spectrometer Workstation)~~'''~~ ==		== NDTS Daemon & GUI Installation (Spectrometer Workstation) ==
	The NDTS Daemon and GUI must be installed separately on each NAN connected spectrometer		The NDTS Daemon and GUI must be installed separately on each NAN connected spectrometer

Line 48:		Line 48:

	===== [[NDTS Daemon and GUI Update Example]] =====		===== [[NDTS Daemon and GUI Update Example]] =====
			== Configuring the Daemon ==

	== ~~'''~~Configuring the Daemon~~'''~~ ==
	The NDTS daemon reads its settings from a simple key/value dat file		The NDTS daemon reads its settings from a simple key/value dat file

Line 62:		Line 60:
	Changes take effect only after the daemon restarts (see below).		Changes take effect only after the daemon restarts (see below).

	=== ~~'''~~Configuration Parameters~~'''~~ ===		=== Configuration Parameters ===
	{\| class="wikitable"		{\| class="wikitable"
	! Parameter		! Parameter
Line 135:		Line 133:
	\|}		\|}

	=== ~~'''~~Example File~~'''~~ ===		=== Example File ===
	<pre>		<pre>
	gateway_ip_address=155.37.253.192		gateway_ip_address=155.37.253.192
Line 146:		Line 144:
	</pre>		</pre>

	=== ~~'''~~Starting the service~~'''~~ ===		=== Starting the service ===
	The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. See the [[NDTS Daemon Operation\|NDTS Daemon Operation guide]] for more information on running and monitoring the Daemon<pre>		The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. See the [[NDTS Daemon Operation\|NDTS Daemon Operation guide]] for more information on running and monitoring the Daemon<pre>
	sudo /sbin/service data-transport-daemon start		sudo /sbin/service data-transport-daemon start
Line 153:		Line 151:
	If the Daemon configuration file is adjusted the daemon service should be restarted with <pre>sudo /sbin/service data-transport-daemon status</pre>		If the Daemon configuration file is adjusted the daemon service should be restarted with <pre>sudo /sbin/service data-transport-daemon status</pre>

	== ~~'''~~Installed NDTS Files and Directory Structure~~'''~~ ==		== Installed NDTS Files and Directory Structure ==
	All daemon-related files reside under <code>/opt/nan-dtdaemon</code> (except the SysV service script).		All daemon-related files reside under <code>/opt/nan-dtdaemon</code> (except the SysV service script).
	Knowing where each file lives helps with troubleshooting, backups, and upgrades.		Knowing where each file lives helps with troubleshooting, backups, and upgrades.

	=== ~~'''~~Top-Level Executable and Service Script~~'''~~ ===		=== Top-Level Executable and Service Script ===
	{\| class="wikitable"		{\| class="wikitable"
	! Path !! Purpose		! Path !! Purpose
Line 166:		Line 164:
	\|}		\|}

	=== ~~'''~~User-Interface Scripts~~'''~~ ===		=== User-Interface Scripts ===
	{\| class="wikitable"		{\| class="wikitable"
	! File(s) !! Role		! File(s) !! Role
Line 177:		Line 175:
	\|}		\|}

	=== ~~'''~~Version Marker~~'''~~ ===		=== Version Marker ===
	<pre>/opt/nan-dtdaemon/running_workstation_version-X.Y.Z</pre>		<pre>/opt/nan-dtdaemon/running_workstation_version-X.Y.Z</pre>
	Filename contains the current daemon version; file body is the daemon start timestamp.		Filename contains the current daemon version; file body is the daemon start timestamp.

	=== ~~'''~~Logs~~'''~~ ===		=== Logs ===
	<pre>/opt/nan-dtdaemon/logs/</pre>		<pre>/opt/nan-dtdaemon/logs/</pre>
	* <code>nan-dtdaemon.log</code> – main runtime log		* <code>nan-dtdaemon.log</code> – main runtime log
	* <code>ndtd_audit.txt</code> – one line per processed experiment		* <code>ndtd_audit.txt</code> – one line per processed experiment

	=== ~~'''~~Data Directory~~'''~~ ===		=== Data Directory ===
	<pre>/opt/nan-dtdaemon/data/</pre>		<pre>/opt/nan-dtdaemon/data/</pre>
	{\| class="wikitable"		{\| class="wikitable"
Line 210:		Line 208:
	\|}		\|}

	=== ~~'''~~Spool Directory~~'''~~ ===		=== Spool Directory ===
	<pre>/opt/nan-dtdaemon/spool/</pre>		<pre>/opt/nan-dtdaemon/spool/</pre>
	Temporary copy of any acquisition that failed to reach the Gateway.		Temporary copy of any acquisition that failed to reach the Gateway.
	Daemon retries each spooled item at every heartbeat until sent.		Daemon retries each spooled item at every heartbeat until sent.

	=== ~~'''~~Summary Diagram~~'''~~ ===		=== Summary Diagram ===
	<pre>		<pre>
	/opt/nan-dtdaemon		/opt/nan-dtdaemon

Mmaciejewski at 19:31, 3 June 2025

2025-06-03T19:31:36Z

← Older revision		Revision as of 19:31, 3 June 2025
Line 42:		Line 42:
	sudo ./install.sh		sudo ./install.sh
	</pre>		</pre>

			=== Installation and Update Examples ===

			===== [[NDTS Daemon and GUI Install Example]] =====

			===== [[NDTS Daemon and GUI Update Example]] =====


	== '''Configuring the Daemon''' ==		== '''Configuring the Daemon''' ==

Mmaciejewski: /* Starting the service */

2025-06-03T19:00:27Z

Starting the service

← Older revision		Revision as of 19:00, 3 June 2025
Line 140:		Line 140:

	=== '''Starting the service''' ===		=== '''Starting the service''' ===
	The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. See<pre>		The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. See the [[NDTS Daemon Operation\|NDTS Daemon Operation guide]] for more information on running and monitoring the Daemon<pre>
	sudo /sbin/service data-transport-daemon start		sudo /sbin/service data-transport-daemon start
	sudo /sbin/service data-transport-daemon status		sudo /sbin/service data-transport-daemon status

Mmaciejewski at 18:58, 3 June 2025

2025-06-03T18:58:46Z

← Older revision		Revision as of 18:58, 3 June 2025
Line 140:		Line 140:

	=== '''Starting the service''' ===		=== '''Starting the service''' ===
	The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. Se<pre>		The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. See<pre>
	sudo /sbin/service data-transport-daemon start		sudo /sbin/service data-transport-daemon start
	sudo /sbin/service data-transport-daemon status		sudo /sbin/service data-transport-daemon status
	</pre>If the Daemon configuration file is adjusted the daemon service should be restarted with		</pre>
			If the Daemon configuration file is adjusted the daemon service should be restarted with <pre>sudo /sbin/service data-transport-daemon status</pre>

	~~sdf~~
	== '''Installed NDTS Files and Directory Structure''' ==		== '''Installed NDTS Files and Directory Structure''' ==
	All daemon-related files reside under <code>/opt/nan-dtdaemon</code> (except the SysV service script).		All daemon-related files reside under <code>/opt/nan-dtdaemon</code> (except the SysV service script).

Mmaciejewski at 18:57, 3 June 2025

2025-06-03T18:57:26Z

← Older revision		Revision as of 18:57, 3 June 2025
Line 139:		Line 139:
	</pre>		</pre>

	=== '''~~Managing~~ the ~~Daemon Service~~''' ===		=== '''Starting the service''' ===
	The daemon uses ~~'''~~SysV service scripts~~'''~~ for maximum compatibility		The daemon uses SysV service scripts for maximum compatibility and the system is designed to be running at all times. Se<pre>

	~~The~~ system is designed to be running at all times. ~~The NDTS GUI may be used to turn off data harvesting when needed. If the daemon must be existed, use the stop command below.~~

	~~Note that starting the daemon while it is running will not start a new instance and will not cause issues.~~
	<pre>
	sudo /sbin/service data-transport-daemon start		sudo /sbin/service data-transport-daemon start
	~~sudo /sbin/service data-transport-daemon stop~~
	~~sudo /sbin/service data-transport-daemon restart~~
	~~sudo /sbin/service data-transport-daemon status~~
	~~</pre>After adjusting the Daemon configuration file restart the daemon and verify the status<pre>~~
	~~sudo /sbin/service data-transport-daemon restart~~
	sudo /sbin/service data-transport-daemon status		sudo /sbin/service data-transport-daemon status
	</pre>		</pre>If the Daemon configuration file is adjusted the daemon service should be restarted with

	~~=== '''Log Files''' ===~~
	* Daemon ~~log: <pre>/opt/nan-dtdaemon/logs/nan-dtdaemon.log</pre>~~
	* Audit of processed experiments: <pre>/opt/nan-dtdaemon/logs/ndtd_audit.txt</pre>

			sdf
	== '''Installed NDTS Files and Directory Structure''' ==		== '''Installed NDTS Files and Directory Structure''' ==
	All daemon-related files reside under <code>/opt/nan-dtdaemon</code> (except the SysV service script).		All daemon-related files reside under <code>/opt/nan-dtdaemon</code> (except the SysV service script).