Spectrometers - Revision history

Mmaciejewski: /* Adding and Editing Spectrometers */

2025-06-13T16:19:17Z

Adding and Editing Spectrometers

← Older revision		Revision as of 16:19, 13 June 2025
Line 28:		Line 28:
	* Consider renaming the decommissioned instruments to avoid confusion.		* Consider renaming the decommissioned instruments to avoid confusion.

	== ~~'''~~Adding and Editing Spectrometers~~'''~~ ==		== Adding and Editing Spectrometers ==

	Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features. A Save Changes button saves the edited information and a Discard Changes button allows exiting without saving.		Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features. A Save Changes button saves the edited information and a Discard Changes button allows exiting without saving.

Mmaciejewski: /* What Defines a Spectrometer in NAN? */

2025-06-13T16:18:49Z

What Defines a Spectrometer in NAN?

← Older revision		Revision as of 16:18, 13 June 2025
Line 13:		Line 13:
	=== Changing the Console on an Existing Instrument ===		=== Changing the Console on an Existing Instrument ===

	* Edit the current spectrometer and set the '''Spectrometer Status''' to '''Decommissioned'''.		* Edit the current spectrometer and set the '''Spectrometer Status''' to '''''Decommissioned'''''.
	* Use the '''Add Spectrometer''' button to create a new instrument.		* Use the '''Add Spectrometer''' button to create a new instrument.
	* Consider renaming the decommissioned instrument if the new one will reuse the same name.		* Consider renaming the decommissioned instrument if the new one will reuse the same name.
Line 24:		Line 24:
	=== Swapping Consoles Between Two Magnets ===		=== Swapping Consoles Between Two Magnets ===

	* Edit both current spectrometers and set their '''Spectrometer Status''' to '''Decommissioned'''.		* Edit both current spectrometers and set their '''Spectrometer Status''' to '''''Decommissioned'''''.
	* Use the '''Add Spectrometer''' button to create two new instruments.		* Use the '''Add Spectrometer''' button to create two new instruments.
	* Consider renaming the decommissioned instruments to avoid confusion.		* Consider renaming the decommissioned instruments to avoid confusion.

Mmaciejewski: /* What Defines a Spectrometer in NAN? */

2025-06-13T16:17:05Z

What Defines a Spectrometer in NAN?

← Older revision		Revision as of 16:17, 13 June 2025
Line 2:		Line 2:
	{{FacilityDashboardNavigation}}		{{FacilityDashboardNavigation}}
	== What Defines a Spectrometer in NAN? ==		== What Defines a Spectrometer in NAN? ==
	~~NMR spectrometers are composed on many components; magnets, consoles, workstations, probes, cryogenic systems, variable temperature control units, sample changers, pneumatics routers, and more.~~

	~~In the context~~ of ~~NAN~~, ~~an instrument / spectrometer is defined as a combination of the magnet and console. If either change~~, ~~the best practice is to create a new instrument and decommission the previous instrument. This will ensure that the correct console~~ and ~~magnet metadata is attached with harvested datasets~~.		NMR spectrometers are composed of many components: magnets, consoles, workstations, probes, cryogenic systems, variable temperature control units, sample changers, pneumatic routers, and more.

	~~=== Adding~~ a new instrument ~~===~~		In the context of NAN, an instrument (or spectrometer) is defined as a combination of a '''magnet''' and a '''console'''. If either component changes, the best practice is to create a new instrument and decommission the old one. This ensures that harvested datasets are associated with the correct magnet and console metadata.

	* Add a ~~new instrument with the Add Spectrometer button. No other action needed.~~		=== Adding a New Instrument ===

	~~=== Changing a console on an existing instrument ===~~		* Use the '''Add Spectrometer''' button. No other action is needed.

	* Edit the ~~current spectrometer and change the Spectrometer Status to Decommissioned~~		=== Changing the Console on an Existing Instrument ===
	* Add a new instrument with the Add Spectrometer button.
	* Consider changing the name of the decommissioned instrument if the new instrument will retain the same name. Note that the Name of the insturment is cosmetic and can be changed at any time and the change will be reflected on ~~the portal immediately. Spectrometers are tracked using the Spectrometer UUID so the Name may0 be changed at any time.~~

	~~=== Replacing~~ a ~~magnet while keeping~~ the ~~existing console ===~~		* Edit the current spectrometer and set the '''Spectrometer Status''' to '''Decommissioned'''.
			* Use the '''Add Spectrometer''' button to create a new instrument.
			* Consider renaming the decommissioned instrument if the new one will reuse the same name.
			Note: the instrument '''Name''' is cosmetic and can be changed at any time. Changes take effect immediately on the portal. Spectrometers are tracked by their '''Spectrometer UUID''', so renaming has no technical impact.

	* Follow the ~~directions for Changing a console~~		=== Replacing the Magnet While Keeping the Existing Console ===

	~~=== Swapping consoles between two magnets ===~~		* Follow the same steps as for '''Changing the Console'''.

	* Edit both current spectrometers and ~~change~~ their Spectrometer Status to Decommissioned		=== Swapping Consoles Between Two Magnets ===
	* Add two new instruments ~~with the Add Spectrometer button~~.
	* Consider ~~changing the names of~~ the decommissioned instruments to avoid ~~naming~~ confusion.		* Edit both current spectrometers and set their '''Spectrometer Status''' to '''Decommissioned'''.
			* Use the '''Add Spectrometer''' button to create two new instruments.
			* Consider renaming the decommissioned instruments to avoid confusion.

	== '''Adding and Editing Spectrometers''' ==		== '''Adding and Editing Spectrometers''' ==

