Main Page: Difference between revisions
From Network for Advanced NMR
Jump to navigationJump to search
Mmaciejewski (talk | contribs) |
Mmaciejewski (talk | contribs) No edit summary |
||
| (42 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{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;"> | <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> | <h2 class="nan-title" style="background: #CEDFF2; color: black; padding: 10px; margin: 0;">What is NAN?</h2> | ||
NAN is a collaborative initiative involving the [https://health.uconn.edu/structural-biology/ Gregory P. Mullen Structural Biology Facility] at [https://health.uconn.edu/ UConn Health], the [https://nmr.ccrc.uga.edu/ Complex Carbohydrate Research Center (CCRC)] at [https://www.uga.edu/ UGA], and the [https://nmrfam.wisc.edu/ National Magnetic Resonance Facility at Madison (NMRFAM)] at [https://www.wisc.edu/ UW-Madison]. Its mission is to democratize the utilization of high-field NMR in biomedicine, materials science, and chemistry and provide data stewardship through the NAN Archive. 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 | [https://usnan.org NAN] is a collaborative initiative involving the [https://health.uconn.edu/structural-biology/ Gregory P. Mullen Structural Biology Facility] at [https://health.uconn.edu/ UConn Health], the [https://nmr.ccrc.uga.edu/ Complex Carbohydrate Research Center (CCRC)] at [https://www.uga.edu/ UGA], and the [https://nmrfam.wisc.edu/ National Magnetic Resonance Facility at Madison (NMRFAM)] at [https://www.wisc.edu/ UW-Madison]. Its mission is to democratize the utilization of high-field NMR in biomedicine, materials science, and chemistry and provide data stewardship through the NAN Archive. 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. | ||
NAN provides a suite of four Knowledgebases (KBs) in Bio Solids, Material Solids, Bio | NAN provides a suite of four '''[[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 need to run NMR experiments. | ||
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 for monitoring NAN. | |||
A distinguishing feature is the '''[[NAN Data Transport System|NAN Data Transport System (NDTS)]]''' [[NAN Data Transport System|a]]<nowiki/>nd [[Data Browser|'''Data Browser''']]. NDTS automatically harvests experimental data and archives it in a secure repository. 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 own data collected in their lab and control access. Users can create detailed sample records and link samples with datasets. | |||
Interested in having your NMR facility join as a NAN node? Checkout the [[Joining NAN|'''Joining NAN page''']] for more information. | |||
</div> | </div> | ||
<div class="nan-box" style="border: 2px solid #444; background: #EEF5E8; padding: 10px; margin-bottom: 15px;"> | <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 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 | <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 [[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) | |||
* Resource Connector (publicly accessible content) | ** '''[[Facilities]]''' (list of facilities connected to the NAN Network) | ||
** Facilities (list of facilities connected to the NAN Network) | ** '''Instruments''' (list of instruments connected to the NAN Network) | ||
** Instruments (list of instruments connected to the NAN Network) | ** '''[[Knowledgebases]]''' | ||
** Knowledgebases (non-expert content to discover the utility of NMR across a wide range of scientific disciplines) | *** [[Knowledgebases for Non-Experts|'''Knowledgebases for non-Experts''']] (non-expert content to discover the utility of NMR across a wide range of scientific disciplines) | ||
** | *** [[Knowledgebase Datasets|'''Knowledgebase Datasets''']] (well vetted pulse programs with parameter sets, example data, processing scripts, and protocols) | ||
** Materials Periodic Table (to explore the feasibility of utilizing NMR in materials science) | *** [[Materials Periodic Table|'''Materials Periodic Table''']] (to explore the feasibility of utilizing NMR in materials science) | ||
** Public & Published datasets and collections | ** [[Vignette Library|'''Vignette Library''']] (a place to highlight publications utilizing NMR) | ||
* [[Facility Dashboards]] (accessible by NMR facility managers and staff | ** [[Public and Publishing|'''Public & Published''']] datasets and collections | ||
* Operations Dashboards | * [[Facility Dashboards|'''Facility Dashboards''']] (only visible / accessible by NMR facility managers and staff) | ||
* [[Data Browser|Data Browsers]] (accessible to authenticated NMRhub users for viewing datasets, samples, collections, and | * '''Operations Dashboards''' | ||
* UHF Access (accessible to authenticated NMRhub users to request access to the two 1.1 GHz NAN spectrometers) | * [[Data Browser|'''Data Browsers''']] (accessible to authenticated NMRhub users for viewing datasets, samples, collections, and their permissions) | ||
* [[Lab Administration]] (accessible by PIs and PI delegates to manage lab members, permissions, projects, and funding) (Only visible to PIs and PI Delegates)<br /> | * [[UHF Access|'''UHF Access''']] (accessible to authenticated NMRhub users to request access to the two 1.1 GHz NAN spectrometers) | ||
* [[Lab Administration|'''Lab Administration''']] (accessible by PIs and PI delegates to manage lab members, permissions, projects, and funding) (Only visible to PIs and PI Delegates)<br /> | |||
</div> | </div> | ||
| Line 27: | Line 36: | ||
<h2 class="nan-title" style="background: #C8B9EC; color: black; padding: 10px; margin: 0;">NAN Data Transport System (NDTS)</h2> | <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;"> | <p style="margin: 0; padding: 10px 0;"> | ||
NDTS | 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> | ||
<p style="margin: 0; padding: 0px 0;"> | <p style="margin: 0; padding: 0px 0;"> | ||
See the NDTS | 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> | </p> | ||
</div> | </div> | ||
| Line 38: | Line 47: | ||
==== Support Tickets ==== | ==== Support Tickets ==== | ||
Support tickets may be created from within the NAN Portal by | 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]] ==== | ==== [[Frequently Asked Questions|FAQ]] ==== | ||
| Line 44: | Line 57: | ||
==== Wiki Documentation ==== | ==== Wiki Documentation ==== | ||
This wiki provides the written documentation for the NAN portal | 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> | </div> | ||
Latest revision as of 18:55, 25 June 2025
What is NAN?
NAN is a collaborative initiative involving the Gregory P. Mullen Structural Biology Facility at UConn Health, the Complex Carbohydrate Research Center (CCRC) at UGA, and the National Magnetic Resonance Facility at Madison (NMRFAM) at UW-Madison. Its mission is to democratize the utilization of high-field NMR in biomedicine, materials science, and chemistry and provide data stewardship through the NAN Archive. 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.
NAN provides a suite of four 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 need to run NMR experiments.
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 for monitoring NAN.
A distinguishing feature is the NAN Data Transport System (NDTS) and Data Browser. NDTS automatically harvests experimental data and archives it in a secure repository. 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 own data collected in their lab and control access. Users can create detailed sample records and link samples with datasets.
Interested in having your NMR facility join as a NAN node? Checkout the Joining NAN page for more information.
NAN Portal Resources
The NAN portal is composed of a Resource Connector which is accessible publicly as well as pages requiring an NMRhub account for access. See 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:
- Resource Connector (publicly accessible content)
- Facilities (list of facilities connected to the NAN Network)
- Instruments (list of instruments connected to the NAN Network)
- Knowledgebases
- Knowledgebases for non-Experts (non-expert content to discover the utility of NMR across a wide range of scientific disciplines)
- Knowledgebase Datasets (well vetted pulse programs with parameter sets, example data, processing scripts, and protocols)
- Materials Periodic Table (to explore the feasibility of utilizing NMR in materials science)
- Vignette Library (a place to highlight publications utilizing NMR)
- Public & Published datasets and collections
- Facility Dashboards (only visible / accessible by NMR facility managers and staff)
- Operations Dashboards
- Data Browsers (accessible to authenticated NMRhub users for viewing datasets, samples, collections, and their permissions)
- UHF Access (accessible to authenticated NMRhub users to request access to the two 1.1 GHz NAN spectrometers)
- Lab Administration (accessible by PIs and PI delegates to manage lab members, permissions, projects, and funding) (Only visible to PIs and PI Delegates)
NAN Data Transport System (NDTS)
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.
See the NDTS Documentation for detailed information on NDTS installation, configuration, usage, troubleshooting, and detailed explanation on how NDTS functions.
Help & Support
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 support@usnan.org
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.
