Qresp | Curator tool accesses the folder that contains your research data and collects information about:
- Data location & access
- Data content
- Paper details
The user can either start from scratch for a new paper or resume a previously interrupted curation process, by uploading the JSON metadata file.
Enter Your Details¶
This step defines the identity of the person that is using the Qresp | Curator to generate metadata.
Connect to Server¶
This step defines the location of the remote server where the paper content is organized and stored. The paper content to be curated will be accessed by establishing an SSH connection to the host where the content resides. The Username and password provided in the fields is not saved or cached.
- Server Name: Enter the name of the remote server where the paper content is organized and stored. e.g. midway.rcc.uchicago.edu
- Username: Enter the username used to establish a SSH connection to the remote server.
- Password: Enter the password associated to the username.
- Is 2FA: Indicate whether or not the host is 2FA enabled.
Access Paper Content¶
This step allows the user to navigate the server data tree and to select the folder with the paper content.
- Path to paper content: Enter the path to where the paper content is located. If you do not know the full path, the data tree below helps you locate the paper content, and by clicking on a folder, the path field is automatically updated. If your paper path is not under your home directory, type the root of the path tree and click the Search button.
This page also indicates whether several services are running on the remote server that are defined by a qresp.ini file in the parent folder of a data collection.
- Http: It is required only by Qresp Exploration. If an HTTP service is running on the server, a URL may be associated to the paper content. This URL is only required by Qresp | Exploration to view images & download files using a web browser.
- Git: It is not required but recommended for version control.If a Git service is running on the server, the user may version control the paper content.
- Globus: It is not required but recommended for download of large files. The Globus (add link to globus) service allows to download the paper content using gridFTP.
Tag Paper Content¶
This step tags the paper content. The tagging procedure is divided in sections. Each section may require the interaction with the paper content widget (on the left). The paper content widget allows the user to navigate the content of the paper and enter file names during the tagging operation.
Continue button re-verifies with the user if the user has filled all mandatory fields.
Save button enables only if the user has filled all mandatory fields.
Multiple charts, tools, scripts or datasets are saved as buttons on top of each section.
This section collects general information about your paper.
- PIs: First Name, Middle Name and Last Names of all co-PI of the paper. Use plus to add additional PIs.
- Paper Stack: Enter name(s) defining group of papers (e.g. according to source of fundings).
- Keywords: Enter keyword(s) (e.g: ‘DFT’, ‘organic materials’, ‘charge transfer’): they facilitate paper searches using Qresp | Exploration.
- Main Notebook File: Enter the name of a notebook file. This file may serve as a table of contents and may contain links to all datasets, charts, scripts, tools and documentation. Use the Paper Content widget (on the left) to fill this field.
This section collects information about the Charts of the paper.
- Kind: Select Figure or Table.
- Caption: Enter chart caption.
- Number: Enter chart number.
- Files: Enter file name(s) containing the data displayed in the chart (e.g. a file in CSV format). Use the Paper Content widget (on the left) to fill this field.
- Image File: Enter the file name containing a snapshot of the chart. Use the Paper Content widget (on the left) to fill this field. Allowed formats are: jpg, jpeg, gif, png.
- Notebook File: Enter the name of the notebook file used to generate the chart. Use the Paper Content widget(on the left) to fill this field. Allowed format is ipynb.
- Keywords: Enter keyword(s) for the content displayed in the chart (e.g. ‘potential energy surface’, ‘band gap’).
- Save As: Enter a name to identify the chart.
This section collects information about the Tools used in the paper. The tool represents the use of an instrument (either software or experimental set up).
- Kind: Select Software or Experiment.
- Package Name: Enter name of the package (e.g. ‘WEST’).
- URLs: Enter link(s) to package official website (e.g. ‘www.west-code.org’).
- Version: Enter version number of the package (e.g. ‘3.0.0’) .
- Executable Name: Enter name of the package executable (e.g. ‘wstat.x’).
- Patches: Enter file name(s) containing the patches of publicly available or versioned software, customized by the user to generate some of the datasets. Use the Paper Content widget (on the left) to fill this field (e.g. enter ‘Tools/modified_wstat.txt’).
- Description: Enter a summary of the modifications, if any, made to the executable(s) using the patches.
- Save As: Enter a name to identify the Software tool.
If an Experiment,
- Facility name: Enter the name of the facility where the experiment was conducted (e.g. ‘Argonne Advanced Photon Source’).
- Measurement: Enter the type of measurement (e.g. ‘soft X-ray Photoemission’).
- URLs: Enter link(s) to facility website (e.g. ‘https://www.aps.anl.gov’).
- Save As: Enter a name to identify the Experiment.
This section collects information about the datasets generated in the paper. A dataset is a file or folder or a combination of the two which contains raw data generated in the scientific paper. Datasets are created by an instrument or by a versioned software.
- Files: Enter file name(s) to identify the dataset. Use the Paper Content widget (on the left) to fill this field (e.g. enter ‘Data/dataset.dat’). If you list a folder name, all documents of the folder belong to the dataset.
- Description: Enter a summary about the content of the dataset.
- URLs: Enter link(s) to the URL of the dataset, if available.
- Save As: Enter a name to identify the dataset.
This section collects information about the scripts. Scripts are source codes not available publicly that are used to manipulate datasets and generate the data files of charts, or other data discussed in the scientific paper.
- Files: Enter file names to identify the script. Use the Paper Content widget (on the left) to fill this field (e.g. ‘Script/scriptA.py’). If you list a folder name, all documents of the folder belong to the script.
- Description: Enter a summary about the content of the script.
- URLs: Enter link(s) to the URL of the script, if available.
- Save as: Enter a name to identify the script.
This section collects information about the publication associated to the paper. The DOI number may aid in auto filling certain fields.
- Kind: Choose type of publication. Preprint , Journal, Dissertation
- DOI: Enter the Digital Object Identifier of the publication.
- Title: Enter title.
- JournalFull: Enter name (in full) of journal.
- JournalAbbr:Enter name (abbreviated) of journal.
- Volume: Enter volume number.
- Page: Enter page number.
- Year: Enter year.
- Abstract: Enter abstract.
- URLs: Enter link(s) of the paper.
- Advisors: Enter name(s) of advisor(s).
- School: Enter name of school where dissertation was presented.
This step defines the workflow of the paper. A workflow represents how the content of the paper was created.
- Use the Edit Button in the canvas to add: Add External Node , or to Add Node Connection. The type of nodes are listed on the right. (Hover over the node for hints).
- Use the Rearrange Button to animate the workflow.
- External: The external node represents content that was used within the paper, but not generated within the paper. A reference/link is not required but recommended.
- Chart: The chart node represents a figure or a table, and is typically considered an end-point within the workflow.
- Tools: The tool node represents an instrument (either software or experimental set up) utilized in the paper.
- Dataset: The dataset node represents data generated by either a Tool or Script node.
- Script: The script node represents user-defined procedures utilized in the paper (e.g. to analyze or post-process data belonging to datasets).
The Continue button enables only after connecting atleast two nodes with an edge.
Download & Publish Metadata¶
This step defines the location of the remote server where MongoDB is installed. The Google API verifies the email address entered in this step. Please see the installation page for more information on setting up the Google Auth for Qresp and connecting Qresp to a running instance of MongoDB.
- Qresp Server: Choose server instance of Qresp instance to publish the metadata.
- Email Address: Enter email address to verify identity and use Google account to publish the metadata. Please make sure you login to th email address provided here.
Qresp | Curator has generated the metadata file.