Network for Advanced NMR - User contributions [en]

How to search and download pulse programs

2026-02-27T15:11:36Z

Mmaciejewski:

{{DISPLAYTITLE:How do I search and download pulse programs"?}}
{{FAQReturn}}

[[File:Fig1 v2.png|thumb|935x935px|NAN Data Browser: You can sort and filter on Pulse Program name.]]
[[File:Fig2.png|thumb|765x765px|Dataset window: Supplemental data.]]

To find datasets collected with a specific pulse program, use the '''Pulse Program''' column filter in the Data Browser (Fig. 1). Choose '''All Datasets''', '''Knowledgebase Datasets''', or '''My & Lab Data''' from the hierarchal view on the left based on what datasets you want to search against. The '''Pulse Program''' filter supports several comparison options, such as '''Contains''', '''Equals''', and '''Starts with'''. This is useful depending on whether you know the exact pulse program name or are searching more broadly. For example, if you are looking for datasets acquired with a pulse program that contains “REDOR” in its name, enter '''REDOR''' in the column filter and choose '''Contains'''.

The pulse program used for an experiment is always included in the dataset folder. You can therefore download the full dataset and copy the pulse program file from it. To do this, open the dataset action menu by right-clicking the experiment and selecting '''Download''' from the list of available actions.

Some datasets also include '''Supplemental Data'''. The presence of Supplemental Data is indicated by the center icon in the '''Icons''' column in Fig. 1. One icon shows that Supplemental Data are available, while another indicates that an experimental protocol is associated with the dataset. Hover over the icon to see which types of Supplemental Data are linked to that dataset.

To view these files directly, double-click the experiment row to open the '''Dataset''' window (Fig. 2). Then click the '''View Supplemental Data''' button in the upper-right corner. This opens a pop-up window listing all Supplemental Data associated with the dataset. In some cases, the dataset creator may also upload additional pulse program files that are useful in the experimental setup. Clicking supplemental data that is file-based will automatically download the supplemental data file without the need to download and unpack the entire dataset.

How to search and download pulse programs

2026-02-27T15:11:24Z

Mmaciejewski:

{{DISPLAYTITLE:How do I search and download pulse programs"?}}
{{FAQReturn}}

hello

[[File:Fig1 v2.png|thumb|935x935px|NAN Data Browser: You can sort and filter on Pulse Program name.]]
[[File:Fig2.png|thumb|765x765px|Dataset window: Supplemental data.]]

To find datasets collected with a specific pulse program, use the '''Pulse Program''' column filter in the Data Browser (Fig. 1). Choose '''All Datasets''', '''Knowledgebase Datasets''', or '''My & Lab Data''' from the hierarchal view on the left based on what datasets you want to search against. The '''Pulse Program''' filter supports several comparison options, such as '''Contains''', '''Equals''', and '''Starts with'''. This is useful depending on whether you know the exact pulse program name or are searching more broadly. For example, if you are looking for datasets acquired with a pulse program that contains “REDOR” in its name, enter '''REDOR''' in the column filter and choose '''Contains'''.

The pulse program used for an experiment is always included in the dataset folder. You can therefore download the full dataset and copy the pulse program file from it. To do this, open the dataset action menu by right-clicking the experiment and selecting '''Download''' from the list of available actions.

Some datasets also include '''Supplemental Data'''. The presence of Supplemental Data is indicated by the center icon in the '''Icons''' column in Fig. 1. One icon shows that Supplemental Data are available, while another indicates that an experimental protocol is associated with the dataset. Hover over the icon to see which types of Supplemental Data are linked to that dataset.

To view these files directly, double-click the experiment row to open the '''Dataset''' window (Fig. 2). Then click the '''View Supplemental Data''' button in the upper-right corner. This opens a pop-up window listing all Supplemental Data associated with the dataset. In some cases, the dataset creator may also upload additional pulse program files that are useful in the experimental setup. Clicking supplemental data that is file-based will automatically download the supplemental data file without the need to download and unpack the entire dataset.

Frequently Asked Questions

2026-02-27T15:11:13Z

Mmaciejewski: /* Data Browser */

__NOTOC__
{{search}}


== Facility Dashboard ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[How to edit an instrument if the console or magnet have changed?|How do I edit an instrument if the console or magnet has changed?]]
</div>
</div>


== Data Browser ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
*[[How do I get access to NAN|How do I gain access to NAN (and to my datasets)?]]

* [[Why do my datasets not appear in the data browser?]]
* [[What is the difference between public and published datasets|What is the difference between public and published datasets?]]
* [[How to search and download pulse programs|How do I search and download pulse programs?]]
</div>
</div>



== NAN Data Transport System (NDTS) ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can I not select my NAN username from the NDTS GUI on the spectrometer?|Why can't I select my NAN username in the NDTS GUI?]]
* [[NAN GUI loses track of user|Why are datasets not associated with my NAN username even though my name is shown on the front of the NAN GUI?]]
* [[How do I suppress the harvesting of calibration experiments?]]
</div>
</div>


== UHF Access ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can't I create a New Request for UHF access?|Why can't I create a New Request for UHF Access?]]
</div>
</div>


== Mediahub ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[What is Mediahub?]]
</div>
</div>

[[Category:FAQ]]

Frequently Asked Questions

2026-02-27T15:09:56Z

Mmaciejewski: /* Data Browser */

__NOTOC__
{{search}}


== Facility Dashboard ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[How to edit an instrument if the console or magnet have changed?|How do I edit an instrument if the console or magnet has changed?]]
</div>
</div>


== Data Browser ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
*[[How do I get access to NAN|How do I gain access to NAN (and to my datasets)?]]

* [[Why do my datasets not appear in the data browser?]]
* [[What is the difference between public and published datasets|What is the difference between public and published datasets?]]
* [[How do I search and download pulse programs?|How do I search and download pulse programs?]]
</div>
</div>



== NAN Data Transport System (NDTS) ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can I not select my NAN username from the NDTS GUI on the spectrometer?|Why can't I select my NAN username in the NDTS GUI?]]
* [[NAN GUI loses track of user|Why are datasets not associated with my NAN username even though my name is shown on the front of the NAN GUI?]]
* [[How do I suppress the harvesting of calibration experiments?]]
</div>
</div>


== UHF Access ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can't I create a New Request for UHF access?|Why can't I create a New Request for UHF Access?]]
</div>
</div>


== Mediahub ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[What is Mediahub?]]
</div>
</div>

[[Category:FAQ]]

Frequently Asked Questions

2026-02-27T15:08:28Z

Mmaciejewski: /* Data Browser */

__NOTOC__
{{search}}


== Facility Dashboard ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[How to edit an instrument if the console or magnet have changed?|How do I edit an instrument if the console or magnet has changed?]]
</div>
</div>


== Data Browser ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
*[[How do I get access to NAN|How do I gain access to NAN (and to my datasets)?]]

* [[Why do my datasets not appear in the data browser?]]
* [[What is the difference between public and published datasets|What is the difference between public and published datasets?]]
* [[How to search and download pulse programs?|How do I search and download pulse programs?]]
</div>
</div>



== NAN Data Transport System (NDTS) ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can I not select my NAN username from the NDTS GUI on the spectrometer?|Why can't I select my NAN username in the NDTS GUI?]]
* [[NAN GUI loses track of user|Why are datasets not associated with my NAN username even though my name is shown on the front of the NAN GUI?]]
* [[How do I suppress the harvesting of calibration experiments?]]
</div>
</div>


== UHF Access ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can't I create a New Request for UHF access?|Why can't I create a New Request for UHF Access?]]
</div>
</div>


== Mediahub ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[What is Mediahub?]]
</div>
</div>

[[Category:FAQ]]

How to search and download pulse programs

2026-02-27T15:07:52Z

Mmaciejewski:

Search and download pulse programs?

2026-02-27T15:05:02Z

Mmaciejewski:

