Network for Advanced NMR - User contributions [en]

Public and Publishing

2025-12-31T16:05:15Z

Jwedell: Add a section on ARK identifiers.

{{Datasets}}

= Overview =
NAN distinguishes between public and published as described below. Note that all published datasets are also public and that public datasets are viewable by everyone, even those who are not authenticated with an NMRhub account.

== Public Datasets ==
A dataset marked as '''public''' is viewable through the data browser by anyone, including users without a NAN account. Authorized users may continue to edit public datasets.

* Users with proper permissions may manually mark datasets as public at any time.
* By policy, datasets are automatically made public three years after archival.
* Within six months of the scheduled public release date, users may opt to extend the release by one additional year.
* The public release date is displayed in the data browser and can be used for sorting and filtering.

== Published Datasets ==
'''Publishing''' a dataset performs the following:

* Makes the dataset public
* Creates an immutable, versioned snapshot of the dataset
* Assigns an ARK persistent unique identifier (PUI)

The published version includes:

* All dataset files
* Metadata and database records
* Associated samples
* Any supplemental data

The original (parent) dataset remains fully editable. A reference is maintained between the parent and all published versions. If a user requests to publish a dataset that has not changed since the last publication, a new version is not created.

== Publishing Dataset Collections ==
Dataset collections may also be published. When a collection is published:

* Each dataset within the collection is individually published following the same process
* The collection itself receives a dedicated ARK identifier
* The ARK resolves to the published collection view in the data browser

== Versioning and Provenance ==

* When re-publishing a dataset a new version number is created (e.g. V1, V2, V3)
** If no changes to the dataset have been made since it was last published a new version is not created.
* All changes to datasets are tracked in a provenance record.
* All published versions and the original dataset are linked together so that users can see all versions of a given dataset

== ARK Identifiers ==

* We issue ARK identifiers as our persistent identifier. ARKs behave similarly to DOIs. Documentation on how to interpret an ARK identifier is available [https://arks.org/about/ here].
* They key points to know are that you should provide the entire string when you copy an ARK identifier on the NAN web site. In other words, don't strip off the domain (technically the "name mapping authority") from the ARK when publishing.
** An example full ARK: https://usnan.org/ark:/83454/c16be2f687-3f23-4986-9181-d1fd71cffc56
* Note that it is possible to track down a resource with just the `ark:/83454/c16be2f687-3f23-4986-9181-d1fd71cffc56` portion of the identifier, but this requires extra manual steps.
** For example, you can use <nowiki>https://n2t.net/</nowiki> as the "name mapping authority" to resolve these ARK fragments ([https://n2t.net/ark:/83454/c16be2f687-3f23-4986-9181-d1fd71cffc56 example]) as well as DOIs ([https://n2t.net/doi:10.3390/s23218689 example]) and other identifiers.

How do I get access to NAN

2025-07-10T18:55:13Z

Jwedell: Created FAQ on getting access to datasets on NAN

==== Register ====
[https://nmrhub.org/register Register] for an NMRhub account if you don't already have one. If you have one (but have lost access) please contact support rather than making a duplicate registration.

==== Add your PI ====
Once your account is approved - which can take up to three business days (you will be notified via e-mail when it is created) - head to your [https://nmrhub.org/user-dashboard user dashboard] and at the bottom of the page ensure you have added your PI. Please ensure you use the same e-mail they use for their NMRhub account when you add them. Click save.

It is also possible to link your PI when creating your NMRhub account. If so (and you used the correct e-mail address) you should skip this step.

==== Have your PI approve the request ====
Your PI (or their PI delegate if they have assigned one) must head to their [https://usnan.nmrhub.org/data-browser/lab-administration/permissions/lab lab administration page] and approve your PI-link request, which should be visible to them if you've used the correct e-mail. At this point you will have access to any datasets assigned to you in NAN, but not datasets assigned to your PI or other lab group members. If your PI wants to share access to these datasets with you, then they need to complete the "Share lab data" instructions below.

==== Share lab data ====
Your PI (or their PI delegate if they have assigned one) must head to the [https://usnan.nmrhub.org/data-browser/lab-administration/permissions/lab lab administration page] and ensure that the checkbox for the yellow "Read" column is clicked for you, and click save. This gives you read access to all datasets in the lab group. If they don't want to give you read access to all datasets owned by any member of the lab group they can create a new project, put the datasets to share in the project, and then head to the projects permissions page to give you access just to that project. Most lab groups share their datasets and therefore this FAQ doesn't cover that process.

==== Ensure your datasets are assigned to you ====
If you don't have your own datasets, you just access to lab datasets - you don't need to worry about this. If you have datasets that you collected or a facility collected for you, read on.

Each dataset has both a person of record (the experimenter) and a PI (who has ultimately ownership of the dataset). If you didn't have an account when your experiments were ran, you will need someone to assign your datasets to you. Your facility manager has the ability to perform this action upon your request, and your PI (or their delegate) can also reassign datasets amongst lab group members. If your datasets were not assigned to any member of your PIs lab, only your facility manager can assign them to you.

Frequently Asked Questions

2025-07-10T18:40:46Z

Jwedell: /* Data Browser */ Add new FAQ for getting first access (and PI link)

__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?]]
</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]]