Mmaciejewski at 16:15, 13 June 2025

2025-06-13T16:15:27Z

← Older revision		Revision as of 16:15, 13 June 2025
Line 1:		Line 1:
			{{DISPLAYTITLE:Managing Spectrometers}}
	{{FacilityDashboardNavigation}}		{{FacilityDashboardNavigation}}
			== What Defines a Spectrometer in NAN? ==
			NMR spectrometers are composed on many components; magnets, consoles, workstations, probes, cryogenic systems, variable temperature control units, sample changers, pneumatics routers, and more.

			In the context of NAN, an instrument / spectrometer is defined as a combination of the magnet and console. If either change, the best practice is to create a new instrument and decommission the previous instrument. This will ensure that the correct console and magnet metadata is attached with harvested datasets.

			=== Adding a new instrument ===

			* Add a new instrument with the Add Spectrometer button. No other action needed.

			=== Changing a console on an existing instrument ===

			* Edit the current spectrometer and change the Spectrometer Status to Decommissioned
			* Add a new instrument with the Add Spectrometer button.
			* Consider changing the name of the decommissioned instrument if the new instrument will retain the same name. Note that the Name of the insturment is cosmetic and can be changed at any time and the change will be reflected on the portal immediately. Spectrometers are tracked using the Spectrometer UUID so the Name may0 be changed at any time.

			=== Replacing a magnet while keeping the existing console ===

			* Follow the directions for Changing a console

			=== Swapping consoles between two magnets ===

			* Edit both current spectrometers and change their Spectrometer Status to Decommissioned
			* Add two new instruments with the Add Spectrometer button.
			* Consider changing the names of the decommissioned instruments to avoid naming confusion.

	== '''Adding and Editing Spectrometers''' ==		== '''Adding and Editing Spectrometers''' ==

Mmaciejewski at 16:40, 10 June 2025

2025-06-10T16:40:20Z

← Older revision		Revision as of 16:40, 10 June 2025
Line 1:		Line 1:
	~~<span style="display:inline-block; margin-bottom:1em;">[[Facility_Dashboards\|← Back to Facility Dashboards]]</span>~~		{{FacilityDashboardNavigation}}

	== '''Adding and Editing Spectrometers''' ==		== '''Adding and Editing Spectrometers''' ==

Mmaciejewski: /* Basic Information */

2025-06-02T16:04:54Z

Basic Information

← Older revision		Revision as of 16:04, 2 June 2025
Line 4:		Line 4:

	Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features. A Save Changes button saves the edited information and a Discard Changes button allows exiting without saving.		Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features. A Save Changes button saves the edited information and a Discard Changes button allows exiting without saving.
			[[File:Spectrometer-edit.png\|thumb\|450x450px\|Modal for adding and editing spectrometer information]]

	=== '''Basic Information''' ===		=== '''Basic Information''' ===

Mmaciejewski: /* Magnet Information */

2025-06-02T15:37:05Z

Magnet Information

← Older revision		Revision as of 15:37, 2 June 2025
Line 24:		Line 24:
	\| '''Vendor''' \|\| Magnet vendor name (e.g., Bruker, Oxford). \|\| Yes		\| '''Vendor''' \|\| Magnet vendor name (e.g., Bruker, Oxford). \|\| Yes
	\|-		\|-
	\| '''Vendor ID''' \|\| Leave blank if unknown. Automatically detected after first experiment.		\| '''Vendor ID''' \|\| Leave blank if unknown. Automatically detected after first experiment is harvested.
	* To locate:		* To locate:
	** TopSpin: Look in `uxnmr.info` for `Bruker Order:`		** TopSpin: Look in `uxnmr.info` for `Bruker Order:`
	** VNMRj: Look in `global` for `acqaddr`. \|\| No		** VNMRj: Look in `global` for `acqaddr`.
			\| No
	\|-		\|-
	\| '''Field Strength''' \|\| Magnetic field strength in MHz ~~or Tesla.~~ \|\| Yes		\| '''Field Strength''' \|\| Magnetic field strength in MHz \|\| Yes
	\|-		\|-
	\| '''Bore Diameter''' \|\| Bore size of the magnet in mm. \|\| Yes		\| '''Bore Diameter''' \|\| Bore size of the magnet in mm. \|\| Yes
	\|-		\|-
	\| '''Sample Changer''' \|\| Select sample changer model or ''None''. \|\| No		\| '''Sample Changer''' \|\| Select sample changer model or ''None''. \|\| No
			\|-
			\|'''Sample Changer Temperature Setting'''
			\|Set whether the sample changer is ''Cooled, Heated, or Room Temperature''
			\|No
	\|-		\|-
	\| '''Pumped Magnet''' \|\| Checkbox to indicate whether the magnet is pumped. \|\| No		\| '''Pumped Magnet''' \|\| Checkbox to indicate whether the magnet is pumped. \|\| No
