Joining NAN - Revision history

Mmaciejewski: /* Onboarding */

2025-07-31T20:18:00Z

Onboarding

← Older revision		Revision as of 20:18, 31 July 2025
Line 57:		Line 57:
	* Input facility information including names, website links, description, services, addresses, and staff		* 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		* 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 =====		===== Cybersecurity compliance =====

Mmaciejewski: /* NAN Technical & Operational Requirements */

2025-07-17T18:08:40Z

NAN Technical & Operational Requirements

← Older revision		Revision as of 18:08, 17 July 2025
Line 36:		Line 36:

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

	=== Onboarding ===		=== Onboarding ===

Mmaciejewski: /* Knowledgebase contributions */

2025-07-02T20:20:46Z

Knowledgebase contributions

← Older revision		Revision as of 20:20, 2 July 2025
Line 81:		Line 81:
	===== Knowledgebase contributions =====		===== Knowledgebase contributions =====

	* ~~'''~~Curate~~'''~~ existing KB resources.		* Curate existing KB resources.
	* ~~'''~~Develop and submit~~'''~~ new KB content:		* Develop and submit new KB content:
	'''Expert KBs''' – exemplar datasets with step-by-step protocols and analysis scripts** that cover sample preparation, experimental setup, signal processing, and data analysis.		** '''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.		** '''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.		** '''Literature vignettes''' – brief synopses of peer-reviewed studies where NMR played a key role, helping novice users appreciate the technique’s utility

Mmaciejewski: /* Knowledgebase contributions */

2025-07-02T20:18:59Z

Knowledgebase contributions

