NDTS Installation: Difference between revisions

From Network for Advanced NMR
Jump to navigationJump to search
← Older edit
VisualWikitext
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
<span style="display:inline-block; margin-bottom:1em;">[[NAN Data Transport System|← Back to NAN Data Transport System Overview]]</span>
{{NDTS_Navbox}}


= Installing and Updating Daemon and Gateway =
== Installation Workflow ==


This page guides Facility Managers through installing, updating, uninstalling, and rolling back the two local NDTS components:
The typical installation and setup workflow consists of the following steps. See the NDTS User Guide Navigation for links to the various installation, configuration, and usage pages.


* '''Gateway''' – facility-level server that receives data from all workstations
* Install Gateway on dedicated gateway computer in NMR facility network
* '''Daemon''' – runs on every spectrometer workstation
* Configure Gateway
* Install NDTS Daemon and GUI on all spectrometer workstations
* Configure NDTS Daemon on the spectrometer workstations
* Monitor NDTS daemon and gateway (log files, Slack, and vNOC)
* User management through portal
** add NAN users to the facility
** map local workstation user to NAN user
** set default NDTS settings for each NAN user
** set default NDTS behavior for unassigned user
*[[Enabling TopSpin Accounting|Enable TopSpin accounting]] for TopSpin versions prior to TopSpin 4.x


Packages are provided as <code>.tar.gz</code> archives on the Facility Dashboard.
== How to Obtain Software ==


== '''Daemon Installation (Workstation)''' ==
Software packages are available from the NAN portal:


=== Prerequisites ===
https://usnan.nmrhub.org/facility/downloads
# '''Gateway IP address'''
# Exact '''Instrument Name''' (set in the Facility Dashboard – no spaces)
# '''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>
=== Installation Steps ===
<pre>
# Copy the .gz file to the workstation
tar xf data-transport-daemon.<distro>-<version>.tar.gz
cd dtdaemon-installer
sudo ./install.sh
# → Prompts:
#  • Gateway IP address
#  • Instrument name  (e.g., nmr600)
#  • Workstation UUID
</pre>
 
=== Updating the Daemon ===
<pre>
# Best practice: ensure no acquisition is running and the UI is closed
cd dtdaemon-installer
sudo ./install.sh              # updates binaries and restarts the daemon
</pre>
 
=== Uninstalling the Daemon ===
<pre>
# Download the latest installation package and execute uninstall.sh
sudo ./uninstall.sh
</pre>
 
=== Rolling Back the Daemon ===
<pre>
# The system is designed to allow roll-back to any previous version
# However, best practice would be to only roll-back one version in the event that a new version was causing issues.
# Download previous version and install
tar xf data-transport-daemon.<distro>-<old-version>.tar.gz
cd dtdaemon-installer
sudo ./install.sh
</pre>
 
== '''What’s Next?''' ==
* [[NDTS_Daemon_Configuration|Configuring the Daemon]]
* [[NDTS_Daemon_Operation|Running and Monitoring the Daemon]]

Latest revision as of 19:59, 9 June 2025

Installation Workflow

The typical installation and setup workflow consists of the following steps. See the NDTS User Guide Navigation for links to the various installation, configuration, and usage pages.

  • Install Gateway on dedicated gateway computer in NMR facility network
  • Configure Gateway
  • Install NDTS Daemon and GUI on all spectrometer workstations
  • Configure NDTS Daemon on the spectrometer workstations
  • Monitor NDTS daemon and gateway (log files, Slack, and vNOC)
  • User management through portal
    • add NAN users to the facility
    • map local workstation user to NAN user
    • set default NDTS settings for each NAN user
    • set default NDTS behavior for unassigned user
  • Enable TopSpin accounting for TopSpin versions prior to TopSpin 4.x

How to Obtain Software

Software packages are available from the NAN portal:

https://usnan.nmrhub.org/facility/downloads

Retrieved from "https://wiki.usnan.org/index.php?title=NDTS_Installation&oldid=733"