Line 59:		Line 64:
	! Field !! Description !! Required		! Field !! Description !! Required
	\|-		\|-
	\| '''Operating System''' \|\| OS name ~~(e.g., Linux, Windows, macOS).~~ \|\| Yes		\| '''Operating System''' \|\| OS name \|\| Yes
	\|-		\|-
	\| '''OS Version''' \|\| Version of the operating system. \|\| Yes		\| '''OS Version''' \|\| Version of the operating system. \|\| Yes

Mmaciejewski: /* Add-On Software Features (TopSpin Only) */

2025-06-02T15:28:39Z

Add-On Software Features (TopSpin Only)

@@ Line 3: / Line 3: @@
 == '''Adding and Editing Spectrometers''' ==
-Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features.
+Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features. A Save Changes button saves the edited information and a Discard Changes button allows exiting without saving.
 === '''Basic Information''' ===
@@ Line 75: / Line 75: @@
 === '''Add-On Software Features (TopSpin Only)''' ===
 If TopSpin is selected as the NMR software, users may select from available add-on features. These are checkboxes that can be toggled depending on the installed modules.

Mmaciejewski: Created page with "← Back to Facility Dashboards == '''Adding and Editing Spectrometers''' == Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features. === '''Basic Information''' === {| class="wik..."

2025-06-02T15:25:21Z

Created page with "<span style="display:inline-block; margin-bottom:1em;">← Back to Facility Dashboards</span> == '''Adding and Editing Spectrometers''' == Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features. === '''Basic Information''' === {| class="wik..."

New page

<span style="display:inline-block; margin-bottom:1em;">[[Facility_Dashboards|← Back to Facility Dashboards]]</span>

== '''Adding and Editing Spectrometers''' ==

Facility staff can add or edit spectrometers through the Facility Dashboard. Each spectrometer entry is divided into several sections: Basic Information, Magnet Information, Console Information, Workstation Information, NMR Software, and Add-On Software Features.

=== '''Basic Information''' ===
{| class="wikitable"
! Field !! Description !! Required
|-
| '''Name''' || The display name for the spectrometer, shown with all datasets. Make it descriptive but concise. || Yes
|-
| '''Year Commissioned''' || The year the system was originally installed. || Yes
|-
| '''Spectrometer Status''' || Choose from: ''Operational'', ''Under Repair'', ''Decommissioned''. || Yes
|-
| '''Rates URL''' || Optional link to a webpage showing instrument usage rates. || No
|}

=== '''Magnet Information''' ===
{| class="wikitable"
! Field !! Description !! Required
|-
| '''Vendor''' || Magnet vendor name (e.g., Bruker, Oxford). || Yes
|-
| '''Vendor ID''' || Leave blank if unknown. Automatically detected after first experiment.
* To locate:
** TopSpin: Look in `uxnmr.info` for `Bruker Order:`
** VNMRj: Look in `global` for `acqaddr`. || No
|-
| '''Field Strength''' || Magnetic field strength in MHz or Tesla. || Yes
|-
| '''Bore Diameter''' || Bore size of the magnet in mm. || Yes
|-
| '''Sample Changer''' || Select sample changer model or ''None''. || No
|-
| '''Pumped Magnet''' || Checkbox to indicate whether the magnet is pumped. || No
|}

=== '''Console Information''' ===
{| class="wikitable"
! Field !! Description !! Required
|-
| '''Vendor''' || Console manufacturer. || Yes
|-
| '''Model''' || Console model. || Yes
|-
| '''Serial Number''' || Console serial number. || No
|-
| '''Year Configured''' || Year the console was installed. || Yes
|-
| '''Total Channel Count''' || Total number of RF channels. || Yes
|-
| '''Total Receiver Count''' || Total number of receivers. || Yes
|}

=== '''Workstation Information''' ===
{| class="wikitable"
! Field !! Description !! Required
|-
| '''Operating System''' || OS name (e.g., Linux, Windows, macOS). || Yes
|-
| '''OS Version''' || Version of the operating system. || Yes
|}

=== '''NMR Software''' ===
{| class="wikitable"
! Field !! Description !! Required
|-
| '''Software''' || Select from: ''TopSpin'', ''Jeol'', ''VNMRJ'', ''OpenVnmrJ''. || Yes
|-
| '''Version''' || Version of the selected software. || Yes
|}

=== '''Add-On Software Features (TopSpin Only)''' ===
If TopSpin is selected as the NMR software, users may select from available add-on features. These are checkboxes that can be toggled depending on the installed modules.

Examples include:
* Solvent Suppression
* DOSY
* T1/T2 Relaxation
* Temperature Control Extensions
* Pulse Program Libraries
* Custom User Macros

---

Once all information is entered, users can save the spectrometer record. Changes will reflect in the facility’s instrument list and become visible to users browsing the facility and its datasets.