← Older revision		Revision as of 20:18, 2 July 2025
Line 81:		Line 81:
	===== Knowledgebase contributions =====		===== Knowledgebase contributions =====

	* Curate existing KB resources ~~as well as contributing~~ new KB content~~, where KB content includes~~		* '''Curate''' existing KB resources.
	** Expert KBs ~~- Exemplar~~ datasets ~~populated~~ with protocols and scripts ~~for~~ sample preparation, experimental ~~setups~~, signal processing, and analysis		* '''Develop and submit''' new KB content:
	** Novice KBs ~~- Short descriptions designed~~ for ~~novice users to describe the utility of~~ NMR ~~in a given~~ research ~~area~~ with links to literature vignettes and ~~expert~~ KBs		'''Expert KBs''' – exemplar datasets with step-by-step protocols and analysis scripts** that cover sample preparation, experimental setup, signal processing, and data analysis.
	** Literature vignettes - ~~Short, concise synopsis of literature manuscripts~~ where NMR ~~was utilized to aid~~ novice ~~NMR~~ users ~~in understanding~~ the utility ~~of NMR~~		** '''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.

Mmaciejewski: /* NAN Technical & Operational Requirements */

2025-07-02T20:18:06Z

NAN Technical & Operational Requirements

← Older revision		Revision as of 20:18, 2 July 2025
Line 8:		Line 8:
	* Meet the technical requirements		* Meet the technical requirements
	* Contribute to shared Knowledgebases		* Contribute to shared Knowledgebases
	* Participate in ~~governance~~ via the Advisory Committee (AC) and reviewing UHF requests		* Participate in NAN stewardship via the Advisory Committee (AC) and reviewing UHF requests

	Admission requires a majority vote of the AC.		Admission requires a majority vote of the AC.
Line 69:		Line 69:
	* Review the dataset browser to reassign any unselected or mis-attributed datasets		* 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

	~~Facility managers must:~~		===== NAN stewardship =====

	* ~~Enter~~ facility and ~~instrument details via~~ the ~~[[Facility Dashboards\|Facility Dashboard]].~~		* 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
	* ~~Supply~~ a ~~dedicated gateway computer:~~		* 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
	** Modern Linux OS, minimal CPU/RAM/storage (~~sub-$1,000 hardware is sufficient~~).
	** Connected to the same network as ~~the spectrometer workstations.~~		===== Knowledgebase contributions =====
	* ~~Install~~ and ~~configure the Gateway~~ and ~~Daemon software (see the [[NDTS Installation\|NDTS Installation Guide]]).~~
	* ~~Manage NDTS settings~~ for ~~facility~~ users ~~through~~ the ~~[[Facility Dashboards\|Facility Dashboard]].~~		* Curate existing KB resources as well as contributing new KB content, where KB content includes
	* ~~Reassign “unselected” or misattributed datasets~~ in the ~~[[Datasets\|Dataset Browser]].~~		** Expert KBs - Exemplar datasets populated with protocols and scripts for sample preparation, experimental setups, signal processing, and analysis
	* Monitor NDTS health for their facility via the virtual NAN Operating Center (vNOC).		** Novice KBs - Short descriptions designed for novice users to describe the utility of NMR in a given research area with links to literature vignettes and expert KBs
			** Literature vignettes - Short, concise synopsis of literature manuscripts where NMR was utilized to aid novice NMR users in understanding the utility of NMR

Mmaciejewski at 20:00, 2 July 2025

2025-07-02T20:00:19Z

← Older revision		Revision as of 20:00, 2 July 2025
Line 13:		Line 13:

	== Contact Information ==		== 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\|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.		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 ==		== What NAN Does and Does Not Do ==

Mmaciejewski: /* NAN Technical Requirements */

2025-07-02T19:59:39Z

NAN Technical Requirements

← Older revision		Revision as of 19:59, 2 July 2025
Line 1:		Line 1:
	== Overview ==		== 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)'''.		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.		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:		NAN welcomes new NMR facilities that share this vision. To join, a facility must:

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

	Admission requires a majority vote of the AC.		Admission requires a majority vote of the AC.

	== Contact Information ==		== 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 [[Joining ~~NAN#NAN Technical Requirements~~\|technical requirements]] below, the NAN Charter, and the [https://usnan.nmrhub.org/assets/NAN%20User%20Terms%20and%20Conditions%202024%20V1.pdf Terms & Conditions].		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\|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 ==		== What NAN Does and Does Not Do ==
Line 34:		Line 35:
	NAN currently charges no fees for membership or data services. If a fee structure becomes necessary, it will be determined by the AC.		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 Requirements ==		== NAN Technical & Operational Requirements ==

			=== 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

			===== 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



	Facility managers must:		Facility managers must:

Mmaciejewski: /* NAN does not */

2025-06-18T20:54:17Z

NAN does not

← Older revision		Revision as of 20:54, 18 June 2025
Line 20:		Line 20:
	* Collect user fees—billing remains internal to each facility.		* Collect user fees—billing remains internal to each facility.
	* Mandate harvesting of every dataset—harvesting is controlled by facility managers and user preferences.		* Mandate harvesting of every dataset—harvesting is controlled by facility managers and user preferences.
	* Release datasets publicly until the user marks them public or three years have ~~passed~~ (extensions of one year may be requested within six months of the release date and repeated as needed).		* 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.		* 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 ===		=== NAN does ===
	* Provide the NAN Data Transport System (NDTS) ~~which~~ automatic harvesting of datasets from NAN connected instruments.		* Provide the [[NAN Data Transport System\|NAN Data Transport System (NDTS)]] with automatic harvesting of datasets from NAN connected instruments.
	* Furnish a user-friendly browser for dataset organization, exploration, and management for ~~users~~, PIs, and ~~facility managers~~.		* 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.		* Maintain two redundant physical copies of every dataset, effectively backing up facility data.
	* Give PIs flexible, intuitive controls for managing lab-group permissions which dictate access.		* Give PIs flexible, intuitive [[Lab Permissions\|controls]] for managing lab-group permissions which dictate access to data.
	* Provide facility managers with tools to manage facility details, instruments, users, and monitor system status.		* Provide facility managers with [[Facility Dashboards\|tools]] to manage facility details, instruments, users, and monitor system status.
	* Offer novice-friendly Knowledgebase content plus vetted reference datasets that can serve as experimental templates.		* Offer novice-friendly [[Knowledgebases\|Knowledgebase]] content plus vetted reference datasets that can serve as experimental templates.

	== Fees ==		== Fees ==

Mmaciejewski: /* NAN does */

2025-06-16T01:04:00Z

NAN does

← Older revision		Revision as of 01:04, 16 June 2025
Line 6:		Line 6:

	* Meet the technical standards		* Meet the technical standards
	* Contribute to shared ~~knowledgebases~~		* Contribute to shared Knowledgebases
	* Participate in governance via the Advisory Committee (AC)		* Participate in governance via the Advisory Committee (AC)

Line 12:		Line 12:

	== Contact Information ==		== 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 [[Joining NAN#NAN Technical Requirements\|technical requirements]], NAN Charter, and the [https://usnan.nmrhub.org/assets/NAN%20User%20Terms%20and%20Conditions%202024%20V1.pdf Terms & Conditions].		Facilities interested in joining NAN are encouraged to reach out to the [https://usnan.nmrhub.org/contacts NAN leadership team] and review the [[Joining NAN#NAN Technical Requirements\|technical requirements]] below, the NAN Charter, and the [https://usnan.nmrhub.org/assets/NAN%20User%20Terms%20and%20Conditions%202024%20V1.pdf Terms & Conditions].

	== What NAN Does and Does Not Do ==		== What NAN Does and Does Not Do ==
Line 24:		Line 24:

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

	== Fees ==		== Fees ==

Mmaciejewski: /* NAN does not */

2025-06-12T16:41:07Z

NAN does not

← Older revision		Revision as of 16:41, 12 June 2025
Line 16:		Line 16:
	== What NAN Does and Does Not Do ==		== What NAN Does and Does Not Do ==

	=== NAN ~~'''~~does not~~'''~~ ===		=== NAN does not ===
	* Schedule NMR instruments—each facility retains its own scheduling system.		* Schedule NMR instruments—each facility retains its own scheduling system.
	* Collect user fees—billing remains internal to each facility.		* Collect user fees—billing remains internal to each facility.
Line 23:		Line 23:
	* 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.		* 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~~'''~~ ===		=== NAN does ===
	* Offer novice-friendly Knowledgebase content plus vetted reference datasets that can serve as experimental templates.		* Offer novice-friendly Knowledgebase content plus vetted reference datasets that can serve as experimental templates.
	* Provide facility managers with tools to manage facility details, instruments, users, and monitor system status.		* Provide facility managers with tools to manage facility details, instruments, users, and monitor system status.
Line 44:		Line 44:
	* Reassign “unselected” or misattributed datasets in the [[Datasets\|Dataset Browser]].		* Reassign “unselected” or misattributed datasets in the [[Datasets\|Dataset Browser]].
	* Monitor NDTS health for their facility via the virtual NAN Operating Center (vNOC).		* Monitor NDTS health for their facility via the virtual NAN Operating Center (vNOC).

	~~== Additional Resources ==~~
	* [https://usnan.nmrhub.org/contacts NAN Core Member Contacts]
	* [https://usnan.nmrhub.org/assets/NAN%20User%20Terms%20and%20Conditions%202024%20V1.pdf NAN Terms & Conditions]
	* NAN Charter
	* NAN Technical Requirements