Get Started

Data Release Workflow

Visible to the public 

Submitted by sprinkle on Wed, 04/27/2022 - 4:40pm

Preparing for CPS-IoT Week Tutorial

Visible to the public 

Submitted by noellesweeney on Thu, 04/21/2022 - 4:57pm

Pre-Workshop Checklist

  • Create a username on the CPS-VO
  • Reproduce the project’s data (run the code again, double check that the outputs are the same)
  • Confirm the project’s license from the following list: 
    • Creative Commons 2.5
    • Creative Commons 3.0
    • Creative Commons Attribution-NonCommercial 3.0
    • Academic Free
    • Apache 2.0
    • BSD 3-Clause
    • BSD 2-Clause
    • Common Development and Distribution
    • Eclipse Public
    • Educational Community 2.0
    • GNU General Public 2.0
    • GNU General Public 3.0
    • GNU Lesser General Public 2.1
    • GNU Lesser General Public 3.0
    • MIT
    • Mozilla Public 2.0
    • NASA Open Source Agreement 1.3
    • Other 
  • Gather a list of project contributors
  • Confirm the Award ID for the project
  • Create a README with specific instructions on recreating the data, including
    • Software used
    • Dependencies
    • Step-by-step instructions to reproduce the data results
    • Any necessary links (software downloads, etc.)
    • Expected output images
    • A link to the data and code if it is available for download elsewhere
  • If uploading data directly, collect the necessary data, code, and README and compress the files into a zip file

 

Use Case 1: Upload your existing structured data and analysis code

Visible to the public 

Submitted by sprinkle on Wed, 04/20/2022 - 4:48pm

UPLOADING PROTOTYPE FOR PRIMARY VERIFICATION

  1. Make sure all appropriate information is collected. This includes:
    1. A README file with specific instructions on recreating the data, including
      1. Software
      2. Dependencies
      3. Step-by-step instructions
      4. Any necessary links (software downloads, etc.)
      5. Licensing Information
      6. Expected output images
      7. If the data/code is available for download somewhere else, a link to this page
    2. If uploading your data directly to the VO, a zip file containing
      1. The README
      2. Data
      3. Code
      4. Licensing
  2. Join the 2022 CPS-IoT Week Tutorial group
  3. Under the "Collaborate" tab on the left side of the screen, click "Upload Files"
  4. Click the "Choose File" button
    1. Data upload options
      1. If uploading data directly, choose the zip file containing all of the project data, code files, and expected output from the computer. The correct name of the zip file should be displayed once it is selected to upload.
      1. If data is elsewhere, choose the README file that contains the project information
    2. Under the "title" field, enter an appropriate title for the project (ex: Recreating the Dissipation of Stop and Go Waves Using MATLAB)
    1. Under the "Description" field, choose "Full HTML," which should open up a more extensive editing window above the text box.
    2. Under the "Description" field, copy and paste the full, detailed instructions for recreating the experiment data. Please note that copying and pasting from Microsoft Word is the best way to ensure that all formatting, links and images are properly transferred.
    1. In the "Associated Award ID" box, enter the corresponding Award ID.
      1. If there are multiple, enter all of these separated by commas.
    1. Under "Document Type" select "Dataset"
    1. Under "File Details," add "Contributor(s)"
    1. Under "License," select the appropriate license
    1. Check the box next to the statement "I certify all materials submitted here conform to the 'Terms of Use' spelled out at http://cps-vo.org/legal *"
    1. Confirm that when "Groups" is selected on the bottom left, under Audience, "2022 CPS-IoT Week Tutorial " is selected, and "Public" is unchecked.
    1. Under "Notifications," choose whether to log a message detailing the changes that have been made, or click "Do not send notifications for this update."
    1. Click "Save" either at the top right or bottom left

UPLOADING A PUBLIC DATASET FOR THE FIRST TIME

  1. Make sure all appropriate information is collected. This includes:
    1. A README file with specific instructions on recreating the data, including
      1. Software
      2. Dependencies
      3. Step-by-step instructions
      4. Any necessary links (software downloads, etc.)
      5. Licensing Information
      6. Expected output images
      7. If the data/code is available for download somewhere else, a link to this page
    2. If uploading your data directly to the VO, a zip file containing
      1. The README
      2. Data
      3. Code
      4. Licensing
  2. Go to the CPS-VO Homepage
  3. There are 2 places from which data can be uploaded
    1. Go to the "Collaborate" tab in the top navigation bar
      1. Under "Collaborate" hit "Upload File"
    1. Under the Project node, click "Add Artifact"
  1. Click the "Choose File" button
    1. Data upload options
      1. If uploading data directly, choose the zip file containing all of the project data, code files, and expected output from the computer. The correct name of the zip file should be displayed once it is selected to upload.
      1. If data is elsewhere, choose the README file that contains the project information
    2. Under the "title" field, enter an appropriate title for the project (ex: Recreating the Dissipation of Stop and Go Waves Using MATLAB)
    1. Under the "Description" field, choose "Full HTML," which should open up a more extensive editing window above the text box.
    2. Under the "Description" field, copy and paste the full, detailed instructions for recreating the experiment data. Please note that copying and pasting from Microsoft Word is the best way to ensure that all formatting, links and images are properly transferred.
    1. In the "Associated Award ID" box, enter the corresponding Award ID.
      1. If there are multiple, enter all of these separated by commas.
    1. Under "Document Type" select "Dataset"
    1. Under "File Details," add "Contributor(s)"
    1. Under "License," select the appropriate license
    1. Check the box next to the statement "I certify all materials submitted here conform to the 'Terms of Use' spelled out at http://cps-vo.org/legal *"
    1. Confirm that when "Groups" is selected on the bottom left, the Audience is set to "Public"
    1. Under "Notifications," choose whether to log a message detailing the changes that have been made, or click "Do not send notifications for this update."
    1. Click "Save" either at the top right or bottom left

    Use Case 2: Making Data Publicly Visible

    Visible to the public 

    Submitted by noellesweeney on Thu, 04/21/2022 - 4:19pm

    MODIFYING A PREVIOUSLY PRIVATE DATASET

    1. Navigate to the file

      1. If you initially uploaded it to the CPS-VO Data Prototype Group, find the file from the group page by clicking “Files”

     

      1. If you initially uploaded it publicly to the CPS-VO, find the file from the corresponding Project page
    2. Click “Edit”
    3. Modify all fields that you wish to change.
      1. If you wish to completely delete the data, click “Delete” on the top right.

     

      1. If you are uploading a new data file, click “Choose File” at the top left.

        1. If you do this, the old file will be overwritten, so ensure that the new file also contains all appropriate information.

     

    1. If you wish to change the privacy of a dataset, navigate to the “Groups” section

      1. Check the “public” box to release previously private datasets

     

      1. Uncheck the “public” box to hide previously published datasets

        1. Check any appropriate groups to share the dataset with

     

    1. Make sure to re-check the box next to the statement “I certify all materials submitted here conform to the 'Terms of Use' spelled out at http://cps-vo.org/legal *”

     

    1. Under “Notifications,” you can choose whether to log a message detailing the changes you have made, or you may click “Do not send notifications for this update.”
    2. Click “Save” either at the top right or bottom left and your changes will be confirmed!