{{DISPLAYTITLE:How do I search and download pulse programs"?}}
{{FAQReturn}}

[[File:Fig1 v2.png|thumb|935x935px|NAN Data Browser: You can sort and filter on Pulse Program name.]]
[[File:Fig2.png|thumb|765x765px|Dataset window: Supplemental data.]]

To find datasets collected with a specific pulse program, use the '''Pulse Program''' column filter in the Data Browser (Fig. 1). Choose '''All Datasets''', '''Knowledgebase Datasets''', or '''My & Lab Data''' from the hierarchal view on the left based on what datasets you want to search against. The '''Pulse Program''' filter supports several comparison options, such as '''Contains''', '''Equals''', and '''Starts with'''. This is useful depending on whether you know the exact pulse program name or are searching more broadly. For example, if you are looking for datasets acquired with a pulse program that contains “REDOR” in its name, enter '''REDOR''' in the column filter and choose '''Contains'''.

The pulse program used for an experiment is always included in the dataset folder. You can therefore download the full dataset and copy the pulse program file from it. To do this, open the dataset action menu by right-clicking the experiment and selecting '''Download''' from the list of available actions.

Some datasets also include '''Supplemental Data'''. The presence of Supplemental Data is indicated by the center icon in the '''Icons''' column in Fig. 1. One icon shows that Supplemental Data are available, while another indicates that an experimental protocol is associated with the dataset. Hover over the icon to see which types of Supplemental Data are linked to that dataset. To view these files directly, double-click the experiment row to open the '''Dataset''' window (Fig. 2). Then click the '''View Supplemental Data''' button in the upper-right corner. This opens a pop-up window listing all Supplemental Data associated with the dataset. In some cases, the dataset creator may also upload additional pulse program files that are useful in the experimental setup. Clicking supplemental data that is file-based will automatically download the supplemental data file without the need to download and unpack the entire dataset.

Search and download pulse programs?

2026-02-27T14:58:48Z

Mmaciejewski:

{{DISPLAYTITLE:How do I search and download pulse programs"?}}
{{FAQReturn}}

[[File:Fig1 v2.png|thumb|935x935px|NAN Data Browser: You can sort and filter on Pulse Program name.]]
[[File:Fig2.png|thumb|765x765px|Dataset window: Supplemental data.]]

To find datasets collected with a specific pulse program, use the '''Pulse Program''' column filter (Fig. 1). The filter supports several comparison options, such as '''Contains''', '''Equals''', and '''Starts with'''. This is useful depending on whether you know the exact pulse program name or are searching more broadly. For example, if you are looking for datasets acquired with a pulse program that contains “REDOR” in its name, enter '''REDOR''' in the column filter and choose '''Contains'''.

The pulse program used for an experiment is always included in the dataset folder. You can therefore download the full dataset and copy the pulse program file from it. To do this, open the dataset action menu by right-clicking the experiment and selecting '''Download''' from the list of available actions.

Some datasets also include '''Supplemental Data'''. The presence of Supplemental Data is indicated by the center icon in the '''Icons''' column in Fig. 1. One icon shows that Supplemental Data are available, while another indicates that an experimental protocol is associated with the dataset. Hover over the icon to see which types of Supplemental Data are linked to that dataset.

To view these files directly, double-click the experiment row to open the '''Dataset''' window (Fig. 2). Then click the '''View Supplemental Data''' button in the upper-right corner. This opens a pop-up window listing all Supplemental Data associated with the dataset. In some cases, the dataset creator may also upload additional pulse program files there, allowing you to download them without downloading the entire dataset.

Search and download pulse programs?

2026-02-27T14:57:59Z

Mmaciejewski:

{{DISPLAYTITLE:How do I search and download pulse programs"?}}
{{FAQReturn}}

[[File:Fig1 v2.png|thumb|935x935px|NAN Data Browser: You can sort and filter on Pulse Program name.]]
[[File:Fig2.png|thumb|765x765px|Dataset window: Supplemental data.]]

To find datasets collected with a specific pulse program, use the '''Pulse Program''' column filter in ''Public Datasets'' (Fig. 1). The filter supports several comparison options, such as '''Contains''', '''Equals''', and '''Starts with'''. This is useful depending on whether you know the exact pulse program name or are searching more broadly. For example, if you are looking for datasets acquired with a pulse program that contains “REDOR” in its name, enter '''REDOR''' in the column filter and choose '''Contains'''.

The pulse program used for an experiment is always included in the dataset folder. You can therefore download the full dataset and copy the pulse program file from it. To do this, open the dataset action menu by right-clicking the experiment and selecting '''Download''' from the list of available actions.

Some datasets also include '''Supplemental Data'''. The presence of Supplemental Data is indicated by the center icon in the '''Icons''' column in Fig. 1. One icon shows that Supplemental Data are available, while another indicates that an experimental protocol is associated with the dataset. Hover over the icon to see which types of Supplemental Data are linked to that dataset.

To view these files directly, double-click the experiment row to open the '''Dataset''' window (Fig. 2). Then click the '''View Supplemental Data''' button in the upper-right corner. This opens a pop-up window listing all Supplemental Data associated with the dataset. In some cases, the dataset creator may also upload additional pulse program files there, allowing you to download them without downloading the entire dataset.

Search and download pulse programs?

2026-02-27T14:57:44Z

Mmaciejewski:

{{DISPLAYTITLE:How do I search and download pulse programs"?}}
{{FAQReturn}}

[[File:Fig1 v2.png|thumb|935x935px|NAN Data Browser: You can sort and filter on Pulse Program name.]]
[[File:Fig2.png|thumb|765x765px|Dataset window: Supplemental data.]]

'''To find datasets collected with a specific pulse program''', use the '''Pulse Program''' column filter in ''Public Datasets'' (Fig. 1). The filter supports several comparison options, such as '''Contains''', '''Equals''', and '''Starts with'''. This is useful depending on whether you know the exact pulse program name or are searching more broadly. For example, if you are looking for datasets acquired with a pulse program that contains “REDOR” in its name, enter '''REDOR''' in the column filter and choose '''Contains'''.

The pulse program used for an experiment is always included in the dataset folder. You can therefore download the full dataset and copy the pulse program file from it. To do this, open the dataset action menu by right-clicking the experiment and selecting '''Download''' from the list of available actions.

Some datasets also include '''Supplemental Data'''. The presence of Supplemental Data is indicated by the center icon in the '''Icons''' column in Fig. 1. One icon shows that Supplemental Data are available, while another indicates that an experimental protocol is associated with the dataset. Hover over the icon to see which types of Supplemental Data are linked to that dataset.

To view these files directly, double-click the experiment row to open the '''Dataset''' window (Fig. 2). Then click the '''View Supplemental Data''' button in the upper-right corner. This opens a pop-up window listing all Supplemental Data associated with the dataset. In some cases, the dataset creator may also upload additional pulse program files there, allowing you to download them without downloading the entire dataset.

Search and download pulse programs?

2026-02-27T14:49:59Z

Mmaciejewski: Created page with "{{DISPLAYTITLE:How do I search and download pulse programs"?}} {{FAQReturn}} NAN Data Browser: You can sort and filter on Pulse Program name. Dataset window: Supplemental data."

Frequently Asked Questions

2026-02-27T14:48:30Z

Mmaciejewski: /* Data Browser */

__NOTOC__
{{search}}


== Facility Dashboard ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[How to edit an instrument if the console or magnet have changed?|How do I edit an instrument if the console or magnet has changed?]]
</div>
</div>


== Data Browser ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
*[[How do I get access to NAN|How do I gain access to NAN (and to my datasets)?]]

* [[Why do my datasets not appear in the data browser?]]
* [[What is the difference between public and published datasets|What is the difference between public and published datasets?]]
* [[Search and download pulse programs?|How do I search and download pulse programs?]]
</div>
</div>


== NAN Data Transport System (NDTS) ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can I not select my NAN username from the NDTS GUI on the spectrometer?|Why can't I select my NAN username in the NDTS GUI?]]
* [[NAN GUI loses track of user|Why are datasets not associated with my NAN username even though my name is shown on the front of the NAN GUI?]]
* [[How do I suppress the harvesting of calibration experiments?]]
</div>
</div>


== UHF Access ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[Why can't I create a New Request for UHF access?|Why can't I create a New Request for UHF Access?]]
</div>
</div>


== Mediahub ==
<div class="mw-collapsible" style="margin-bottom: 1em;">
<div style="background: #f9f9f9; border: 1px solid #ccc; padding: 0.5em; border-radius: 6px;">
* [[What is Mediahub?]]
</div>
</div>

[[Category:FAQ]]

Template:SDK navigation

2025-10-07T20:05:34Z

Mmaciejewski:

USNAN Python SDK/Examples

2025-10-07T17:42:17Z

Mmaciejewski:

{{SDK_navigation}}
= '''Examples''' =

== '''Example 1: Facility Summary''' ==
<syntaxhighlight lang="python">
import usnan
client = usnan.USNANClient()

for fac in client.facilities.list():
print(f"Facility: {fac.long_name}")
for spec in fac.spectrometers:
print(f" - {spec.name} ({spec.field_strength_mhz} MHz)")
</syntaxhighlight>

== '''Example 2: Search for 2D KnowledgeBase Datasets''' ==
<syntaxhighlight lang="python">
search = (
usnan.models.SearchConfig(records=25)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
.add_filter("num_dimension", value=2, match_mode="equals")
)

for ds in client.datasets.search(search):
print(ds.id, ds.title)
</syntaxhighlight>

== '''Example 3: Download One Dataset''' ==
<syntaxhighlight lang="python">
ds = next(client.datasets.search(search))
client.datasets.download([ds.id], location="downloads/")
</syntaxhighlight>

== '''Example 4: Clear Cache and Handle Errors''' ==
<syntaxhighlight lang="python">
try:
client.datasets.get("not-an-int")
except TypeError as e:
print("Caught:", e)

client.clear_cache()
</syntaxhighlight>

USNAN Python SDK/API Reference

2025-10-07T17:41:59Z

Mmaciejewski:

{{SDK_navigation}}
= '''API Reference''' =

This section summarizes the main classes and methods exposed by the SDK.

== '''usnan.USNANClient''' ==
The central interface to the API.

'''Constructor:'''
<syntaxhighlight lang="python">
client = usnan.USNANClient(base_url=None, timeout=30, num_retries=3)
</syntaxhighlight>

'''Attributes:'''
* '''datasets''' – interface for dataset retrieval and search
* '''facilities''' – interface for facility data
* '''spectrometers''' – interface for spectrometer data
* '''probes''' – interface for probe metadata

== '''Datasets API''' ==
<syntaxhighlight lang="python">
ds = client.datasets.get(363067)
</syntaxhighlight>

Methods:
* '''get(id)''' – retrieve dataset by ID
* '''search(SearchConfig)''' – iterate over search results
* '''download(ids, location="path")''' – download datasets to a local folder

Dataset objects expose:
* '''id'''
* '''title'''
* '''experiment_name'''
* '''num_dimension'''
* '''spectrometer_identifier'''
* '''facility_identifier'''
* '''public_time'''

== '''Facilities API''' ==
<syntaxhighlight lang="python">
fac = client.facilities.get("UCHC-Mullen")
fac.spectrometers
fac.probes
</syntaxhighlight>

== '''SearchConfig''' ==
Defines dataset search criteria.

<syntaxhighlight lang="python">
cfg = usnan.models.SearchConfig(records=100)
cfg.add_filter("is_knowledgebase", value=True, match_mode="equals")
cfg.add_filter("num_dimension", value=3, match_mode="equals")
</syntaxhighlight>

Parameters:
* '''field''' – name of dataset attribute
* '''value''' – filter value
* '''match_mode''' – comparison type (equals, contains, greater, less)
* '''operator''' – logical combination (AND, OR)

USNAN Python SDK/Getting Started

2025-10-07T17:41:47Z

Mmaciejewski:

{{SDK_navigation}}
= '''Getting Started with the USNAN Python SDK''' =

== '''Creating a Client''' ==
The core entry point is the '''USNANClient''' class.

<syntaxhighlight lang="python">
import usnan
client = usnan.USNANClient()
</syntaxhighlight>

By default, it connects to the public API at:
<syntaxhighlight>
https://dev.api.nmrhub.org
</syntaxhighlight>

Optional parameters:
* '''base_url''' – override the API endpoint
* '''timeout''' – request timeout in seconds
* '''num_retries''' – automatic retry attempts

== '''Listing Facilities''' ==
<syntaxhighlight lang="python">
for fac in client.facilities.list():
print(fac.identifier, fac.long_name)
</syntaxhighlight>

Each facility exposes linked spectrometers and probes.

== '''Searching for Datasets''' ==
<syntaxhighlight lang="python">
cfg = (
usnan.models.SearchConfig(records=50)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
.add_filter("num_dimension", value=2, match_mode="equals")
)

for ds in client.datasets.search(cfg):
print(ds.id, ds.title, ds.num_dimension)
</syntaxhighlight>

== '''Downloading Datasets''' ==
<syntaxhighlight lang="python">
client.datasets.download([363067], location="data/")
</syntaxhighlight>

Files are stored in a directory structure mirroring dataset identifiers.

== '''Caching and Error Handling''' ==
The SDK caches facilities, spectrometers, and probes for efficiency.
To refresh the cache:

<syntaxhighlight lang="python">
client.clear_cache()
</syntaxhighlight>

Common exceptions:
* '''TypeError''' – invalid argument types
* '''KeyError''' – missing entity ID
* '''ValueError''' – inconsistent filter operators

Template:SDK navigation

2025-10-07T17:41:00Z

Mmaciejewski:

Template:SDK navigation

2025-10-07T17:38:00Z

Mmaciejewski:

<div style="border:1px solid #aaa; padding: 1em; width: 350px; background:#F9F9F9; float:right; clear:right; margin:1em;">
<div style="font-size: 1.4em; font-weight: bold; margin-bottom: 0.5em;">USNAN Python SDK Navigation</div>
<ul>
<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">USNAN Python SDK</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK|SDK Overview]]</span></li>

<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">Getting Started</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/Getting_Started|Installation and Setup]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/Examples|Example Usage]]</span></li>
</ul>
</li>

<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">API Reference</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference|Class Reference]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference#Datasets_API|Datasets API]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference#Facilities_API|Facilities API]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference#SearchConfig|SearchConfig]]</span></li>
</ul>
</li>

<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">External Resources</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[https://github.com/NanNMR/PythonSDK GitHub Repository]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[https://pythonsdk.readthedocs.io/en/latest/ Read the Docs]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN Data Browser|Web Data Browser]]</span></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>

Template:SDK navigation

2025-10-07T17:36:21Z

Mmaciejewski:

<div style="border:1px solid #aaa; padding: 1em; width: 350px; background:#F9F9F9; float:right; clear:right; margin:1em;">
<div style="font-size: 1.4em; font-weight: bold; margin-bottom: 0.5em;">Navigation of USNAN SDK Documentation</div>
<ul>
<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">USNAN Python SDK</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK|SDK Overview]]</span></li>

<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">Getting Started</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/Getting_Started|Installation and Setup]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/Examples|Example Usage]]</span></li>
</ul>
</li>

<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">API Reference</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference|Class Reference]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference#Datasets_API|Datasets API]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference#Facilities_API|Facilities API]]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN_Python_SDK/API_Reference#SearchConfig|SearchConfig]]</span></li>
</ul>
</li>

<li><span style="font-size: 1.2em; font-weight: bold; font-style: italic;">External Resources</span>
<ul>
<li><span style="font-weight: normal; font-size: 1.0em;">[https://github.com/NanNMR/PythonSDK GitHub Repository]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[https://pythonsdk.readthedocs.io/en/latest/ Read the Docs]</span></li>
<li><span style="font-weight: normal; font-size: 1.0em;">[[USNAN Data Browser|Web Data Browser]]</span></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>

USNAN Python SDK

2025-10-07T17:34:38Z

Mmaciejewski:

{{SDK_navigation}}
= '''USNAN Python SDK''' =

The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources.

This SDK complements the [[Data_Browser]] and other web tools available through the USNAN web portal, offering a scripting interface for automation, reproducibility, and integration into computational workflows.

== '''Overview''' ==
The SDK wraps the RESTful API available at https://api.nmrhub.org/ and provides convenient Python classes for accessing:
* Datasets
* Facilities
* Spectrometers
* Probes
* Knowledgebase (KB) records

The SDK performs lazy fetching of linked objects, provides caching for repeated queries, and includes methods for dataset download and filtering.

== '''Installation''' ==
The SDK is available from PyPI.

<syntaxhighlight lang="bash">
pip install usnan
</syntaxhighlight>

or install directly from GitHub for the latest version:

<syntaxhighlight lang="bash">
pip install git+https://github.com/NanNMR/PythonSDK.git
</syntaxhighlight>

== '''Quick Start''' ==
<syntaxhighlight lang="python">
import usnan

client = usnan.USNANClient()

# Get facility information
mullen = client.facilities.get("UCHC-Mullen")
print(mullen.long_name)

# Search datasets
search = (
usnan.models.SearchConfig(records=10)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
)
for ds in client.datasets.search(search):
print(ds.id, ds.title)

# Download a dataset
client.datasets.download([ds.id for ds in client.datasets.search(search)], location="downloads")
</syntaxhighlight>

== '''Links''' ==
* [[USNAN_Python_SDK/Getting_Started|Getting Started]]
* [[USNAN_Python_SDK/API_Reference|API Reference]]
* [[USNAN_Python_SDK/Examples|Examples]]
* [https://github.com/NanNMR/PythonSDK GitHub Repository]
* [https://pythonsdk.readthedocs.io/en/latest/ Read the Docs Documentation]

== '''License''' ==
The SDK is released under the MIT License.

== '''Contact''' ==
For questions, please contact the USNAN development team at support@usnan.org.

USNAN Python SDK

2025-10-07T17:34:10Z

Mmaciejewski:

{{USNAN_SDK_Navbox}}
= '''USNAN Python SDK''' =

The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources.

This SDK complements the [[Data_Browser]] and other web tools available through the USNAN web portal, offering a scripting interface for automation, reproducibility, and integration into computational workflows.

== '''Overview''' ==
The SDK wraps the RESTful API available at https://api.nmrhub.org/ and provides convenient Python classes for accessing:
* Datasets
* Facilities
* Spectrometers
* Probes
* Knowledgebase (KB) records

The SDK performs lazy fetching of linked objects, provides caching for repeated queries, and includes methods for dataset download and filtering.

== '''Installation''' ==
The SDK is available from PyPI.

<syntaxhighlight lang="bash">
pip install usnan
</syntaxhighlight>

or install directly from GitHub for the latest version:

<syntaxhighlight lang="bash">
pip install git+https://github.com/NanNMR/PythonSDK.git
</syntaxhighlight>

== '''Quick Start''' ==
<syntaxhighlight lang="python">
import usnan

client = usnan.USNANClient()

# Get facility information
mullen = client.facilities.get("UCHC-Mullen")
print(mullen.long_name)

# Search datasets
search = (
usnan.models.SearchConfig(records=10)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
)
for ds in client.datasets.search(search):
print(ds.id, ds.title)

# Download a dataset
client.datasets.download([ds.id for ds in client.datasets.search(search)], location="downloads")
</syntaxhighlight>

== '''Links''' ==
* [[USNAN_Python_SDK/Getting_Started|Getting Started]]
* [[USNAN_Python_SDK/API_Reference|API Reference]]
* [[USNAN_Python_SDK/Examples|Examples]]
* [https://github.com/NanNMR/PythonSDK GitHub Repository]
* [https://pythonsdk.readthedocs.io/en/latest/ Read the Docs Documentation]

== '''License''' ==
The SDK is released under the MIT License.

== '''Contact''' ==
For questions, please contact the USNAN development team at support@usnan.org.

Template:SDK navigation

2025-10-07T17:32:58Z

Mmaciejewski: Created page with " {{Navbox | name = USNAN_SDK_Navbox | title = '''USNAN Python SDK''' | state = autocollapse | bodyclass = hlist | above = Main SDK page | group1 = Getting started | list1 = Install & Setup • Examples | group2 = API reference | list2 = Client & Models • Datasets..."

{{Navbox
| name = USNAN_SDK_Navbox
| title = '''USNAN Python SDK'''
| state = autocollapse
| bodyclass = hlist
| above = [[USNAN_Python_SDK|Main SDK page]]

| group1 = Getting started
| list1 = [[USNAN_Python_SDK/Getting_Started|Install & Setup]] • [[USNAN_Python_SDK/Examples|Examples]]

| group2 = API reference
| list2 = [[USNAN_Python_SDK/API_Reference|Client & Models]] • [[USNAN_Python_SDK/API_Reference#Datasets_API|Datasets]] • [[USNAN_Python_SDK/API_Reference#Facilities_API|Facilities]] • [[USNAN_Python_SDK/API_Reference#SearchConfig|SearchConfig]]

| group3 = Resources
| list3 = [https://github.com/NanNMR/PythonSDK GitHub] • [https://pythonsdk.readthedocs.io/en/latest/ Read the Docs] • [[USNAN Data Browser]]
}}

USNAN Python SDK/Examples

2025-10-07T17:31:00Z

Mmaciejewski: Created page with "= '''Examples''' = == '''Example 1: Facility Summary''' == <syntaxhighlight lang="python"> import usnan client = usnan.USNANClient() for fac in client.facilities.list(): print(f"Facility: {fac.long_name}") for spec in fac.spectrometers: print(f" - {spec.name} ({spec.field_strength_mhz} MHz)") </syntaxhighlight> == '''Example 2: Search for 2D KnowledgeBase Datasets''' == <syntaxhighlight lang="python"> search = ( usnan.models.SearchConfig(records=2..."

= '''Examples''' =

== '''Example 1: Facility Summary''' ==
<syntaxhighlight lang="python">
import usnan
client = usnan.USNANClient()

for fac in client.facilities.list():
print(f"Facility: {fac.long_name}")
for spec in fac.spectrometers:
print(f" - {spec.name} ({spec.field_strength_mhz} MHz)")
</syntaxhighlight>

== '''Example 2: Search for 2D KnowledgeBase Datasets''' ==
<syntaxhighlight lang="python">
search = (
usnan.models.SearchConfig(records=25)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
.add_filter("num_dimension", value=2, match_mode="equals")
)

for ds in client.datasets.search(search):
print(ds.id, ds.title)
</syntaxhighlight>

== '''Example 3: Download One Dataset''' ==
<syntaxhighlight lang="python">
ds = next(client.datasets.search(search))
client.datasets.download([ds.id], location="downloads/")
</syntaxhighlight>

== '''Example 4: Clear Cache and Handle Errors''' ==
<syntaxhighlight lang="python">
try:
client.datasets.get("not-an-int")
except TypeError as e:
print("Caught:", e)

client.clear_cache()
</syntaxhighlight>

USNAN Python SDK/API Reference

2025-10-07T17:30:21Z

Mmaciejewski: Created page with "= '''API Reference''' = This section summarizes the main classes and methods exposed by the SDK. == '''usnan.USNANClient''' == The central interface to the API. '''Constructor:''' <syntaxhighlight lang="python"> client = usnan.USNANClient(base_url=None, timeout=30, num_retries=3) </syntaxhighlight> '''Attributes:''' * '''datasets''' – interface for dataset retrieval and search * '''facilities''' – interface for facility data * '''spectrometers''' – interface fo..."

= '''API Reference''' =

This section summarizes the main classes and methods exposed by the SDK.

== '''usnan.USNANClient''' ==
The central interface to the API.

'''Constructor:'''
<syntaxhighlight lang="python">
client = usnan.USNANClient(base_url=None, timeout=30, num_retries=3)
</syntaxhighlight>

'''Attributes:'''
* '''datasets''' – interface for dataset retrieval and search
* '''facilities''' – interface for facility data
* '''spectrometers''' – interface for spectrometer data
* '''probes''' – interface for probe metadata

== '''Datasets API''' ==
<syntaxhighlight lang="python">
ds = client.datasets.get(363067)
</syntaxhighlight>

Methods:
* '''get(id)''' – retrieve dataset by ID
* '''search(SearchConfig)''' – iterate over search results
* '''download(ids, location="path")''' – download datasets to a local folder

Dataset objects expose:
* '''id'''
* '''title'''
* '''experiment_name'''
* '''num_dimension'''
* '''spectrometer_identifier'''
* '''facility_identifier'''
* '''public_time'''

== '''Facilities API''' ==
<syntaxhighlight lang="python">
fac = client.facilities.get("UCHC-Mullen")
fac.spectrometers
fac.probes
</syntaxhighlight>

== '''SearchConfig''' ==
Defines dataset search criteria.

<syntaxhighlight lang="python">
cfg = usnan.models.SearchConfig(records=100)
cfg.add_filter("is_knowledgebase", value=True, match_mode="equals")
cfg.add_filter("num_dimension", value=3, match_mode="equals")
</syntaxhighlight>

Parameters:
* '''field''' – name of dataset attribute
* '''value''' – filter value
* '''match_mode''' – comparison type (equals, contains, greater, less)
* '''operator''' – logical combination (AND, OR)

USNAN Python SDK/Getting Started

2025-10-07T17:28:03Z

Mmaciejewski: Created page with "= '''Getting Started with the USNAN Python SDK''' = == '''Creating a Client''' == The core entry point is the '''USNANClient''' class. <syntaxhighlight lang="python"> import usnan client = usnan.USNANClient() </syntaxhighlight> By default, it connects to the public API at: <syntaxhighlight> https://dev.api.nmrhub.org </syntaxhighlight> Optional parameters: * '''base_url''' – override the API endpoint * '''timeout''' – request timeout in seconds * '''num_retries''..."

= '''Getting Started with the USNAN Python SDK''' =

== '''Creating a Client''' ==
The core entry point is the '''USNANClient''' class.

<syntaxhighlight lang="python">
import usnan
client = usnan.USNANClient()
</syntaxhighlight>

By default, it connects to the public API at:
<syntaxhighlight>
https://dev.api.nmrhub.org
</syntaxhighlight>

Optional parameters:
* '''base_url''' – override the API endpoint
* '''timeout''' – request timeout in seconds
* '''num_retries''' – automatic retry attempts

== '''Listing Facilities''' ==
<syntaxhighlight lang="python">
for fac in client.facilities.list():
print(fac.identifier, fac.long_name)
</syntaxhighlight>

Each facility exposes linked spectrometers and probes.

== '''Searching for Datasets''' ==
<syntaxhighlight lang="python">
cfg = (
usnan.models.SearchConfig(records=50)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
.add_filter("num_dimension", value=2, match_mode="equals")
)

for ds in client.datasets.search(cfg):
print(ds.id, ds.title, ds.num_dimension)
</syntaxhighlight>

== '''Downloading Datasets''' ==
<syntaxhighlight lang="python">
client.datasets.download([363067], location="data/")
</syntaxhighlight>

Files are stored in a directory structure mirroring dataset identifiers.

== '''Caching and Error Handling''' ==
The SDK caches facilities, spectrometers, and probes for efficiency.
To refresh the cache:

<syntaxhighlight lang="python">
client.clear_cache()
</syntaxhighlight>

Common exceptions:
* '''TypeError''' – invalid argument types
* '''KeyError''' – missing entity ID
* '''ValueError''' – inconsistent filter operators

USNAN Python SDK

2025-10-07T17:26:05Z

Mmaciejewski:

= '''USNAN Python SDK''' =

The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources.

This SDK complements the [[Data_Browser]] and other web tools available through the USNAN web portal, offering a scripting interface for automation, reproducibility, and integration into computational workflows.

== '''Overview''' ==
The SDK wraps the RESTful API available at https://api.nmrhub.org/ and provides convenient Python classes for accessing:
* Datasets
* Facilities
* Spectrometers
* Probes
* Knowledgebase (KB) records

The SDK performs lazy fetching of linked objects, provides caching for repeated queries, and includes methods for dataset download and filtering.

== '''Installation''' ==
The SDK is available from PyPI.

<syntaxhighlight lang="bash">
pip install usnan
</syntaxhighlight>

or install directly from GitHub for the latest version:

<syntaxhighlight lang="bash">
pip install git+https://github.com/NanNMR/PythonSDK.git
</syntaxhighlight>

== '''Quick Start''' ==
<syntaxhighlight lang="python">
import usnan

client = usnan.USNANClient()

# Get facility information
mullen = client.facilities.get("UCHC-Mullen")
print(mullen.long_name)

# Search datasets
search = (
usnan.models.SearchConfig(records=10)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
)
for ds in client.datasets.search(search):
print(ds.id, ds.title)

# Download a dataset
client.datasets.download([ds.id for ds in client.datasets.search(search)], location="downloads")
</syntaxhighlight>

== '''Links''' ==
* [[USNAN_Python_SDK/Getting_Started|Getting Started]]
* [[USNAN_Python_SDK/API_Reference|API Reference]]
* [[USNAN_Python_SDK/Examples|Examples]]
* [https://github.com/NanNMR/PythonSDK GitHub Repository]
* [https://pythonsdk.readthedocs.io/en/latest/ Read the Docs Documentation]

== '''License''' ==
The SDK is released under the MIT License.

== '''Contact''' ==
For questions, please contact the USNAN development team at support@usnan.org.

USNAN Python SDK

2025-10-07T17:22:22Z

Mmaciejewski: Created page with "= '''USNAN Python SDK''' = The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources. This SDK complements the USNAN Data Browser and other web tools available through the USNAN web portal, offering a scripting interface for automation, rep..."

= '''USNAN Python SDK''' =

The '''USNAN Python SDK''' provides programmatic access to data and metadata from the USNAN Network API. It enables researchers to discover, query, and download datasets, as well as navigate between related entities such as facilities, spectrometers, probes, and knowledgebase resources.

This SDK complements the [[USNAN Data Browser]] and other web tools available through the USNAN web portal, offering a scripting interface for automation, reproducibility, and integration into computational workflows.

== '''Overview''' ==
The SDK wraps the RESTful API available at https://api.nmrhub.org/ and provides convenient Python classes for accessing:
* Datasets
* Facilities
* Spectrometers
* Probes
* Knowledgebase (KB) records

The SDK performs lazy fetching of linked objects, provides caching for repeated queries, and includes methods for dataset download and filtering.

== '''Installation''' ==
The SDK is available from PyPI.

<syntaxhighlight lang="bash">
pip install usnan
</syntaxhighlight>

or install directly from GitHub for the latest version:

<syntaxhighlight lang="bash">
pip install git+https://github.com/NanNMR/PythonSDK.git
</syntaxhighlight>

== '''Quick Start''' ==
<syntaxhighlight lang="python">
import usnan

client = usnan.USNANClient()

# Get facility information
mullen = client.facilities.get("UCHC-Mullen")
print(mullen.long_name)

# Search datasets
search = (
usnan.models.SearchConfig(records=10)
.add_filter("is_knowledgebase", value=True, match_mode="equals")
)
for ds in client.datasets.search(search):
print(ds.id, ds.title)

# Download a dataset
client.datasets.download([ds.id for ds in client.datasets.search(search)], location="downloads")
</syntaxhighlight>

== '''Links''' ==
* [[USNAN_Python_SDK/Getting_Started|Getting Started]]
* [[USNAN_Python_SDK/API_Reference|API Reference]]
* [[USNAN_Python_SDK/Examples|Examples]]
* [https://github.com/NanNMR/PythonSDK GitHub Repository]
* [https://pythonsdk.readthedocs.io/en/latest/ Read the Docs Documentation]

== '''License''' ==
The SDK is released under the MIT License.

== '''Contact''' ==
For questions, please contact the USNAN development team at support@usnan.org.

Main Page

2025-10-07T17:21:26Z

Mmaciejewski:

{{DISPLAYTITLE:User Documentation for the Network of Advanced NMR (NAN)}}
{{search}}
__NOTOC__
<div class="nan-box" style="border: 2px solid #444; background: #F5FAFF; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #CEDFF2; color: black; padding: 10px; margin: 0;">What is NAN?</h2>
[https://usnan.org NAN] is a collaborative initiative to develop and operate a shared distributed resource for nuclear magnetic resonance (NMR) with the goal of democratizing NMR, making it more accessible and efficient for applications in biology, chemistry, materials science and other fields, and to foster good data stewardship practices. NAN was established by an NSF midscale (RI2) grant to [https://health.uconn.edu/ UConn Health], [https://www.uga.edu/ UGA], and [https://www.wisc.edu/ UW-Madison]. NAN offers open-access to two 1.1 GHz NMR instruments specialized for solids (UW-Madison) and solutions (UGA), along with a roster of additional NMR instruments at participating facilities which may be discovered through the web portal. Beginning in July 2025, membership in NAN is widened to encompass additional NMR facilities beyond the initial three facilities.

NAN provides a suite of '''[[Knowledgebases]] (KBs)''' in Bio Solids, Material Solids, Bio Solutions, and Metabolomics that comprehensively guide novice and expert users through discovering how NMR may be utilized to study interesting scientific problems as well as KB datasets with all the resources needed to recapitulate those experiments. NAN member nodes help to contribute additional KB content and new KB datasets.

Portal dashboards provide tools for (1) facility staff to manage facility, instrument, and probe information, as well as manage facility users, (2) PIs to create projects and manage lab members, and (3) a virtual Network Operations Center (vNOC) for monitoring NAN.

A distinguishing feature of NAN is the '''[[NAN Data Transport System|NAN Data Transport System (NDTS)]]''' [[NAN Data Transport System|a]]<nowiki/>nd [[Data Browser|'''Data Browsers''']]. NDTS automatically harvests experimental data and archives it into the [[NAN Archive|'''NAN Archive''']]. Datasets are linked with rich metadata such as instrument, parameters, user, project, sample, and other information. Users view and manipulate data in an advanced Data Browser where they can edit experiments, add notes, classify experiments, and organize data into projects, studies, and collections. PIs are stewards of data collected in their lab and control access. Users can create detailed sample records and link samples with datasets.

For a full breakdown of capabilities across the portal, see the '''[[Feature Summary]].'''

'''Interested in having your NMR facility join as a NAN node? Checkout the [[Joining NAN|Joining NAN page]] for more information.'''
</div>

<div class="nan-box" style="border: 2px solid #444; background: #EEF5E8; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #B3D1A7; color: black; padding: 10px; margin: 0;">NAN Portal Resources</h2>[[File:Menu-bar.png|thumb|Collapsible menu bar|229x229px]]<p style="margin: 0; padding: 10px 0;">The [https://usnan.org '''NAN portal'''] is composed of a '''Resource Connector''' which is accessible publicly as well as pages requiring an NMRhub account for access. See the [[Creating an Account]] page for how to create an account and the [[User Roles and Permissions]] page for a full list of user roles. The NAN Resources for authenticated users are itemized in a collapsible menu on the left hand side of the web-portal and organized as follows:</p>
* '''[[Resource Connector]]''' (publicly accessible content)
** '''[[Facilities]]''' (list of facility nodes connected to NAN with details such as a description, contacts, addresses, instruments, and services)
** '''Instruments''' (list of instruments from the facility nodes that are a part of the NAN Network)
** '''[[Knowledgebases]]'''
*** [[Knowledgebases for Non-Experts|'''Knowledgebases for non-Experts''']] (concise overviews for newcomers that explain how NMR can address specific research questions, with links to related literature vignettes and Expert KBs)
*** [[Knowledgebase Datasets|'''Knowledgebase Datasets''']] (exemplar datasets with step-by-step protocols and/or analysis scripts that cover sample preparation, experimental setup, signal processing, and data analysis)
*** [[Materials Periodic Table|'''Materials Periodic Table''']] (interactive periodic table to explore the feasibility of utilizing NMR in materials science)
** [[Vignette Library|'''Vignette Library''']] (brief synopses of peer-reviewed studies where NMR played a key role, helping novice users appreciate the technique’s utility and a place to "advertise" publications utilizing NMR)
** [[Public and Publishing|'''Public & Published''']] datasets and collections
* [[Facility Dashboards|'''Facility Dashboards''']] (only visible / accessible by NMR facility managers and staff and used to enter facility and instrument information as well as management of NDTS user settings)
* '''Operations Dashboards'''
* [[Data Browser|'''Data Browsers''']] (accessible to authenticated NMRhub users for viewing datasets, samples, collections, and their permissions)
* [[UHF Access|'''UHF Access''']] (accessible to authenticated NMRhub users to request access to ultra-high-field (UHF) instruments including two 1.1 GHz NAN spectrometers at NMRAM (solids) and CCRC (solutions)
* [[Lab Administration|'''Lab Administration''']] (accessible by PIs and PI delegates to manage lab members, permissions, projects, and funding)
* [[USNAN Python SDK|'''USNAN Python SDK''']] (provides programmatic access to public data and metadata from the USNAN Network API)<br/>
</div>

<div class="nan-box" style="border: 2px solid #444; background: #F3EEFA; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #C8B9EC; color: black; padding: 10px; margin: 0;">NAN Data Transport System (NDTS)</h2>
<p style="margin: 0; padding: 10px 0;">
NDTS is a system for automatically harvesting data from NAN connected spectrometers to the central NAN archive. NDTS is comprised of a Daemon and lightweight GUI installed on the spectrometer workstations, Gateway software running on a dedicated computer within the NMR facility, and a Receiver and Parser running within the NAN datacenter. NMR facility staff manage the NDTS settings for users through the NAN portal and can adjust NDTS settings through configuration files. Harvested datasets are viewable in the Dataset Browser by those with proper permissions set by PIs as well as facility managers have access to all data collected in their facility.
</p>
<p style="margin: 0; padding: 0px 0;">
See the [[NAN Data Transport System|'''NDTS Documentation''']] for detailed information on NDTS installation, configuration, usage, troubleshooting, and detailed explanation on how NDTS functions.
</p>
</div>

<div class="nan-box" style="border: 2px solid #444; background: #FFF5E5; padding: 10px;">
<h2 class="nan-title" style="background: #FFC266; color: black; padding: 10px; margin: 0;">Help & Support</h2>

==== Support Tickets ====
Support tickets may be created from within the NAN Portal by:

* Selecting the NMRhub widget in the top right corner of all NAN portal pages. From the widget enter your ''Email Address'' (only needed if not logged in with an NMRhub account), enter your ''Message'', and selecting ''Submit''.
** This is the preferred method as it allows us to track the page where you are having issues.
* Support tickets may also be generated by sending an email to [mailto:support@usnan.org support@usnan.org]

==== [[Frequently Asked Questions|FAQ]] ====
A FAQ page on this wiki provides answers to frequently asked questions

==== Wiki Documentation ====
This wiki provides the written documentation for the NAN portal and NDTS. It is intended to be community driven and any NMRhub user may login using the ''login'' link in the upper right hand corner to make edits or create new pages.
</div>

NAN Terminology

2025-08-17T20:30:01Z

Mmaciejewski:

{| class="wikitable sortable"
! Term !! Definition !! Component
|-
| '''Arbitrary Data''' || Files transferred via NDTS through the portals data browser. Datasets are processed through the parser in the same manner as standard harvested datasets || NDTS
|-
| '''Collection''' || User-defined or automatic grouping of datasets or samples for presentation, sharing, publishing, or bulk download || Data Browser
|-
| '''Collection Browser''' || Interface for exploring user-defined or automatic dataset and sample collections || Data Browser
|-
| '''Data Browser''' || Suite of Dashboard (Datasets, Samples, Collections, My Permissions) for searching, filtering, and exploring data and more viewing user permissions || Data Browser
|-
| '''Dataset''' || A dataset harvested from an NMR spectrometer or uploaded through the arbitrary data feature || NDTS
|-
| '''Dataset Browser''' || Dashboard within the Data Browser focused on searching and filtering datasets || Data Browser
|-
| '''Daemon''' || NDTS workstation process that detects finished experiments, bundles metadata, and forwards data to the Gateway || NDTS
|-
| '''Facility Dashboard''' || Privileged interface for facility staff to manage facility and instrument metadata, users, and NDTS settings || Facility Dashboard
|-
| '''Gateway''' || NDTS computer inside each facility that aggregates data from Daemons and relays it to the central Receiver || NDTS
|-
| '''Knowledgebase Datasets''' || Fully vetted experimental datasets with pulse programs, parameters, and processing scripts linked from KB pages || Knowledgebases
|-
| '''Knowledgebases (KBs)''' || Curated educational content (novice KBs, datasets, isotope pages, vignettes) showing how NMR solves scientific problems || Knowledgebases
|-
| '''Lab Administration''' || PI-only dashboard for managing lab members, projects, funding sources, and permissions || Lab Administration
|-
| '''Materials Periodic Table''' || Interactive periodic table highlighting NMR-active isotopes and their properties, with links to isotope KB content || Knowledgebases
|-
| '''NAN''' || Network for Advanced NMR — a collaborative initiative that democratizes access to NMR resources including UHF instruments, access to Knowledgebases, and provides data stewardship through NDTS and the Data Browser || NAN
|-
| '''NAN Archive''' || Backend archive where NAN data reside (PostgreSQL metadata database, object storage, and disaster-recovery replicas) || NAN Archive
|-
| '''NAN User''' || Authenticated account on the NAN portal with access to resources according to permissions. There is no difference between a NAN user, a NMRbox user, or a NMRhub user - they are terms for the same account || Identity
|-
| '''NDTS''' || NAN Data Transport System — automated pipeline (Daemon → Gateway → Receiver → Parser) that harvests experimental data from spectrometers (or arbitrary upload) and loads it into the NAN archive || NDTS
|-
| '''NDTS GUI''' || GUI on the NMR spectrometer showing the status of NDTS and allows the user to change harvesting status, change NAN user, and enter experimental metadata || NDTS
|-
| '''NMRbox User''' || Authenticated account on the NMRbox platform with access to resources according to permissions. There is no difference between a NAN user, a NMRbox user, or a NMRhub user - they are terms for the same account || Identity & permissions
|-
|'''NMRhub User'''
|Authenticated account for NAN or NMRbox. There is no difference between a NAN user, a NMRbox user, or a NMRhub user - they are terms for the same account
|Identity
|-
| '''Parser''' || NDTS service that extracts metadata, writes database entries, and stores datasets to primary and disaster-recovery storage || NDTS
|-
| '''PI Delegate''' || Lab member designated by a PI to perform actions as the PI to manage Projects, users and Lab permissions || Lab Administration
|-
|'''Preferred Dataset'''
|A dataset from a collection of redundant datasets that is marked as the Preferred dataset. Generally, it is the most recently collected dataset of the redundant collection, but is selectable by the user
|Data Browser
|-
| '''Project''' || Lab-level container grouping datasets and samples, with the ability to link funding || Data Browser
|-
| '''Public''' || Access level where a dataset is visible to all visitors without authentication || Data Browser
|-
| '''Published''' || Published datasets are copied versions of datasets that are immutable, have a persistent ARK identifier that can be used for publications, are version controlled, and are linked to the parent dataset and previous published versions. Published collections provide an additional persistent ARK identifier to the collection. || Data Browser
|-
| '''Receiver''' || NDTS service in the UConn Health datacenter that accepts data from Gateways before parsing || NDTS
|-
| '''Reassign''' || Dataset Browser action allowing the PI and/or associated NAN user to be changed for selected datasets || Data Browser
|-
| '''Redundancy''' || Status of a dataset with an identical name collected within the same Session that is not the Preferred dataset || Storage infrastructure
|-
| '''Resource Connector''' || Public landing area that lists NAN facilities, instruments, KBs, and other resources. || Portal
|-
| '''Sample''' || Physical or prepared material used for NMR experiments; carries metadata such as composition, tube type, and concentration. || Data model
|-
| '''Sample Browser''' || Dashboard for browsing sample-level metadata and associated datasets. || Portal – Data Browser
|-
|'''Session'''
|A session is specific to an NMR instrument and defines a time where the same user was collecting experiments. A new session is triggered by changing the local user, starting TopSpin/VnmrJ, changing the NAN user from the NDTS GUI
|NDTS
|-
| '''Study''' || Sub-grouping under a project that aggregates datasets addressing a specific research question or manuscript || Data model
|-
| '''UHF Request''' || Online request system for users to request access to the 1.1 GHz spectrometers through a peer-review process || UHF Access
|-
|'''Unspecified User'''
|A dataset harvested without an associated to a NAN user is said to be unspecified. Facility managers can set the default NDTS harvesting settings for unspecified users.
|NDTS
|-
| '''vNOC''' || Virtual NAN Operations Center presenting real-time dashboards (public, user, PI, facility views) for network status and metrics || vNOC
|-
| '''Vignette Library''' || Collection of concise summaries of published studies that utilized NMR || Knowledgebases
|}

NAN Terminology

2025-08-17T20:28:03Z

Mmaciejewski:

{| class="wikitable sortable"
! Term !! Definition !! Component
|-
| '''Arbitrary Data''' || Files transferred via NDTS through the portals data browser. Datasets are processed through the parser in the same manner as standard harvested datasets || NDTS
|-
| '''Collection''' || User-defined or automatic grouping of datasets or samples for presentation, sharing, publishing, or bulk download || Data Browser
|-
| '''Collection Browser''' || Interface for exploring user-defined or automatic dataset and sample collections || Data Browser
|-
| '''Data Browser''' || Suite of Dashboard (Datasets, Samples, Collections, My Permissions) for searching, filtering, and exploring data and more viewing user permissions || Data Browser
|-
| '''Dataset''' || A dataset harvested from an NMR spectrometer or uploaded through the arbitrary data feature || NDTS
|-
| '''Dataset Browser''' || Dashboard within the Data Browser focused on searching and filtering datasets || Data Browser
|-
| '''Daemon''' || NDTS workstation process that detects finished experiments, bundles metadata, and forwards data to the Gateway || NDTS
|-
| '''Facility Dashboard''' || Privileged interface for facility staff to manage facility and instrument metadata, users, and NDTS settings || Facility Dashboard
|-
| '''Gateway''' || NDTS computer inside each facility that aggregates data from Daemons and relays it to the central Receiver || NDTS
|-
| '''Knowledgebase Datasets''' || Fully vetted experimental datasets with pulse programs, parameters, and processing scripts linked from KB pages || Knowledgebases
|-
| '''Knowledgebases (KBs)''' || Curated educational content (novice KBs, datasets, isotope pages, vignettes) showing how NMR solves scientific problems || Knowledgebases
|-
| '''Lab Administration''' || PI-only dashboard for managing lab members, projects, funding sources, and permissions || Lab Administration
|-
| '''Materials Periodic Table''' || Interactive periodic table highlighting NMR-active isotopes and their properties, with links to isotope KB content || Knowledgebases
|-
| '''NAN''' || Network for Advanced NMR — a collaborative initiative that democratizes access to NMR resources including UHF instruments, access to Knowledgebases, and provides data stewardship through NDTS and the Data Browser || NAN
|-
| '''NAN Archive''' || Backend archive where NAN data reside (PostgreSQL metadata database, object storage, and disaster-recovery replicas) || NAN Archive
|-
| '''NAN User''' || Authenticated account on the NAN portal with access to resources according to permissions. There is no difference between a NAN user, a NMRbox user, or a NMRhub user - they are terms for the same account || Identity
|-
| '''NDTS''' || NAN Data Transport System — automated pipeline (Daemon → Gateway → Receiver → Parser) that harvests experimental data from spectrometers (or arbitrary upload) and loads it into the NAN archive || NDTS
|-
| '''NDTS GUI''' || GUI on the NMR spectrometer showing the status of NDTS and allows the user to change harvesting status, change NAN user, and enter experimental metadata || NDTS
|-
| '''NMRbox User''' || Authenticated account on the NMRbox platform with access to resources according to permissions. There is no difference between a NAN user, a NMRbox user, or a NMRhub user - they are terms for the same account || Identity & permissions
|-
|'''NMRhub User'''
|Authenticated account for NAN or NMRbox. There is no difference between a NAN user, a NMRbox user, or a NMRhub user - they are terms for the same account
|Identity
|-
| '''Parser''' || NDTS service that extracts metadata, writes database entries, and stores datasets to primary and disaster-recovery storage || NDTS
|-
| '''PI Delegate''' || Lab member designated by a PI to perform actions as the PI to manage Projects, users and Lab permissions || Lab Administration
|-
|'''Preferred Dataset'''
|A dataset from a collection of redundant datasets that is marked as the Preferred dataset. Generally, it is the most recently collected dataset of the redundant collection, but is selectable by the user
|Data Browser
|-
| '''Project''' || Lab-level container grouping datasets and samples, with the ability to link funding || Data Browser
|-
| '''Public''' || Access level where a dataset is visible to all visitors without authentication || Data Browser
|-
| '''Published''' || Published datasets are copied versions of datasets that are immutable, have a persistent ARK identifier that can be used for publications, are version controlled, and are linked to the parent dataset and previous published versions. Published collections provide an additional persistent ARK identifier to the collection. || Data Browser
|-
| '''Receiver''' || NDTS service in the UConn Health datacenter that accepts data from Gateways before parsing || NDTS
|-
| '''Reassign''' || Dataset Browser action allowing the dataset PI and/or associated NAN user to be changed || Data Browser
|-
| '''Redundancy''' || Status of a dataset with an identical name collected within the same Session that is not the Preferred dataset || Storage infrastructure
|-
| '''Resource Connector''' || Public landing area that lists NAN facilities, instruments, KBs, and other resources. || Portal
|-
| '''Sample''' || Physical or prepared material used for NMR experiments; carries metadata such as composition, tube type, and concentration. || Data model
|-
| '''Sample Browser''' || Dashboard for browsing sample-level metadata and associated datasets. || Portal – Data Browser
|-
|'''Session'''
|A session is specific to an NMR instrument and defines a time where the same user was collecting experiments. A new session is triggered by changing the local user, starting TopSpin/VnmrJ, changing the NAN user from the NDTS GUI
|NDTS
|-
| '''Study''' || Sub-grouping under a project that aggregates datasets addressing a specific research question or manuscript || Data model
|-
| '''UHF Request''' || Online request system for users to request access to the 1.1 GHz spectrometers through a peer-review process || UHF Access
|-
|'''Unspecified User'''
|A dataset harvested without an associated to a NAN user is said to be unspecified. Facility managers can set the default NDTS harvesting settings for unspecified users.
|NDTS
|-
| '''vNOC''' || Virtual NAN Operations Center presenting real-time dashboards (public, user, PI, facility views) for network status and metrics || vNOC
|-
| '''Vignette Library''' || Collection of concise summaries of published studies that utilized NMR || Knowledgebases
|}

Main Page

2025-08-05T16:00:09Z

Mmaciejewski:

{{DISPLAYTITLE:User Documentation for the Network of Advanced NMR (NAN)}}
{{search}}
__NOTOC__
<div class="nan-box" style="border: 2px solid #444; background: #F5FAFF; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #CEDFF2; color: black; padding: 10px; margin: 0;">What is NAN?</h2>
[https://usnan.org NAN] is a collaborative initiative to develop and operate a shared distributed resource for nuclear magnetic resonance (NMR) with the goal of democratizing NMR, making it more accessible and efficient for applications in biology, chemistry, materials science and other fields, and to foster good data stewardship practices. NAN was established by an NSF midscale (RI2) grant to [https://health.uconn.edu/ UConn Health], [https://www.uga.edu/ UGA], and [https://www.wisc.edu/ UW-Madison]. NAN offers open-access to two 1.1 GHz NMR instruments specialized for solids (UW-Madison) and solutions (UGA), along with a roster of additional NMR instruments at participating facilities which may be discovered through the web portal. Beginning in July 2025, membership in NAN is widened to encompass additional NMR facilities beyond the initial three facilities.

NAN provides a suite of '''[[Knowledgebases]] (KBs)''' in Bio Solids, Material Solids, Bio Solutions, and Metabolomics that comprehensively guide novice and expert users through discovering how NMR may be utilized to study interesting scientific problems as well as KB datasets with all the resources needed to recapitulate those experiments. NAN member nodes help to contribute additional KB content and new KB datasets.

Portal dashboards provide tools for (1) facility staff to manage facility, instrument, and probe information, as well as manage facility users, (2) PIs to create projects and manage lab members, and (3) a virtual Network Operations Center (vNOC) for monitoring NAN.

A distinguishing feature of NAN is the '''[[NAN Data Transport System|NAN Data Transport System (NDTS)]]''' [[NAN Data Transport System|a]]<nowiki/>nd [[Data Browser|'''Data Browsers''']]. NDTS automatically harvests experimental data and archives it into the [[NAN Archive|'''NAN Archive''']]. Datasets are linked with rich metadata such as instrument, parameters, user, project, sample, and other information. Users view and manipulate data in an advanced Data Browser where they can edit experiments, add notes, classify experiments, and organize data into projects, studies, and collections. PIs are stewards of data collected in their lab and control access. Users can create detailed sample records and link samples with datasets.

For a full breakdown of capabilities across the portal, see the '''[[Feature Summary]].'''

'''Interested in having your NMR facility join as a NAN node? Checkout the [[Joining NAN|Joining NAN page]] for more information.'''
</div>

<div class="nan-box" style="border: 2px solid #444; background: #EEF5E8; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #B3D1A7; color: black; padding: 10px; margin: 0;">NAN Portal Resources</h2>[[File:Menu-bar.png|thumb|Collapsible menu bar|229x229px]]<p style="margin: 0; padding: 10px 0;">The [https://usnan.org '''NAN portal'''] is composed of a '''Resource Connector''' which is accessible publicly as well as pages requiring an NMRhub account for access. See the [[Creating an Account]] page for how to create an account and the [[User Roles and Permissions]] page for a full list of user roles. The NAN Resources for authenticated users are itemized in a collapsible menu on the left hand side of the web-portal and organized as follows:</p>
* '''[[Resource Connector]]''' (publicly accessible content)
** '''[[Facilities]]''' (list of facility nodes connected to NAN with details such as a description, contacts, addresses, instruments, and services)
** '''Instruments''' (list of instruments from the facility nodes that are a part of the NAN Network)
** '''[[Knowledgebases]]'''
*** [[Knowledgebases for Non-Experts|'''Knowledgebases for non-Experts''']] (concise overviews for newcomers that explain how NMR can address specific research questions, with links to related literature vignettes and Expert KBs)
*** [[Knowledgebase Datasets|'''Knowledgebase Datasets''']] (exemplar datasets with step-by-step protocols and/or analysis scripts that cover sample preparation, experimental setup, signal processing, and data analysis)
*** [[Materials Periodic Table|'''Materials Periodic Table''']] (interactive periodic table to explore the feasibility of utilizing NMR in materials science)
** [[Vignette Library|'''Vignette Library''']] (brief synopses of peer-reviewed studies where NMR played a key role, helping novice users appreciate the technique’s utility and a place to "advertise" publications utilizing NMR)
** [[Public and Publishing|'''Public & Published''']] datasets and collections
* [[Facility Dashboards|'''Facility Dashboards''']] (only visible / accessible by NMR facility managers and staff and used to enter facility and instrument information as well as management of NDTS user settings)
* '''Operations Dashboards'''
* [[Data Browser|'''Data Browsers''']] (accessible to authenticated NMRhub users for viewing datasets, samples, collections, and their permissions)
* [[UHF Access|'''UHF Access''']] (accessible to authenticated NMRhub users to request access to ultra-high-field (UHF) instruments including two 1.1 GHz NAN spectrometers at NMRAM (solids) and CCRC (solutions)
* [[Lab Administration|'''Lab Administration''']] (accessible by PIs and PI delegates to manage lab members, permissions, projects, and funding)<br />
</div>

<div class="nan-box" style="border: 2px solid #444; background: #F3EEFA; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #C8B9EC; color: black; padding: 10px; margin: 0;">NAN Data Transport System (NDTS)</h2>
<p style="margin: 0; padding: 10px 0;">
NDTS is a system for automatically harvesting data from NAN connected spectrometers to the central NAN archive. NDTS is comprised of a Daemon and lightweight GUI installed on the spectrometer workstations, Gateway software running on a dedicated computer within the NMR facility, and a Receiver and Parser running within the NAN datacenter. NMR facility staff manage the NDTS settings for users through the NAN portal and can adjust NDTS settings through configuration files. Harvested datasets are viewable in the Dataset Browser by those with proper permissions set by PIs as well as facility managers have access to all data collected in their facility.
</p>
<p style="margin: 0; padding: 0px 0;">
See the [[NAN Data Transport System|'''NDTS Documentation''']] for detailed information on NDTS installation, configuration, usage, troubleshooting, and detailed explanation on how NDTS functions.
</p>
</div>

<div class="nan-box" style="border: 2px solid #444; background: #FFF5E5; padding: 10px;">
<h2 class="nan-title" style="background: #FFC266; color: black; padding: 10px; margin: 0;">Help & Support</h2>

==== Support Tickets ====
Support tickets may be created from within the NAN Portal by:

* Selecting the NMRhub widget in the top right corner of all NAN portal pages. From the widget enter your ''Email Address'' (only needed if not logged in with an NMRhub account), enter your ''Message'', and selecting ''Submit''.
** This is the preferred method as it allows us to track the page where you are having issues.
* Support tickets may also be generated by sending an email to [mailto:support@usnan.org support@usnan.org]

==== [[Frequently Asked Questions|FAQ]] ====
A FAQ page on this wiki provides answers to frequently asked questions

==== Wiki Documentation ====
This wiki provides the written documentation for the NAN portal and NDTS. It is intended to be community driven and any NMRhub user may login using the ''login'' link in the upper right hand corner to make edits or create new pages.
</div>

NAN Archive

2025-08-01T19:35:02Z

Mmaciejewski:

== Overview ==
While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data in the NAN Archive.

The NAN Archive consists of:
* A Postgres database holding all metadata records across the NAN portal and NDTS
* Network-attached storage (NAS) for all files associated with datasets
* Disaster recovery storage containing immutable dataset backups

== NAN Postgres Database ==
* Hosted as a virtual machine (VM) with a virtual datastore
* Replicated in near real-time to a second VM on a different physical server in a separate datacenter
** The secondary VM uses a distinct NAS system for added resilience
** In case of failure, the replica can be promoted to primary within minutes
* Hourly backups to a separate NAS system
** In the unlikely event both the primary and replica fail, the system can be restored from backups (recovery may take several hours)
* All NAS systems supporting the database and backups:
** Are continuously monitored
** Feature high data durability
** Are under vendor hardware/software support
** Employ daily (or more frequent) snapshots retained for weeks, allowing recovery of VMs and recent states

=== Metadata Provenance Tracking ===
* Changes to dataset metadata are stored in immutable audit tables
* Complete change history is preserved to ensure traceability

== Data Storage ==

=== Primary Storage: Dell PowerScale (Isilon) A3000 ===
* Four A3000 nodes, each with 400 TB raw capacity (1.6 PB total)
* Erasure coding reduces usable capacity to ~900 TB
* OneFS clustered architecture scales to 252 nodes (up to 100 PB)

=== Disaster Recovery Storage: HP Scality RING ===
* Distributed, peer-to-peer architecture across four datacenters (Farmington and Storrs, CT)
* 14×9s data durability via erasure coding, replication, and self-healing
* WORM (Write-Once-Read-Many) S3 bucket ensures:
** Protection from accidental/malicious deletion
** Automatic lease renewal
** No file deletions by users, admins, or vendors
** Resilience against ransomware encryption attempts

=== Landing Zone: Qumulo NAS ===
* Data from NDTS Gateways arrives at the Landing Zone
* Hosted on Qumulo NAS and replicated in real-time to a second NAS
* Data is only deleted after verified transfer to both primary and disaster recovery storage
* At minimum, two independent copies exist from the moment of data arrival

== Access Control & Monitoring ==
* Access is restricted using role-based Active Directory (AD) groups
* All logins require key-based SSH
* All code changes are Git-versioned with rollback support
* CrowdStrike Falcon agent monitors systems for suspicious activity
* Server logs are centrally aggregated and retained for audit
* These measures ensure operational integrity and compliance with security protocols

== NSF Trusted CI Center of Excellence ==
* NAN participates as an NSF Trusted CI Center of Excellence
* Undergoes periodic third-party reviews
* Aligns policies with research cyberinfrastructure best practices

NAN Archive

2025-08-01T19:32:30Z

Mmaciejewski:

This page is currently under development – please excuse any issues.

== Overview ==
While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data in the NAN Archive.

The NAN Archive consists of:
* A Postgres database holding all metadata records across the NAN portal and NDTS
* Network-attached storage (NAS) for all files associated with datasets
* Disaster recovery storage containing immutable dataset backups

== NAN Postgres Database ==
* Hosted as a virtual machine (VM) with a virtual datastore
* Replicated in near real-time to a second VM on a different physical server in a separate datacenter
** The secondary VM uses a distinct NAS system for added resilience
** In case of failure, the replica can be promoted to primary within minutes
* Hourly backups to a separate NAS system
** In the unlikely event both the primary and replica fail, the system can be restored from backups (recovery may take several hours)
* All NAS systems supporting the database and backups:
** Are continuously monitored
** Feature high data durability
** Are under vendor hardware/software support
** Employ daily (or more frequent) snapshots retained for weeks, allowing recovery of VMs and recent states

=== Metadata Provenance Tracking ===
* Changes to dataset metadata are stored in immutable audit tables
* Complete change history is preserved to ensure traceability

== Data Storage ==

=== Primary Storage: Dell PowerScale (Isilon) A3000 ===
* Four A3000 nodes, each with 400 TB raw capacity (1.6 PB total)
* Erasure coding reduces usable capacity to ~900 TB
* OneFS clustered architecture scales to 252 nodes (up to 100 PB)

=== Disaster Recovery Storage: HP Scality RING ===
* Distributed, peer-to-peer architecture across four datacenters (Farmington and Storrs, CT)
* 14×9s data durability via erasure coding, replication, and self-healing
* WORM (Write-Once-Read-Many) S3 bucket ensures:
** Protection from accidental/malicious deletion
** Automatic lease renewal
** No file deletions by users, admins, or vendors
** Resilience against ransomware encryption attempts

=== Landing Zone: Qumulo NAS ===
* Data from NDTS Gateways arrives at the Landing Zone
* Hosted on Qumulo NAS and replicated in real-time to a second NAS
* Data is only deleted after verified transfer to both primary and disaster recovery storage
* At minimum, two independent copies exist from the moment of data arrival

== Access Control & Monitoring ==
* Access is restricted using role-based Active Directory (AD) groups
* All logins require key-based SSH
* All code changes are Git-versioned with rollback support
* CrowdStrike Falcon agent monitors systems for suspicious activity
* Server logs are centrally aggregated and retained for audit
* These measures ensure operational integrity and compliance with security protocols

== NSF Trusted CI Center of Excellence ==
* NAN participates as an NSF Trusted CI Center of Excellence
* Undergoes periodic third-party reviews
* Aligns policies with research cyberinfrastructure best practices

NAN Archive

2025-08-01T19:29:49Z

Mmaciejewski:

This page is currently under development - please excuse any issues

== Overview ==
While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data in the NAN Archive.

The NAN archive is composed of:

* Postgres database which holds all metadata records across the entire NAN portal and NDTS
* Network attached storage which holds all files associated with datasets
* Disaster recovery storage which hold an immutable copy of all datasets

== NAN Postgres database ==
* The Postgres database is hosted as a virtual machine with a virtual datastore
* The Postgres database is replicated in near real-time to a second virtual machined hosted on a different physical server in a physically separate datacenter. The datastore is also virtual and store on a separate network attached storage system as the primary database.
** In the unlikely event of a failure of the primary Postgres database, the replica database can be changed into the primary database in a few minutes.
* The Postgres database is backed up hourly to a separate network attached storage system
** In the very unlikely failure of both the primary database and replica the entire NAN database may be rebuilt from the backups, but recovery would take hours to complete.
* Multiple network attached storage systems are utilized for the virtual VM datastores and for the database backups. Those network attached storage systems are monitored continuously and have high levels of data durability to prevent data loss due to disk or node failures. They are under vendor hardware and software support. In addition, these systems all utilize snapshots, at least daily, with snapshots being kept for weeks to recover any data loss that may possibly occur. These snapshots can also be utilized to recover the virtual machine that hosts the Postgres database providing two additional backups of the databases current to within the snapshot time-frame.

=== Metadata Provenance Tracking ===

* Changes to dataset metadata are captured in immutable audit tables in the NAN database, preserving a complete change history.

== Data Storage ==

=== NAN Primary Storage (Dell PowerScale (Isilon) A3000) ===

* NAN utilizes four A3000 nodes each with 400 GB raw capacity for a total capacity of 1.6 PB
* The system utilizes Erasure coding for data protection reducing the total usable size to 900 TB
* The A3000 uses a distributed, fully symmetric clustered architecture with OneFS and can scale to 252 nodes (100 PB)

=== NAN Disaster Recovery Storage (HP Scality RING) ===

* Scality RING is a software platform that uses a peer-to-peer architecture, distributing data and metadata across multiple nodes and datacenters to ensure high availability and eliminate single points of failure.
** NAN utilizes the the UConn HPC facilities system which is GeoSpread across four separate datacenters, two in Farmington CT and two in Storrs CT
** The system provide 14 x 9s of data durability through Erasure coding, replication, and self-healing capability
* NAN utilizes a WORM (Write-Once-Read-Many) S3 bucket for disaster recovery. All data is protected from accidental or malicious deletion due to the WORM capability. All files have WORM leases that auto-renew quarterly and data cannot be removed by users, system administrators, nor the hardware vendor performing maintenance. The WORM also protects against Ransomware attacks as data cannot be modified preventing a malicious actor from encrypting the files.

=== Landing Zone (Qumulo) ===

* NDTS transfers data from Gateway computers to the NAN receiver's landing zone. The Landing zone is a disk partition hosted on a Qumulo NAS and is replicated to a second Qumulo NAS in real-time. No data is removed from the Landing Zone until a copies of data have been verified on the NAN primary and disaster recovery storage. Thus, at all times, from the moment data arrives in the datacenter there are at least two independent copies of the data.

== NSF Trusted CI Center of Excellence ==

* As an NSF Trusted CI Center of Excellence, NAN undergoes periodic third-party reviews and aligns its policies with research cyberinfrastructure best practices.

Access to NAN components is limited through role-based Active Directory groups. Key-based SSH is required for all logins. Code changes are version-controlled with Git and can be rolled back if needed. Systems are continuously monitored for suspicious activity using the CrowdStrike Falcon agent. Server logs are centrally aggregated and retained for auditing. As an NSF Trusted CI Center of Excellence, NAN undergoes periodic third-party reviews and aligns its policies with research cyberinfrastructure best practices.

NAN Archive

2025-08-01T19:18:22Z

Mmaciejewski:

This page is currently under development - please excuse any issues

== Overview ==
While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data in the NAN Archive.

The NAN archive is composed of:

* Postgres database which holds all metadata records across the entire NAN portal and NDTS
* Network attached storage which holds all files associated with datasets
* Disaster recovery storage which hold an immutable copy of all datasets

== NAN Postgres database ==
* The Postgres database is hosted as a virtual machine with a virtual datastore
* The Postgres database is replicated in near real-time to a second virtual machined hosted on a different physical server in a physically separate datacenter. The datastore is also virtual and store on a separate network attached storage system as the primary database.
** In the unlikely event of a failure of the primary Postgres database, the replica database can be changed into the primary database in a few minutes.
* The Postgres database is backed up hourly to a separate network attached storage system
** In the very unlikely failure of both the primary database and replica the entire NAN database may be rebuilt from the backups, but recovery would take hours to complete.
* Multiple network attached storage systems are utilized for the virtual VM datastores and for the database backups. Those network attached storage systems are monitored continuously and have high levels of data durability to prevent data loss due to disk or node failures. They are under vendor hardware and software support. In addition, these systems all utilize snapshots, at least daily, with snapshots being kept for weeks to recover any data loss that may possibly occur. These snapshots can also be utilized to recover the virtual machine that hosts the Postgres database providing two additional backups of the databases current to within the snapshot time-frame.

== Data Storage ==

=== NAN Primary Storage (Dell PowerScale (Isilon) A3000) ===

* NAN utilizes four A3000 nodes each with 400 GB raw capacity for a total capacity of 1.6 PB
* The system utilizes Erasure coding for data protection reducing the total usable size to 900 TB
* The A3000 uses a distributed, fully symmetric clustered architecture with OneFS and can scale to 252 nodes (100 PB)

=== NAN Disaster Recovery Storage (HP Scality RING) ===

* Scality RING is a software platform that uses a peer-to-peer architecture, distributing data and metadata across multiple nodes and datacenters to ensure high availability and eliminate single points of failure.
** NAN utilizes the the UConn HPC facilities system which is GeoSpread across four separate datacenters, two in Farmington CT and two in Storrs CT
** The system provide 14 x 9s of data durability through Erasure coding, replication, and self-healing capability
* NAN utilizes a WORM (Write-Once-Read-Many) S3 bucket for disaster recovery. All data is protected from accidental or malicious deletion due to the WORM capability. All files have WORM leases that auto-renew quarterly and data cannot be removed by users, system administrators, nor the hardware vendor performing maintenance. The WORM also protects against Ransomware attacks as data cannot be modified preventing a malicious actor from encrypting the files.

While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data. Its layered security strategy combines technical safeguards with tightly controlled administrative workflows. Access to NAN components is limited through role-based Active Directory groups. Key-based SSH is required for all logins. Code changes are version-controlled with Git and can be rolled back if needed. Systems are continuously monitored for suspicious activity using the CrowdStrike Falcon agent. Server logs are centrally aggregated and retained for auditing. As an NSF Trusted CI Center of Excellence, NAN undergoes periodic third-party reviews and aligns its policies with research cyberinfrastructure best practices.

All datasets are stored on a fault-tolerant Dell PowerEdge storage appliance with active monitoring. Daily snapshots enable recovery from accidental deletion. A disaster recovery copy of all datasets is written to a WORM (Write Once Read Many) S3 bucket on a Scality RING object storage cluster. Each object receives a renewable quarterly retention lease, during which it cannot be modified or deleted, even by administrators. Leases renew automatically unless a dataset is flagged to be purged. Object versioning maintains a complete history of dataset changes.

The PostgreSQL database replicates in real time to a secondary datacenter for high availability. Daily backups support full recovery if needed. Critical services are distributed across two restricted-access datacenters to eliminate single points of failure. Changes to dataset metadata are captured in immutable audit tables in the NAN database, preserving a complete change history.

NAN Archive

2025-08-01T18:45:58Z

Mmaciejewski: Created page with "While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data in the NAN Archive. The NAN archive is composed of: * Postgres database which holds all metadata records across the entire NAN portal and NDTS * Network attached storage which holds all files associated with datasets * Disaster recovery storage which hold an immutable copy of all datasets Postgres database * The Postgres database is hosted as a virtual machine with a..."

While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data in the NAN Archive.

The NAN archive is composed of:

* Postgres database which holds all metadata records across the entire NAN portal and NDTS
* Network attached storage which holds all files associated with datasets
* Disaster recovery storage which hold an immutable copy of all datasets

Postgres database

* The Postgres database is hosted as a virtual machine with a virtual datastore
* The Postgres database is replicated in near real-time to a second virtual machined hosted on a different physical server in a physically separate datacenter. The datastore is also virtual and store on a separate network attached storage system as the primary database.
** In the unlikely event of a failure of the primary Postgres database, the replica database can be changed into the primary database in a few minutes.
* The Postgres database is backed up hourly to a separate network attached storage system
** In the very unlikely failure of both the primary database and replica the entire NAN database may be rebuilt from the backups, but recovery would take hours to complete.
* Multiple network attached storage systems are utilized for the virtual VM datastores and for the database backups. Those network attached storage systems are monitored continuously and have high levels of data durability to prevent data loss due to disk or node failures. They are under vendor hardware and software support. In addition, these systems all utilize snapshots, at least daily, with snapshots being kept for weeks to recover any data loss that may possibly occur. These snapshots can also be utilized to recover the virtual machine that hosts the Postgres database providing two additional backups of the databases current to within the snapshot time-frame.

While no system can guarantee perfect security or trust, NAN goes to great lengths to safeguard data. Its layered security strategy combines technical safeguards with tightly controlled administrative workflows. Access to NAN components is limited through role-based Active Directory groups. Key-based SSH is required for all logins. Code changes are version-controlled with Git and can be rolled back if needed. Systems are continuously monitored for suspicious activity using the CrowdStrike Falcon agent. Server logs are centrally aggregated and retained for auditing. As an NSF Trusted CI Center of Excellence, NAN undergoes periodic third-party reviews and aligns its policies with research cyberinfrastructure best practices.

All datasets are stored on a fault-tolerant Dell PowerEdge storage appliance with active monitoring. Daily snapshots enable recovery from accidental deletion. A disaster recovery copy of all datasets is written to a WORM (Write Once Read Many) S3 bucket on a Scality RING object storage cluster. Each object receives a renewable quarterly retention lease, during which it cannot be modified or deleted, even by administrators. Leases renew automatically unless a dataset is flagged to be purged. Object versioning maintains a complete history of dataset changes.

The PostgreSQL database replicates in real time to a secondary datacenter for high availability. Daily backups support full recovery if needed. Critical services are distributed across two restricted-access datacenters to eliminate single points of failure. Changes to dataset metadata are captured in immutable audit tables in the NAN database, preserving a complete change history.

Main Page

2025-08-01T18:24:42Z

Mmaciejewski:

{{DISPLAYTITLE:User Documentation for the Network of Advanced NMR (NAN)}}
{{search}}
__NOTOC__
<div class="nan-box" style="border: 2px solid #444; background: #F5FAFF; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #CEDFF2; color: black; padding: 10px; margin: 0;">What is NAN?</h2>
[https://usnan.org NAN] is a collaborative initiative to develop and operate a shared distributed resource for nuclear magnetic resonance (NMR) with the goal of democratizing NMR, making it more accessible and efficient for applications in biology, chemistry, materials science and other fields, and to foster good data stewardship practices. NAN was established by an NSF midscale (RI2) grant to [https://health.uconn.edu/ UConn Health], [https://www.uga.edu/ UGA], and [https://www.wisc.edu/ UW-Madison]. NAN offers open-access to two 1.1 GHz NMR instruments specialized for solids (UW-Madison) and solutions (UGA), along with a roster of additional NMR instruments at participating facilities which may be discovered through the web portal. Beginning in July 2025, membership in NAN is widened to encompass additional NMR facilities beyond the initial three facilities.

NAN provides a suite of '''[[Knowledgebases]] (KBs)''' in Bio Solids, Material Solids, Bio Solutions, and Metabolomics that comprehensively guide novice and expert users through discovering how NMR may be utilized to study interesting scientific problems as well as KB datasets with all the resources needed to recapitulate those experiments. NAN member nodes help to contribute additional KB content and new KB datasets.

Portal dashboards provide tools for (1) facility staff to manage facility, instrument, and probe information, as well as manage facility users, (2) PIs to create projects and manage lab members, and (3) a virtual Network Operations Center (vNOC) for monitoring NAN.

A distinguishing feature of NAN is the '''[[NAN Data Transport System|NAN Data Transport System (NDTS)]]''' [[NAN Data Transport System|a]]<nowiki/>nd [[Data Browser|'''Data Browsers''']]. NDTS automatically harvests experimental data and archives it into the [[NAN Archive]]. Datasets are linked with rich metadata such as instrument, parameters, user, project, sample, and other information. Users view and manipulate data in an advanced Data Browser where they can edit experiments, add notes, classify experiments, and organize data into projects, studies, and collections. PIs are stewards of data collected in their lab and control access. Users can create detailed sample records and link samples with datasets.

For a full breakdown of capabilities across the portal, see the '''[[Feature Summary]].'''

'''Interested in having your NMR facility join as a NAN node? Checkout the [[Joining NAN|Joining NAN page]] for more information.'''
</div>

<div class="nan-box" style="border: 2px solid #444; background: #EEF5E8; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #B3D1A7; color: black; padding: 10px; margin: 0;">NAN Portal Resources</h2>[[File:Menu-bar.png|thumb|Collapsible menu bar|229x229px]]<p style="margin: 0; padding: 10px 0;">The [https://usnan.org '''NAN portal'''] is composed of a '''Resource Connector''' which is accessible publicly as well as pages requiring an NMRhub account for access. See the [[Creating an Account]] page for how to create an account and the [[User Roles and Permissions]] page for a full list of user roles. The NAN Resources for authenticated users are itemized in a collapsible menu on the left hand side of the web-portal and organized as follows:</p>
* '''[[Resource Connector]]''' (publicly accessible content)
** '''[[Facilities]]''' (list of facility nodes connected to NAN with details such as a description, contacts, addresses, instruments, and services)
** '''Instruments''' (list of instruments from the facility nodes that are a part of the NAN Network)
** '''[[Knowledgebases]]'''
*** [[Knowledgebases for Non-Experts|'''Knowledgebases for non-Experts''']] (concise overviews for newcomers that explain how NMR can address specific research questions, with links to related literature vignettes and Expert KBs)
*** [[Knowledgebase Datasets|'''Knowledgebase Datasets''']] (exemplar datasets with step-by-step protocols and/or analysis scripts that cover sample preparation, experimental setup, signal processing, and data analysis)
*** [[Materials Periodic Table|'''Materials Periodic Table''']] (interactive periodic table to explore the feasibility of utilizing NMR in materials science)
** [[Vignette Library|'''Vignette Library''']] (brief synopses of peer-reviewed studies where NMR played a key role, helping novice users appreciate the technique’s utility and a place to "advertise" publications utilizing NMR)
** [[Public and Publishing|'''Public & Published''']] datasets and collections
* [[Facility Dashboards|'''Facility Dashboards''']] (only visible / accessible by NMR facility managers and staff and used to enter facility and instrument information as well as management of NDTS user settings)
* '''Operations Dashboards'''
* [[Data Browser|'''Data Browsers''']] (accessible to authenticated NMRhub users for viewing datasets, samples, collections, and their permissions)
* [[UHF Access|'''UHF Access''']] (accessible to authenticated NMRhub users to request access to ultra-high-field (UHF) instruments including two 1.1 GHz NAN spectrometers at NMRAM (solids) and CCRC (solutions)
* [[Lab Administration|'''Lab Administration''']] (accessible by PIs and PI delegates to manage lab members, permissions, projects, and funding)<br />
</div>

<div class="nan-box" style="border: 2px solid #444; background: #F3EEFA; padding: 10px; margin-bottom: 15px;">
<h2 class="nan-title" style="background: #C8B9EC; color: black; padding: 10px; margin: 0;">NAN Data Transport System (NDTS)</h2>
<p style="margin: 0; padding: 10px 0;">
NDTS is a system for automatically harvesting data from NAN connected spectrometers to the central NAN archive. NDTS is comprised of a Daemon and lightweight GUI installed on the spectrometer workstations, Gateway software running on a dedicated computer within the NMR facility, and a Receiver and Parser running within the NAN datacenter. NMR facility staff manage the NDTS settings for users through the NAN portal and can adjust NDTS settings through configuration files. Harvested datasets are viewable in the Dataset Browser by those with proper permissions set by PIs as well as facility managers have access to all data collected in their facility.
</p>
<p style="margin: 0; padding: 0px 0;">
See the [[NAN Data Transport System|'''NDTS Documentation''']] for detailed information on NDTS installation, configuration, usage, troubleshooting, and detailed explanation on how NDTS functions.
</p>
</div>

<div class="nan-box" style="border: 2px solid #444; background: #FFF5E5; padding: 10px;">
<h2 class="nan-title" style="background: #FFC266; color: black; padding: 10px; margin: 0;">Help & Support</h2>

==== Support Tickets ====
Support tickets may be created from within the NAN Portal by:

* Selecting the NMRhub widget in the top right corner of all NAN portal pages. From the widget enter your ''Email Address'' (only needed if not logged in with an NMRhub account), enter your ''Message'', and selecting ''Submit''.
** This is the preferred method as it allows us to track the page where you are having issues.
* Support tickets may also be generated by sending an email to [mailto:support@usnan.org support@usnan.org]

==== [[Frequently Asked Questions|FAQ]] ====
A FAQ page on this wiki provides answers to frequently asked questions

==== Wiki Documentation ====
This wiki provides the written documentation for the NAN portal and NDTS. It is intended to be community driven and any NMRhub user may login using the ''login'' link in the upper right hand corner to make edits or create new pages.
</div>

Joining NAN

2025-07-31T20:18:00Z

Mmaciejewski: /* Onboarding */

== Overview ==
NAN’s mission is to democratize access to high-field NMR and unlock latent knowledge in the collective body of experimental data by making it more '''Findable, Accessible, Interoperable, and Reusable (FAIR)'''.

A cornerstone of NAN is its advanced data browser, which lets users and labs easily organize, explore, and search their datasets.

NAN welcomes new NMR facilities that share this vision. To join, a facility must:

* Meet the technical requirements
* Contribute to shared Knowledgebases
* Participate in NAN stewardship via the Advisory Committee (AC) and reviewing UHF requests

Admission requires a majority vote of the AC.

== Contact Information ==
Facilities interested in joining NAN are encouraged to reach out to the [https://usnan.nmrhub.org/contacts NAN leadership team] and review the NAN [[Joining NAN#NAN Technical & Operational Requirements|technical and operational requirements]] below as well as the NAN Charter, and the [https://usnan.nmrhub.org/assets/NAN%20User%20Terms%20and%20Conditions%202024%20V1.pdf Terms & Conditions] located on the NAN web portal.

== What NAN Does and Does Not Do ==

=== NAN does not ===
* Schedule NMR instruments—each facility retains its own scheduling system.
* Collect user fees—billing remains internal to each facility.
* Mandate harvesting of every dataset—harvesting is controlled by facility managers and user preferences.
* Release datasets [[Public and Publishing|publicly]] until the user marks them public or three years after the datasets have been harvested (extensions of one year may be requested within six months of the release date and repeated as needed).
* Require that an instrument be opened to external users—each facility decides which instruments, if any, are available to outside usage. Note that all instruments, whether open for external use or not, may utilize the data stewardship features of NAN.

=== NAN does ===
* Provide the [[NAN Data Transport System|NAN Data Transport System (NDTS)]] with automatic harvesting of datasets from NAN connected instruments.
* Furnish a user-friendly [[Datasets|browser]] for dataset organization, exploration, and management for facility managers, PIs, and users.
* Maintain two redundant physical copies of every dataset, effectively backing up facility data.
* Give PIs flexible, intuitive [[Lab Permissions|controls]] for managing lab-group permissions which dictate access to data.
* Provide facility managers with [[Facility Dashboards|tools]] to manage facility details, instruments, users, and monitor system status.
* Offer novice-friendly [[Knowledgebases|Knowledgebase]] content plus vetted reference datasets that can serve as experimental templates.

== Fees ==
NAN currently charges no fees for membership or data services. If a fee structure becomes necessary, it will be determined by the AC.

== NAN Technical & Operational Requirements ==
See the [[Onboarding Guide]] for comprehensive details on on-boarding a facility.

=== Onboarding ===

===== Provide a dedicated gateway computer =====

* logically located on the same network segment as the NMR spectrometer workstations
* Minimal requirements are: 64-bit, dual-core x86-64 CPU ≥ 2 GHz; 8 GB RAM; ≥ 500 GB of local SSD/HDD storage; 1 Gb ethernet interface with static or DHCP addressable IP address.
* The operating system should be a current 64-bit Linux variant (Ubuntu LTS versions recommended).
* The gateway needs outbound HTTPS (TCP 443) access to the NAN datacenter and must allow inbound traffic on port 60195 from the NMR spectrometer workstations.

===== Download and install NAN Data Transport Setting (NDTS) components =====

* Download the NAN Data Transport System (NDTS) components from the NAN facility dashboard
* Install and configure the gateway software on the gateway computer
* Install and configure the NDTS daemon and GUI on each spectrometer workstation connected to NAN

===== Input facility and instrument metadata via the facility dashboard =====

* Input facility information including names, website links, description, services, addresses, and staff
* Input instrument metadata for all spectrometers and probes to be connected to NAN

====== Define Staff Roles ======

* For each staff member listed one or more Roles must be selected.
* '''''Special Note: Staff members assigned the roles of Director, Administrator, or Facility Manager have special privileges, including the ability to edit facility information, manage facility users, and access all data harvested by NDTS from the facility.'''''

===== Cybersecurity compliance =====

* consult with institutional IT staff to verify that NDTS is compatible with institutional cybersecurity policies

=== Operations ===

===== Manage NDTS operations =====

* Configuring user NDTS settings in the facility dashboard
* Monitor system health through the virtual NAN Operations Center (vNOC)
* Review the dataset browser to reassign any unselected or mis-attributed datasets

===== Keep software up-to-date =====

* Install updates to NDTS software (daemon or gateway) in a timely manner
* Keep the security patches for the gateway's operating system current

===== NAN stewardship =====

* The facility director will serve as an ''ex officio'' member of the NAN Advisory Committee (AC), and participate in the annual AC meeting, either virtually or in-person
* The facility director or designee will serve as a reviewer for ultra-high-field (UHF) instrument time requests submitted through the NAN UHF request system for any UHF connected spectrometers that opt into the service

===== Knowledgebase contributions =====

* Curate existing KB resources.
* Develop and submit new KB content:
** '''Expert KBs''' – exemplar datasets with step-by-step protocols and/or analysis scripts that cover sample preparation, experimental setup, signal processing, and data analysis
** '''Novice KBs''' – concise overviews for newcomers that explain how NMR can address specific research questions, with links to related literature vignettes and Expert KBs
** '''Literature vignettes''' – brief synopses of peer-reviewed studies where NMR played a key role, helping novice users appreciate the technique’s utility

Feature Summary

2025-07-31T20:15:37Z

Mmaciejewski: /* Facility Management (viewable by Facility managers and staff) */

Note that the certain features on NAN are restricted based on [[User Roles and Permissions|User Roles and Permissions.]]

== '''Knowledgebase (KB) Learning Resources''' ==
* '''Novice KBs''' – Primers covering the use of NMR across diverse disciplines including proteins, nucleic acids, materials and chemistry, metabolomics, and other biological samples.
* '''Expert KB datasets''' – Exemplar datasets on test samples with well vetted pulse programs and supplemented with protocols for sample preparation, experimental setups, data processing, and analysis along with processing scripts and processed data.
* '''Vignette library''' – Community-driven summaries of published NMR studies showcasing real-world applications.
* '''Materials Periodic Table''' – Interactive periodic table to explore the feasibility of utilizing NMR of different isotopes in materials science.

== '''Facilities and Instruments''' ==
* '''Ultra-High-Field (UHF) NMR spectrometers''' – Open-access to two 1.1 GHz NMR instruments: one for solids (NMRFAM), one for solutions (CCRC)
* '''Facilities''' – Views of all facilities connected to the NAN network including their instruments and services
* '''Instruments''' – Filterable and sortable tables that list all spectrometers, and probes, connected to the NAN network
* '''UHF access request system''' – Structured, review-based workflow to request access to NAN’s two 1.1 GHz spectrometers and other UHF assets that choose to utilize the UHF request system.

== '''Data Transport & Management''' ==
* '''NDTS (NAN Data Transport System)''' – automated pipeline that harvests raw experiment data from spectrometer workstations to the central archive with rich metadata linking (facility, spectrometer, probe, user, project, study, sample, experimental parameters, etc.).
* '''Manual Dataset Upload''' - ability to bulk upload datasets from a NAN connected spectrometer prior to NDTS installation.
* '''Secure Archival''' – NAN harvested datasets are stored on an enterprise-class network attached storage device and backed up to a geo-dispersed WORM enabled S3 bucket with high data durability. The NAN database is replicated across two datacenters and backed up daily.
* '''Data Browsers''' – Suite of tables for viewing and managing '''''datasets''''', '''''samples''''', and '''''collections'''''. Tables are customizable and each column may be filtered and sorted allowing for powerful queries. Standard and user-defined filters provide quick access to common views. A context menu allows easy access to '''''actions'''''.
* '''Actions''' – Actions allow datasets to be viewed/edited, reassigned, downloaded, pushed to NMRbox, linked to samples, and annotated with classifications, tags, and notes. Actions work with multi-select for efficiency.
* '''Supplemental Data''' – Supplemental data may be added to datasets with a defined category and type (URL, unique identifier, file in dataset, uploaded file).
* '''Sample Definitions''' – Tools to define samples across a wide range of disciplines with tabs for defining the sample '''''description''''', '''''container''''', '''''composition''''', and '''''properties'''''. Sample components are defined by '''''type''''', '''''role''''', '''''quantity''''', and '''''isotopic labeling''''' with additional details based on component type (protein, chemical formula, carbohydrate, mixtures, polymers, etc.). Tools exist for creating sets of samples for environmental and metabolomics, and an interaction manager allows component interactions to be defined.
* '''Organization''' – All lab datasets are accessible from a single view. Hierarchical structure (Projects > Studies > Collections) mirrors a file system for lab data. User collections supported.
* '''Navigation Bar''' – Sidebar enables switching between public, KB, lab/personal, and all datasets & samples.

== '''Public and Published Datasets''' ==
* '''Public datasets''' – Datasets may be marked public anytime and automatically become public three years after harvesting. Release dates may be extended in one-year blocks.
* '''Published datasets & collections''' – Immutable copies of datasets with persistent unique identifier (PUI). Datasets may be published independently or as part of a published collection.

== '''Lab Administration''' ==
* '''Principal Investigators (PIs)''' – PIs in NAN are vetted and act as stewards to data collected by their lab members.
* '''Projects, Studies, Collections & Funding''' – Projects are defined at the lab level and provide three-level hierarchy for organizing lab data. Projects allow fine-grained permissions.
* '''Funding Sources''' – Funding sources are easily added with auto-population for some funding sources.
* '''Permissions''' – Intuitive matrix for controlling lab permissions for current and past users along with collaborators. Lab group defaults allow easy management.
* '''PI Delegate''' – PI delegates act on behalf of the PI reducing administrative burden.

== '''Facility Management''' (only accessible by Facility staff with roles of Director, Administrator, or Facility Manager) ==
* '''Facility Dashboards''' – Form tools for entering facility, spectrometer, and probe information.
* '''User Management''' – Tools to add users, map local spectrometer users to NAN users, configure default NDTS harvesting for users.
* '''Access to Data''' – Facility Managers, Directors, and Administrators act as stewards of datasets collected in their facility and have the privileges to view, reassign, and purge data.
* '''NDTS''' '''Software''' – Access to download NDTS software and a portal tool for defining NDTS filter settings.

== '''virtual Network Operations Center (vNOC)''' ==
* [[User Roles and Permissions|Role-based]] dashboards with increasing scope:
** '''Public View''' – aggregates data across facilities, instruments, users, and harvested datasets.
** '''PI/User View''' – breaks those metrics down for the lab and individual.
** '''Facility/Administrator View''' – layers on spectrometer uptime, harvesting status, and storage metrics for individual facilities or the whole network, for NAN administrators.
** '''UHF Dashboard''' - accessible by UHF committee members and administrators - provides UHF statistics for submissions based on instrument and submitter

== '''Help & Support''' ==
* '''FAQs''' – Quick answers to common questions.
* '''Wiki''' – Community-editable documentation on the portal and NDTS.
* '''Support tickets''' – Submit through the portal or email (support@usnan.org).

Facility Information

2025-07-31T20:09:23Z

Mmaciejewski:

{{FacilityDashboardNavigation}}

== '''Overview''' ==
The Facility Information page on the NAN portal enables facility managers, staff, and directors to manage and publish details about their NMR facility and instruments. This page acts as a content management interface. Designated staff members can edit facility-related content across the Facility Dashboard.

It is used to populate descriptive and operational details about facilities, making them discoverable through the NAN portal.

=== '''General Information''' ===
{| class="wikitable"
! Field !! Description !! Required
|-
| '''Long Name''' || Full name of the facility. || Yes
|-
| '''Short Name''' || Abbreviated name for display. || Yes
|-
| '''Facility Website URL''' || Link to the facility’s main website. || Yes
|-
| '''Facility Description''' || A paragraph describing the facility’s focus and capabilities. || Yes
|-
| '''Generic Facility Account''' || Internal account used to assign datasets not affiliated with any PI. || auto-generated
|}

=== '''Facility Services''' ===
Facilities may list supported services. Each service has an optional free-text description field and a default description is provided, but is fully editable.

{| class="wikitable"
! Service !! Description Field Available
|-
| Remote Access || Yes
|-
| Self Service || Yes
|-
| Consultation || Yes
|-
| Training || Yes
|-
| Shipping and Handling || Yes
|-
| Analysis || Yes
|-
| Experiment Setup || Yes
|-
| Data Processing || Yes
|-
| Sample Preparation || Yes
|-
| Rotor Packing || Yes
|}

=== '''Additional Facility Web Pages''' ===
Facilities may link to supplementary pages beyond the main facility URL entered in General information and categorize their purpose. A Test URL button may be used to ensure that the URL is properly formatted and is active. An actions button allows the URL to be removed.

{| class="wikitable"
! Webpage Type (Required field)
!Website URL (Required Field)!! Description
|-
| Contact
|''enter URL''|| Contact information or personnel directory
|-
| Facility Access
|''enter URL''|| Instructions or policies for accessing the facility
|-
| Overview
|''enter URL''|| High-level introduction to the facility
|-
| Policy
|''enter URL''|| Usage or access policies
|-
| Rates
|''enter URL''|| Pricing for services or instruments
|-
| Research
|''enter URL''|| Highlights of ongoing or past research
|-
| Service
|''enter URL''|| Detailed list of available services
|-
| Spectrometers
|''enter URL''|| Dedicated information about instruments at the facility
|}

=== '''Addresses''' ===
{| class="wikitable"
! Address Type !! Description
|-
| Mailing Address || Address for correspondence
|-
| Shipping Address || Address for receiving physical samples or items
|-
| Physical Location || Actual building/lab location of the facility
|}

=== '''Staff''' ===
Staff may be added with required First and Last Names. Optionally phone and email may be added. One or more Roles and Responsibilities must be chosen from the pull-down list. See the Note for important information.

'''''Note: Staff members assigned the Roles of Director, Administrator, or Facility Manager have special privileges, including the ability to edit facility information, manage facility users, and access all data harvested by NDTS from the facility.'''''

==== Roles ====
{| class="wikitable"
! Role !! Description
!Special Privileges
|-
| Administrator || Oversees administrative operations
|YES
|-
| Director || Overall leadership and strategic direction
|YES
|-
| Engineer || Technical hardware and system support
| -
|-
| Facility Manager || Primary contact for daily operations
|YES
|-
| Researcher || Scientific users associated with the facility
| -
|-
| Technician || Laboratory and technical support staff
| -
|-
| Approver || May approve requests or data actions
| -
|}

==== Responsibilities ====
{| class="wikitable"
! Responsibility !! Description
|-
| Administrative Services || Scheduling, billing, and documentation
|-
| Equipment Maintenance || Overseeing hardware performance and upkeep
|-
| Experiment Support || Assisting users with experiment setup and troubleshooting
|-
| Sample Shipping and Handling || Coordination of sample logistics
|-
| Scheduling || Managing instrument availability and reservations
|}

=== '''Contacts''' ===
Contacts are selected from staff members to act as primary communication points for the facility. For staff designated as Contacts, the Work Phone and Email is required. In addition the Contact Type must be selected
{| class="wikitable"
! Contact Type
|-
| Administrative Services
|-
|Equipment Maintenance
|-
|Experiment Support
|-
|Sample Shipping and Handling
|-
|Scheduling
|}

=== '''Controls and Status''' ===
{| class="wikitable"
! Control !! Description
|-
| '''Save''' || Commits all entered information to the portal. || Always available
|-
| '''Discard Changes''' || Reverts unsaved changes. || Always available
|-
| '''Ready for Public View''' || Toggle to delay publication of data until ready for public release. || Optional
|}

=== '''Initial Setup''' ===
Adding a new facility node to NAN is a manual process. At the time that the facility is added to the NAN database an initial user will be identified and marked as a facility manager so that they may begin to add facility information and add additional staff who will then have access to the facility dashboard to assist with populating facility information.

User Roles and Permissions

2025-07-31T14:46:25Z

Mmaciejewski: /* Facility Staff */

== NAN Users and NMRbox Users and NMRhub Users—Oh My! ==

* [https://nmrbox.nmrhub.org/ NMRbox] and NAN were both developed at [https://health.uconn.edu/ UConn Health] and operate on shared computational resources hosted by the [https://health.uconn.edu/high-performance-computing/ HPC facility]. NMRbox has served the NMR community for over a decade, during which users had '''NMRbox''' accounts.
* With the introduction of NAN, we wanted to avoid '''YAUA''' — ''Yet Another User Account''. To streamline access, we created the '''[https://nmrhub.org/ NMRhub]''' landing site, which provides links to all computational resources hosted at UConn Health. At the same time, we rebranded NMRbox accounts as '''NMRhub users'''.
* As a result, there is no functional difference between a NAN user and an NMRbox user — throughout the documentation, the terms '''NAN user''' and '''NMRhub user''' are used interchangeably.

<big>'''The Role of Vetted PIs'''</big>

A key change introduced with NAN was the concept of '''vetted PIs''' and the formal linking of users to PI-led lab groups. Previously, users self-declared their roles (e.g., PI, graduate student), but these designations were not verified.

Because '''dataset ownership in NAN is PI-based''', we added mechanisms for:
* Users to update their account and request '''PI status'''
* The NAN team to verify and approve PI status
* Users to request access to a PI's lab group, which must be approved by the PI or their delegate
<big>'''Seamless Access Through SSO'''</big>

We have implemented '''Single Sign-On (SSO)''' across all NMRhub resources — including '''NMRbox''', '''NAN''', '''[https://nuscon.org/home NUScon]''', and the '''virtual NAN Operations Center''' — to enable seamless navigation and access across the ecosystem.

== Public User ==
A user who is not authenticated with an NMRhub account.

They have view-only access to:
* The '''[[Resource Connector]]''' (lists facilities, instruments, configurations, searchable by services)
* The '''[[Knowledgebases|Knowledgebase]]''' (introductory content on how NMR can be used in research)
* The '''[[Vignette Library]]''' (summaries of papers using NMR)
* The '''[[Materials Periodic Table]]''' (isotope-specific NMR attributes)
* All '''[[Public and Publishing|Public Datasets]]''' including those in the Knowledgebase
* '''[[Public and Publishing|Published Collections]]'''
* The '''[https://usnan.nmrhub.org/operations/kibana-public Public View]''' of the Virtual NAN Operations Center (vNOC)

== Standard NAN User ==
An authenticated user with an NMRhub account.

They have access to:
* All Public User content
* '''[[Data Browser|Dataset, Sample, and Collection Browsers]]''' (for data they have permission to see)
* The ability to '''reassign datasets''' to other lab members for 3 months after harvesting
* '''[[UHF Access]]''' (view/submit requests if granted by their PI)
* [[Data Browser#My Permissions|'''My Permissions''']] (shows what permissions their PI has granted)
* The [https://usnan.nmrhub.org/operations/kibana-user '''User Dashboard'''] of vNOC
* The ability to create '''[[Vignette Library|Literature Vignettes]]'''

== Principal Investigator (PI) ==
Includes everything a standard NAN User sees, plus:
* Access to '''[[Lab Administration]]''' for:
** Creating and managing Projects
** Adding funding sources
** Managing lab users and permissions
* The '''[https://usnan.nmrhub.org/operations/kibana-pi PI Dashboard]''' of vNOC (summary of lab-wide data)
* Ability to create '''Literature Vignettes'''

== PI Delegate ==
A lab-group member designated by the PI with delegate permissions.

* Can switch into the PI account to perform actions on their behalf (like the ''su'' command in Linux)
* Does not have PI privileges in their own account directly
* All actions are performed as the PI once switched

== Facility Staff ==

Each facility must have at least one staff member assigned when it is created. Facility staff are defined on the Facility Information page (viewable only by users with edit rights). Staff with the '''''Roles''''' of '''Administrator''', '''Director''', or '''Facility Manager''' have special privileges, including the ability to edit facility information, manage users, and access all data harvested by NDTS from the facility, as described below.

Users may hold more than one role: '''Administrator''', '''Director''', Engineer, '''Facility Manager''', Researcher, Technician, or Approver. Users who are '''NOT''' listed as an Administrator, Director, or Facility Manager do not have special privileges beyond being recognized as facility staff.

Users assigned the roles of Administrator, Director, or Facility Manager have:

* Access to the '''[[Facility Dashboards|Facility Dashboard]]''' to:
** Edit facility, instrument, and probe details
** Manage users and instrument records
** Download NDTS software
* Real-time updates to the portal based on dashboard changes
* Unrestricted access to all datasets collected within their facility
* Ability to '''reassign''' or '''purge''' datasets collected within their facility
* Access to the '''[https://usnan.nmrhub.org/operations/kibana-fm Facility Dashboard]''' of vNOC

== Knowledgebase / Website Content Provider ==
A NAN user with content editing privileges.

They can:
* Create and edit '''Knowledgebase content'''
* Assign datasets as '''KB Datasets'''
* Edit any page with built-in content management tools on the portal

== UHF Reviewer ==
A user added to the reviewer pool for Ultra-High Field (UHF) requests.

* All PIs from labs with access to 1.1 GHz instruments are automatically added

== UHF Administrator ==
A privileged user who helps run the UHF system.

* Has full access to manage UHF requests
* Assists the UHF Operations Committee and current cycle chair

== UHF Operations Committee Member ==
A user with broad oversight of UHF review activities.

They can:
* Manage and review UHF requests
* Assign reviewers
* Modify user roles and expertise areas
* Change the status of UHF requests
* One member serves as the '''Chair''' for each review cycle

User Roles and Permissions

2025-07-31T14:45:17Z

Mmaciejewski: /* Facility Staff */

== NAN Users and NMRbox Users and NMRhub Users—Oh My! ==

* [https://nmrbox.nmrhub.org/ NMRbox] and NAN were both developed at [https://health.uconn.edu/ UConn Health] and operate on shared computational resources hosted by the [https://health.uconn.edu/high-performance-computing/ HPC facility]. NMRbox has served the NMR community for over a decade, during which users had '''NMRbox''' accounts.
* With the introduction of NAN, we wanted to avoid '''YAUA''' — ''Yet Another User Account''. To streamline access, we created the '''[https://nmrhub.org/ NMRhub]''' landing site, which provides links to all computational resources hosted at UConn Health. At the same time, we rebranded NMRbox accounts as '''NMRhub users'''.
* As a result, there is no functional difference between a NAN user and an NMRbox user — throughout the documentation, the terms '''NAN user''' and '''NMRhub user''' are used interchangeably.

<big>'''The Role of Vetted PIs'''</big>

A key change introduced with NAN was the concept of '''vetted PIs''' and the formal linking of users to PI-led lab groups. Previously, users self-declared their roles (e.g., PI, graduate student), but these designations were not verified.

Because '''dataset ownership in NAN is PI-based''', we added mechanisms for:
* Users to update their account and request '''PI status'''
* The NAN team to verify and approve PI status
* Users to request access to a PI's lab group, which must be approved by the PI or their delegate
<big>'''Seamless Access Through SSO'''</big>

We have implemented '''Single Sign-On (SSO)''' across all NMRhub resources — including '''NMRbox''', '''NAN''', '''[https://nuscon.org/home NUScon]''', and the '''virtual NAN Operations Center''' — to enable seamless navigation and access across the ecosystem.

== Public User ==
A user who is not authenticated with an NMRhub account.

They have view-only access to:
* The '''[[Resource Connector]]''' (lists facilities, instruments, configurations, searchable by services)
* The '''[[Knowledgebases|Knowledgebase]]''' (introductory content on how NMR can be used in research)
* The '''[[Vignette Library]]''' (summaries of papers using NMR)
* The '''[[Materials Periodic Table]]''' (isotope-specific NMR attributes)
* All '''[[Public and Publishing|Public Datasets]]''' including those in the Knowledgebase
* '''[[Public and Publishing|Published Collections]]'''
* The '''[https://usnan.nmrhub.org/operations/kibana-public Public View]''' of the Virtual NAN Operations Center (vNOC)

== Standard NAN User ==
An authenticated user with an NMRhub account.

They have access to:
* All Public User content
* '''[[Data Browser|Dataset, Sample, and Collection Browsers]]''' (for data they have permission to see)
* The ability to '''reassign datasets''' to other lab members for 3 months after harvesting
* '''[[UHF Access]]''' (view/submit requests if granted by their PI)
* [[Data Browser#My Permissions|'''My Permissions''']] (shows what permissions their PI has granted)
* The [https://usnan.nmrhub.org/operations/kibana-user '''User Dashboard'''] of vNOC
* The ability to create '''[[Vignette Library|Literature Vignettes]]'''

== Principal Investigator (PI) ==
Includes everything a standard NAN User sees, plus:
* Access to '''[[Lab Administration]]''' for:
** Creating and managing Projects
** Adding funding sources
** Managing lab users and permissions
* The '''[https://usnan.nmrhub.org/operations/kibana-pi PI Dashboard]''' of vNOC (summary of lab-wide data)
* Ability to create '''Literature Vignettes'''

== PI Delegate ==
A lab-group member designated by the PI with delegate permissions.

* Can switch into the PI account to perform actions on their behalf (like the ''su'' command in Linux)
* Does not have PI privileges in their own account directly
* All actions are performed as the PI once switched

== Facility Staff ==

Each facility must have at least one staff member assigned when it is created. Facility staff are defined on the Facility Information page (viewable only by users with edit rights). Staff with the roles of '''Administrator''', '''Director''', or '''Facility Manager''' have special privileges, including the ability to edit facility information, manage users, and access all data harvested by NDTS from the facility, as described below.

Users may hold more than one role: '''Administrator''', '''Director''', Engineer, '''Facility Manager''', Researcher, Technician, or Approver. Users who are '''not''' listed as an Administrator, Director, or Facility Manager do not have special privileges beyond being recognized as facility staff.

Users assigned the roles of Administrator, Director, or Facility Manager have:

* Access to the '''[[Facility Dashboards|Facility Dashboard]]''' to:
** Edit facility, instrument, and probe details
** Manage users and instrument records
** Download NDTS software
* Real-time updates to the portal based on dashboard changes
* Unrestricted access to all datasets collected within their facility
* Ability to '''reassign''' or '''purge''' datasets collected within their facility
* Access to the '''[https://usnan.nmrhub.org/operations/kibana-fm Facility Dashboard]''' of vNOC

== Knowledgebase / Website Content Provider ==
A NAN user with content editing privileges.

They can:
* Create and edit '''Knowledgebase content'''
* Assign datasets as '''KB Datasets'''
* Edit any page with built-in content management tools on the portal

== UHF Reviewer ==
A user added to the reviewer pool for Ultra-High Field (UHF) requests.

* All PIs from labs with access to 1.1 GHz instruments are automatically added

== UHF Administrator ==
A privileged user who helps run the UHF system.

* Has full access to manage UHF requests
* Assists the UHF Operations Committee and current cycle chair

== UHF Operations Committee Member ==
A user with broad oversight of UHF review activities.

They can:
* Manage and review UHF requests
* Assign reviewers
* Modify user roles and expertise areas
* Change the status of UHF requests
* One member serves as the '''Chair''' for each review cycle

User Roles and Permissions

2025-07-31T14:44:17Z

Mmaciejewski:

== NAN Users and NMRbox Users and NMRhub Users—Oh My! ==

* [https://nmrbox.nmrhub.org/ NMRbox] and NAN were both developed at [https://health.uconn.edu/ UConn Health] and operate on shared computational resources hosted by the [https://health.uconn.edu/high-performance-computing/ HPC facility]. NMRbox has served the NMR community for over a decade, during which users had '''NMRbox''' accounts.
* With the introduction of NAN, we wanted to avoid '''YAUA''' — ''Yet Another User Account''. To streamline access, we created the '''[https://nmrhub.org/ NMRhub]''' landing site, which provides links to all computational resources hosted at UConn Health. At the same time, we rebranded NMRbox accounts as '''NMRhub users'''.
* As a result, there is no functional difference between a NAN user and an NMRbox user — throughout the documentation, the terms '''NAN user''' and '''NMRhub user''' are used interchangeably.

<big>'''The Role of Vetted PIs'''</big>

A key change introduced with NAN was the concept of '''vetted PIs''' and the formal linking of users to PI-led lab groups. Previously, users self-declared their roles (e.g., PI, graduate student), but these designations were not verified.

Because '''dataset ownership in NAN is PI-based''', we added mechanisms for:
* Users to update their account and request '''PI status'''
* The NAN team to verify and approve PI status
* Users to request access to a PI's lab group, which must be approved by the PI or their delegate
<big>'''Seamless Access Through SSO'''</big>

We have implemented '''Single Sign-On (SSO)''' across all NMRhub resources — including '''NMRbox''', '''NAN''', '''[https://nuscon.org/home NUScon]''', and the '''virtual NAN Operations Center''' — to enable seamless navigation and access across the ecosystem.

== Public User ==
A user who is not authenticated with an NMRhub account.

They have view-only access to:
* The '''[[Resource Connector]]''' (lists facilities, instruments, configurations, searchable by services)
* The '''[[Knowledgebases|Knowledgebase]]''' (introductory content on how NMR can be used in research)
* The '''[[Vignette Library]]''' (summaries of papers using NMR)
* The '''[[Materials Periodic Table]]''' (isotope-specific NMR attributes)
* All '''[[Public and Publishing|Public Datasets]]''' including those in the Knowledgebase
* '''[[Public and Publishing|Published Collections]]'''
* The '''[https://usnan.nmrhub.org/operations/kibana-public Public View]''' of the Virtual NAN Operations Center (vNOC)

== Standard NAN User ==
An authenticated user with an NMRhub account.

They have access to:
* All Public User content
* '''[[Data Browser|Dataset, Sample, and Collection Browsers]]''' (for data they have permission to see)
* The ability to '''reassign datasets''' to other lab members for 3 months after harvesting
* '''[[UHF Access]]''' (view/submit requests if granted by their PI)
* [[Data Browser#My Permissions|'''My Permissions''']] (shows what permissions their PI has granted)
* The [https://usnan.nmrhub.org/operations/kibana-user '''User Dashboard'''] of vNOC
* The ability to create '''[[Vignette Library|Literature Vignettes]]'''

== Principal Investigator (PI) ==
Includes everything a standard NAN User sees, plus:
* Access to '''[[Lab Administration]]''' for:
** Creating and managing Projects
** Adding funding sources
** Managing lab users and permissions
* The '''[https://usnan.nmrhub.org/operations/kibana-pi PI Dashboard]''' of vNOC (summary of lab-wide data)
* Ability to create '''Literature Vignettes'''

== PI Delegate ==
A lab-group member designated by the PI with delegate permissions.

* Can switch into the PI account to perform actions on their behalf (like the ''su'' command in Linux)
* Does not have PI privileges in their own account directly
* All actions are performed as the PI once switched

== Facility Staff ==
Each facility have staff members listed with at least one required when a facility is created. Facility staff, as defined on the Facility Information page (viewable only by users with edit rights to the facility) who have the roles of Administrator, Director, or Facility Manager have special privileges, including the ability to edit facility information, manage facility users, and access all data harvested by NDTS from the facility as described below.

Users may have more than one role ('''Administrator''', '''Director''', Engineer, '''Facility Manager,''' Researcher, Technician, Approver). Users who are '''NOT''' listed as Administrator, Director, or Facility Manager have no special privileges other than being listed as staff as part of the facility.

A user designated as Administrator, Director, or Facility Manager for a facility have:
* Access to the '''[[Facility Dashboards|Facility Dashboard]]''' for:
** Editing facility, instrument, and probe details
** Managing users and instrument records
** Downloading NDTS software
* Real-time updates to the portal based on dashboard changes
* Unrestricted access to all datasets collected within their facility
* Ability to '''reassign''' or '''purge datasets collected within their facility'''
* The '''[https://usnan.nmrhub.org/operations/kibana-fm Facility Dashboard]''' of vNOC

== Knowledgebase / Website Content Provider ==
A NAN user with content editing privileges.

They can:
* Create and edit '''Knowledgebase content'''
* Assign datasets as '''KB Datasets'''
* Edit any page with built-in content management tools on the portal

== UHF Reviewer ==
A user added to the reviewer pool for Ultra-High Field (UHF) requests.

* All PIs from labs with access to 1.1 GHz instruments are automatically added

== UHF Administrator ==
A privileged user who helps run the UHF system.

* Has full access to manage UHF requests
* Assists the UHF Operations Committee and current cycle chair

== UHF Operations Committee Member ==
A user with broad oversight of UHF review activities.

They can:
* Manage and review UHF requests
* Assign reviewers
* Modify user roles and expertise areas
* Change the status of UHF requests
* One member serves as the '''Chair''' for each review cycle

Facilities

2025-07-23T18:29:45Z

Mmaciejewski:

= NAN-Connected NMR Facilities =
[[File:Facility Tiles.png|thumb|Facility Tiles]]
Each NMR facility that has joined the Network for Advanced NMR (NAN) is displayed on the '''[https://usnan.nmrhub.org/resource-connector/facilities Facility]''' page with a tile for each facility. These tiles provide direct links to the full facility page with the content listed below.

Filters may be applied on the Facilities and Services.

== Facility Page Contents ==

Each facility has a detailed Facility page with the content shown in the table below:

{| class="wikitable"
! Component !! Description
|-
|'''Institution'''
|Institution of the facility and location
|-
| '''Facility Name''' || Name of the facility
|-
| '''Facility Website''' || URL to the facility website
|-
| '''Facility Blurb''' || A brief description of the facility’s capabilities, focus, or mission
|-
| '''Facility Services''' || List of facility services that the facility supports. See full list below.
|-
|'''Instruments'''
|Tile for each of the instrument with status, name, field, Vendor, Model, and currently installed probe. Note that decommissioned instruments should still appear to support datasets collected on those instruments.
|-
|'''Contacts'''
|Staff contacts including name, title, phone/email, responsibilities, and expertise
|-
| '''Additional Staff''' || Additional personnel with the same information as primary contacts
|-
| '''Addresses''' || Physical location, mailing address, and shipping address
|-
| '''External Links''' || URLs to additional relevant resources or affiliated pages
|}

== Available Services ==

To allow users to be able to select facilities that will meet their needs, each facility can add services (listed below) that they provide.

{| class="wikitable"
! Service !! Description
|-
| '''Analysis''' || Assistance with interpretation and analysis of NMR data
|-
| '''Consultation''' || Expert guidance on how NMR may be utilized in your research
|-
| '''Data Processing''' || Access to tools or staff support for spectral data processing
|-
| '''Experiment Setup''' || Facility staff set up and calibrate experiments for users
|-
| '''Remote Access''' || Users can run experiments remotely
|-
| '''Rotor Packing''' || Assistance with packing MAS rotors for solid-state NMR
|-
| '''Sample Preparation''' || Facility staff will add samples to tubes and rotors and perform simple sample preparation steps such as mixing components, adding buffers, pH adjustments, etc.
|-
| '''Self Service''' || Allow independent operation of NMR instruments
|-
| '''Shipping and Handling''' || Support for inbound/outbound shipping and sample logistics
|-
| '''Training''' || Hands-on or remote training in NMR methods and facility procedures
|}

== Additional Resources ==
* [[Joining NAN]] – Overview of how to join NAN and meet technical requirements.
* [[Facility Dashboards]] – Instructions for facility staff to enter facility and instrument information.

Facilities

2025-07-23T18:24:17Z

Mmaciejewski:

= NAN-Connected NMR Facilities =
[[File:Facility Tiles.png|thumb|Facility Tiles]]
Each NMR facility that has joined the Network for Advanced NMR (NAN) is displayed on the '''[https://usnan.nmrhub.org/resource-connector/facilities Facility]''' page with a tile for each facility. These tiles provide direct links to the full facility page with the content listed below.

Filters may be applied on the Facilities and Services.

== Available Services ==

To allow users to be able to select facilities that will meet their needs, each facility can add services (listed below) that they provide.

{| class="wikitable"
! Service !! Description
|-
| '''Analysis''' || Assistance with interpretation and analysis of NMR data
|-
| '''Consultation''' || Expert guidance on how NMR may be utilized in your research
|-
| '''Data Processing''' || Access to tools or staff support for spectral data processing
|-
| '''Experiment Setup''' || Facility staff set up and calibrate experiments for users
|-
| '''Remote Access''' || Users can run experiments remotely
|-
| '''Rotor Packing''' || Assistance with packing MAS rotors for solid-state NMR
|-
| '''Sample Preparation''' || Facility staff will add samples to tubes and rotors and perform simple sample preparation steps such as mixing components, adding buffers, pH adjustments, etc.
|-
| '''Self Service''' || Allow independent operation of NMR instruments
|-
| '''Shipping and Handling''' || Support for inbound/outbound shipping and sample logistics
|-
| '''Training''' || Hands-on or remote training in NMR methods and facility procedures
|}

== Facility Page Contents ==

Each facility has a detailed Facility page with the content shown in the table below:

{| class="wikitable"
! Component !! Description
|-
|Institution
|
|-
| '''Title''' || Includes the institution name, facility name, and physical location
|-
| '''Facility Website''' || One or more URLs to official or internal facility pages
|-
| '''Facility Blurb''' || A brief description of the facility’s capabilities, focus, or mission
|-
| '''Contacts''' || Staff contacts including name, title, phone/email, responsibilities, and expertise
|-
| '''Additional Staff''' || Additional personnel with the same information as primary contacts
|-
| '''Addresses''' || Physical location, mailing address, and shipping address
|-
| '''External Links''' || URLs to additional relevant resources or affiliated pages
|}

== Additional Resources ==
* [[Joining NAN]] – Overview of how to join NAN and meet technical requirements.
* [[Facility Dashboards]] – Instructions for facility staff to enter facility and instrument information.

File:Facility Tiles.png

2025-07-23T18:18:40Z

Mmaciejewski:

Facility Tiles

Onboarding Guide

2025-07-18T15:36:20Z

Mmaciejewski: /* Managing Facility Users */

== Overview of Onboarding Steps ==

* Facility added administratively
* A facility manager/director is linked to the facility
* Facility information populated
* Spectrometers and Probes are added and linked together
* NAN users are added to the facility and NDTS settings managed on a per-user basis
* Gateway identified, installed, and configured
* NDTS installed and configured on spectrometers
* Manage operations

== Populating facility, spectrometer, and probe information ==
The information populated for the ''facility, spectrometer, and probe pages'' will appear on the NAN web-portal facility page as well as metadata linked to harvested datasets.

'''''NOTE: All information is fully editable at any time so do not fret over getting information perfect initially.'''''

'''STEPS''':
# A NAN administrator (markm@uchc.edu) will create the facility on the NAN web portal. Information that is needed includes the following, but don't fret it all can be edited later:
#* Long name of the facility (e.g. National Magnetic Resonance Facility at Madison)
#* Short name of the facility (e.g. NMRFAM). Note that the short name and institution will appear as the facility for datasets and shown as a column in the data browser. (e.g. NMRFAM - UW-Madison)
#* Primary facility website URL (e.g. https://nmrfam.wisc.edu)
#* Facility manager or director - who must have an NMRhub account
# Once created the facility manager or director that was added to the facility will have access to populate additional information on the NAN portal.
#* See the [[Facility Dashboards]] wiki page for full details on editing facility information
#* They should see a box in the lower left-hand corner indicating the NMR facility they are acting on behalf.
#** Most users will see a single facility, but if a user were associated with more than one facility they would be able to choose the facility they are acting on from the list.
#* They should also see the Facility Dashboards menu item appear on the Navigation bar.
# Finish entering the facility information. Full instructions may be found on the [[Facility Information]] wiki page, but briefly:
#* Add a facility description
#* Add services that the facility provides and updating the service blurb from the default if desired
#* Add additional website URLs if desired (e.g. adding a URL to rates)
#* Add addresses
#* Add additional staff and choose their '''roles''', '''responsibilities''', and '''expertise'''
#** '''''NOTE: All users added have edit access to the facility and instruments and also the ability to see all data harvested from the facility'''''
#** '''''NOTE: While a users contact information may be typed in manually, the best approach is to use the "Link an NMRhub user" at the top of the box when adding a new user. We recommend only entering information manually if the user will never have a NMRhub (NMRbox/NAN). We also recommend users update their NMRhub profile if information is out-of-date.'''''
#* Add primary contacts using the pull-down list of already entered staff
# Save the facility information
#* '''''NOTE: We recommend using the SAVE button throughout the process so as to not lose data'''''
# Add spectrometers (see the [[Spectrometers|Managing Spectrometers]] wiki page for full instructions - including how NAN defines a spectrometer)
#* Click add Spectrometer and fill out the form. Note that the name should be descriptive, but yet reasonably short as it will appear as a column in the dataset browser
# Add probes (see the [[Probes]] wiki page for full instructions)
#* Click Add probe and fill out the form.
#* Note that the probe name is automatically built based on the information provided including the size, model, and nuclei/channel information, as well as the gradients. Thus, it is best to keep the probe Model to a short value (e.g. TXO, TCI). Keep information such as the field strength, the length, serial number, nuclei, etc. out of the Model as it will be redundant in the probe name.
# Use the manage instruments page to link a probe to a spectrometer and add an install date.
#* Note: the install date is used to calculate which probe is installed in a spectrometer at any given time and thus which probe is associated with datasets collected in the time frame. Thus, it is critical that an install state date is added and that the installed probe is changed on the NAN portal when probes are changed. If you forget to change the probe install date it can be done retroactively.

== Managing Facility Users ==
Facility managers must add a list of NAN users to their facilities. This is critical for a few reasons:

* it controls the list of NAN users that appears on the NDTS GUI (rather than the users needing to search a never-endling list of all NAN users)
* it controls the list of users that a facility manager may reassign data to
* it allows NDTS settings to be defined on a per user basis
* it allows mapping of NAN users to local spectrometer workstation accounts or allows the local workstation account to be mapped to nobody

'''''NOTE: There is a "Any unspecified" user that appears in the Manage Facility Users page. It is important that the NDTS settings be defined for this user. If the local workstation user is not defined in the Manage Facility Users page then NDTS will use the NDTS settings for the "Any unspecified" user to dictate whether data should be harvested in who it should be assigned to, if anyone. Note that if the datasets are not assigned to a NAN user then only facility staff will have access to them and they may reassign the data to the proper person from the data browser.'''''

'''''NOTE: Users may be added individually, but we also allow all the users with an email domain to be added automatically which can make adding users much easier for a facility.'''''

== NDTS Installation and Configuration ==
Identify a computer that will be used as the Gateway. See the Joining NAN page for technical details. Ideally this is a dedicated computer.

Onboarding Guide

2025-07-18T14:10:29Z

Mmaciejewski:

== Overview of Onboarding Steps ==

* Facility added administratively
* A facility manager/director is linked to the facility
* Facility information populated
* Spectrometers and Probes are added and linked together
* NAN users are added to the facility and NDTS settings managed on a per-user basis
* Gateway identified, installed, and configured
* NDTS installed and configured on spectrometers
* Manage operations

== Populating facility, spectrometer, and probe information ==
The information populated for the ''facility, spectrometer, and probe pages'' will appear on the NAN web-portal facility page as well as metadata linked to harvested datasets.

'''''NOTE: All information is fully editable at any time so do not fret over getting information perfect initially.'''''

'''STEPS''':
# A NAN administrator (markm@uchc.edu) will create the facility on the NAN web portal. Information that is needed includes the following, but don't fret it all can be edited later:
#* Long name of the facility (e.g. National Magnetic Resonance Facility at Madison)
#* Short name of the facility (e.g. NMRFAM). Note that the short name and institution will appear as the facility for datasets and shown as a column in the data browser. (e.g. NMRFAM - UW-Madison)
#* Primary facility website URL (e.g. https://nmrfam.wisc.edu)
#* Facility manager or director - who must have an NMRhub account
# Once created the facility manager or director that was added to the facility will have access to populate additional information on the NAN portal.
#* See the [[Facility Dashboards]] wiki page for full details on editing facility information
#* They should see a box in the lower left-hand corner indicating the NMR facility they are acting on behalf.
#** Most users will see a single facility, but if a user were associated with more than one facility they would be able to choose the facility they are acting on from the list.
#* They should also see the Facility Dashboards menu item appear on the Navigation bar.
# Finish entering the facility information. Full instructions may be found on the [[Facility Information]] wiki page, but briefly:
#* Add a facility description
#* Add services that the facility provides and updating the service blurb from the default if desired
#* Add additional website URLs if desired (e.g. adding a URL to rates)
#* Add addresses
#* Add additional staff and choose their '''roles''', '''responsibilities''', and '''expertise'''
#** '''''NOTE: All users added have edit access to the facility and instruments and also the ability to see all data harvested from the facility'''''
#** '''''NOTE: While a users contact information may be typed in manually, the best approach is to use the "Link an NMRhub user" at the top of the box when adding a new user. We recommend only entering information manually if the user will never have a NMRhub (NMRbox/NAN). We also recommend users update their NMRhub profile if information is out-of-date.'''''
#* Add primary contacts using the pull-down list of already entered staff
# Save the facility information
#* '''''NOTE: We recommend using the SAVE button throughout the process so as to not lose data'''''
# Add spectrometers (see the [[Spectrometers|Managing Spectrometers]] wiki page for full instructions - including how NAN defines a spectrometer)
#* Click add Spectrometer and fill out the form. Note that the name should be descriptive, but yet reasonably short as it will appear as a column in the dataset browser
# Add probes (see the [[Probes]] wiki page for full instructions)
#* Click Add probe and fill out the form.
#* Note that the probe name is automatically built based on the information provided including the size, model, and nuclei/channel information, as well as the gradients. Thus, it is best to keep the probe Model to a short value (e.g. TXO, TCI). Keep information such as the field strength, the length, serial number, nuclei, etc. out of the Model as it will be redundant in the probe name.
# Use the manage instruments page to link a probe to a spectrometer and add an install date.
#* Note: the install date is used to calculate which probe is installed in a spectrometer at any given time and thus which probe is associated with datasets collected in the time frame. Thus, it is critical that an install state date is added and that the installed probe is changed on the NAN portal when probes are changed. If you forget to change the probe install date it can be done retroactively.

== Managing Facility Users ==
Facility managers must add a list of NAN users to their facilities. This is critical for a few reasons:

* it controls the list of NAN users that appears on the NDTS GUI (rather than the users needing to search a never-endling list of all NAN users)
* it controls the list of users that a facility manager may reassign data to
* it allows NDTS settings to be defined on a per user basis
* it allows mapping of NAN users to local spectrometer workstation accounts or allows the local workstation account to be mapped to nobody

'''''NOTE: There is a "Any unspecified" user that appears in the Manage Facility Users page. It is important that the NDTS settings be defined for this user. If the local workstation user is not defined in the Manage Facility Users page then NDTS will use the NDTS settings for the "Any unspecified" user to dictate whether data should be harvested in who it should be assigned to, if anyone. Note that if the datasets are not assigned to a NAN user then only facility staff will have access to them and they may reassign the data to the proper person from the data browser.'''''

== NDTS Installation and Configuration ==
Identify a computer that will be used as the Gateway. See the Joining NAN page for technical details. Ideally this is a dedicated computer.

Onboarding Guide

2025-07-18T13:43:00Z

Mmaciejewski:

== Overview of Onboarding Steps ==

* Facility added administratively
* A facility manager/director is linked to the facility
* Facility information populated
* Spectrometers and Probes are added and linked together
* NAN users are added to the facility and NDTS settings managed on a per-user basis
* Gateway identified, installed, and configured
* NDTS installed and configured on spectrometers
* Manage operations

== Populating facility, spectrometer, and probe information ==
The information populated for the ''facility, spectrometer, and probe pages'' will appear on the NAN web-portal facility page as well as metadata linked to harvested datasets.

'''''NOTE: All information is fully editable at any time so do not fret over getting information perfect initially.'''''

'''STEPS''':
# A NAN administrator (markm@uchc.edu) will create the facility on the NAN web portal. Information that is needed includes the following, but don't fret it all can be edited later:
#* Long name of the facility (e.g. National Magnetic Resonance Facility at Madison)
#* Short name of the facility (e.g. NMRFAM). Note that the short name and institution will appear as the facility for datasets and shown as a column in the data browser. (e.g. NMRFAM - UW-Madison)
#* Primary facility website URL (e.g. https://nmrfam.wisc.edu)
#* Facility manager or director - who must have an NMRhub account
# Once created the facility manager or director that was added to the facility will have access to populate additional information on the NAN portal.
#* See the [[Facility Dashboards]] wiki page for full details on editing facility information
#* They should see a box in the lower left-hand corner indicating the NMR facility they are acting on behalf.
#** Most users will see a single facility, but if a user were associated with more than one facility they would be able to choose the facility they are acting on from the list.
#* They should also see the Facility Dashboards menu item appear on the Navigation bar.
# Finish entering the facility information. Full instructions may be found on the [[Facility Information]] wiki page, but briefly:
#* Add a facility description
#* Add services that the facility provides and updating the service blurb from the default if desired
#* Add additional website URLs if desired (e.g. adding a URL to rates)
#* Add addresses
#* Add additional staff and choose their '''roles''', '''responsibilities''', and '''expertise'''
#** '''''NOTE: All users added have edit access to the facility and instruments and also the ability to see all data harvested from the facility'''''
#** '''''NOTE: While a users contact information may be typed in manually, the best approach is to use the "Link an NMRhub user" at the top of the box when adding a new user. We recommend only entering information manually if the user will never have a NMRhub (NMRbox/NAN). We also recommend users update their NMRhub profile if information is out-of-date.'''''
#* Add primary contacts using the pull-down list of already entered staff
# Save the facility information
#* '''''NOTE: We recommend using the SAVE button throughout the process so as to not lose data'''''
# Add spectrometers (see the [[Spectrometers|Managing Spectrometers]] wiki page for full instructions - including how NAN defines a spectrometer)
#* Click add Spectrometer and fill out the form. Note that the name should be descriptive, but yet reasonably short as it will appear as a column in the dataset browser
# Add probes (see the [[Probes]] wiki page for full instructions)
#* Click Add probe and fill out the form.
#* Note that the probe name is automatically built based on the information provided including the size, model, and nuclei/channel information, as well as the gradients. Thus, it is best to keep the probe Model to a short value (e.g. TXO, TCI). Keep information such as the field strength, the length, serial number, nuclei, etc. out of the Model as it will be redundant in the probe name.
# Use the manage instruments page to link a probe to a spectrometer and add an install date.
#* Note: the install date is used to calculate which probe is installed in a spectrometer at any given time and thus which probe is associated with datasets collected in the time frame. Thus, it is critical that an install state date is added and that the installed probe is changed on the NAN portal when probes are changed. If you forget to change the probe install date it can be done retroactively.

== Managing Facility Users ==

== NDTS Installation and Configuration ==
Identify a computer that will be used as the Gateway. See the Joining NAN page for technical details. Ideally this is a dedicated computer.

Onboarding Guide

2025-07-18T13:38:02Z

Mmaciejewski:

== Populating facility, spectrometer, and probe information ==
The information populated for the ''facility, spectrometer, and probe pages'' will appear on the NAN web-portal facility page as well as metadata linked to harvested datasets.

'''''NOTE: All information is fully editable at any time so do not fret over getting information perfect initially.'''''

'''STEPS''':
# A NAN administrator (markm@uchc.edu) will create the facility on the NAN web portal. Information that is needed includes the following, but don't fret it all can be edited later:
#* Long name of the facility (e.g. National Magnetic Resonance Facility at Madison)
#* Short name of the facility (e.g. NMRFAM). Note that the short name and institution will appear as the facility for datasets and shown as a column in the data browser. (e.g. NMRFAM - UW-Madison)
#* Primary facility website URL (e.g. https://nmrfam.wisc.edu)
#* Facility manager or director - who must have an NMRhub account
# Once created the facility manager or director that was added to the facility will have access to populate additional information on the NAN portal.
#* See the [[Facility Dashboards]] wiki page for full details on editing facility information
#* They should see a box in the lower left-hand corner indicating the NMR facility they are acting on behalf.
#** Most users will see a single facility, but if a user were associated with more than one facility they would be able to choose the facility they are acting on from the list.
#* They should also see the Facility Dashboards menu item appear on the Navigation bar.
# Finish entering the facility information. Full instructions may be found on the [[Facility Information]] wiki page, but briefly:
#* Add a facility description
#* Add services that the facility provides and updating the service blurb from the default if desired
#* Add additional website URLs if desired (e.g. adding a URL to rates)
#* Add addresses
#* Add additional staff and choose their '''roles''', '''responsibilities''', and '''expertise'''
#** '''''NOTE: All users added have edit access to the facility and instruments and also the ability to see all data harvested from the facility'''''
#** '''''NOTE: While a users contact information may be typed in manually, the best approach is to use the "Link an NMRhub user" at the top of the box when adding a new user. We recommend only entering information manually if the user will never have a NMRhub (NMRbox/NAN). We also recommend users update their NMRhub profile if information is out-of-date.'''''
#* Add primary contacts using the pull-down list of already entered staff
# Save the facility information
#* '''''NOTE: We recommend using the SAVE button throughout the process so as to not lose data'''''
# Add spectrometers (see the [[Spectrometers|Managing Spectrometers]] wiki page for full instructions - including how NAN defines a spectrometer)
#* Click add Spectrometer and fill out the form. Note that the name should be descriptive, but yet reasonably short as it will appear as a column in the dataset browser
# Add probes (see the [[Probes]] wiki page for full instructions)
#* Click Add probe and fill out the form.
#* Note that the probe name is automatically built based on the information provided including the size, model, and nuclei/channel information, as well as the gradients. Thus, it is best to keep the probe Model to a short value (e.g. TXO, TCI). Keep information such as the field strength, the length, serial number, nuclei, etc. out of the Model as it will be redundant in the probe name.
# Use the manage instruments page to link a probe to a spectrometer and add an install date.
#* Note: the install date is used to calculate which probe is installed in a spectrometer at any given time and thus which probe is associated with datasets collected in the time frame. Thus, it is critical that an install state date is added and that the installed probe is changed on the NAN portal when probes are changed. If you forget to change the probe install date it can be done retroactively.

== Managing Facility Users ==

== NDTS Installation and Configuration ==
Identify a computer that will be used as the Gateway. See the Joining NAN page for technical details. Ideally this is a dedicated computer.