NEEShub.org Project Editor Guide. Number: Project Name: NEEShub.org Version: 2.0 Quick start guide for the Project Editor. Guide.

Transcription

1 NEEShub Project Editor Document NEES- XX- 000 Guide Number: Project Name: NEEShub.org Version: 2.0 Brief Description: Quick start guide for the Project Editor. Table of Contents Introduction... 2 Additional Resources... 2 Project... 3 Warnings... 4 Required Input Fields... 4 PI(s)/Administrator... 4 Short Title... 4 Multiple Value Fields... 5 Project Photo... 5 Status... 5 Access Settings... 6 Experiment... 6 Adding Equipment... 7 Specimen... 7 Sensors... 8 Drawings File Upload Data Videos Photos Security Team Members Editing Projects Deleting Files, Folders, Repetitions, and Trials Experiments Projects Curation Self- check Project and Experiment Change History Description and Version Created / Updated By Date of Change Created quick start guide. Created/Kari Nasi 11/29/2010 Revised quick start guide. Updated/Kari Nasi 12/6/2010 Revised to include Release 2 functionality. Updated/Rachelle Howell 2/11/2011 Revised to include Release 2.5 functionality. Updated/Kari Nasi 5/22/2011 Revised to include Release 3.5 functionality Updated/Cheng Song 11/15/2011 Revised to include Release 4.0 functionality Updated/Cheng Song 06/11/2011

2 Introduction The Project Editor is a capability within the Project Warehouse that allows you to create new projects or modify existing projects. The Project Editor uses a similar tab and field structure as the Project Display, Figure 1, making it easy to navigate and use. Figure 1: Project Editor (Left) and Project Display (Right) Throughout the Project Editor, there is field level help indicated by a small white question mark inside a blue circle. If you have questions about a label, place your mouse over the white question mark and a help pop- up will appear (Figure 2). Additional Resources Figure 2: Help Pop- up Project Explorer for NEES (PEN) ( Bulk file upload/download to/from warehouse File organization Web Services ( Intended for users with IT skills Project creation/updating Bulk file upload SynchroNEES ( Provides user interface for group Dropbox Flexible file space

3 Project Typically, all NEESR and Shared- use project already have a project page, but in case there is a need for a new project, select the menu option Project Warehouse - > Project Editor (Figure 3). Figure 3: Creating a Project After selecting Project Editor, you will be directed to the About tab for the project (Figure 4). You must first save your new project before you can create experiments or modify team members. Complete all of the required input fields on the About tab and first select Preview Project. Then, if everything looks fine, click Save Project. Please make sure all changes are saved or they will be lost. The preview page does not save the content. Figure 4: Project - About Tab

4 Warnings The Project Editor will provide a warning when you try to access details of the project that are not available. For example, if you try to edit the experiments before saving your project, the Project Editor will provide a warning prompting you to save your project first (Figure 5). Required Input Fields Figure 5: Project Editor Warning Input fields with red asterisks are required by the Project Editor (Figure 6). All other input fields are optional. Not providing a required field yields an error. PI(s)/Administrator Figure 6: Required Input Field By default, you are the Administrator of the project. If you are uploading data on behalf of another person, enter their name in the PI field. If you have more than one PI on your project, enter the name of the primary PI in the PI field. Additional PIs can be entered using the Team Members tab after the About page is saved. All PIs as well as other team members must be registered NEEShub users. The PI and Administrator fields have an auto- suggest option that can help you identify NEEShub users. Begin by typing the last name of the PI or Administrator. Suggested names will appear below the field (Figure 7). Short Title Figure 7: Auto- suggest for PI or Administrator The content of the short title is displayed inside the tree of the Project Display. The maximum number of characters is sixty (60).

5 Multiple Value Fields Input fields with a plus button allow you to add multiple values for a single field. In Figure 8, the displayed project has two organizations. A third organization, University of Minnesota, can be added by selecting the plus button. Figure 8: Multiple Value Fields If you make a mistake, click the minus button to delete a value. Additional multiple value fields include the Sponsor and Website at the Project level and Equipment at the Experiment level. Project Photo Add a project photo by completing the fields on the right side of the page. The grayscale NEES logo shows where the image will appear in the Project Display (Figure 9). Status Figure 9: Project Photo Select if the project is a NEES or non- NEES initiative.

6 NEES Projects and Shared- Use: Most NEESR and Shared- Use projects will be created by the curator, Stanislav Pejša Please check with Stanislav prior to creating a NEES project to see if your project has already been created. These projects have to follow the NEEScomm Data Sharing and Archiving Policies and Guidelines. Other, Demo, Internal: A description for each non- NEES project category is provided in the Project Editor. If you have a question about a project category, please contact the curator, Stanislav Pejša (spejsa@purdue.edu). NEES, Shared- Use, and Other are considered research projects. Demo is considered temporary and the content of these projects won't be preserved. Access Settings Set the access setting by choosing public, protected, or private. By default, projects are private and only team members will be able to view the project. However, the project metadata, such as names of PI and co- PIs, project title and description will be visible regardless of access settings. Experiment To create a new physical experiment, go to the Experiments tab and click Create New Experiment (Figure 10).

7 Figure 10: Create New Experiment After selecting Create New Experiment, you will be directed to the About tab for the experiment (Figure 11). Similar to the Project tab, you must first save your new experiment before you can access the information in the additional tabs. To save your new experiment, complete all of the required input on the About tab and select Save About. Figure 11: Experiment - About Tab There are ten tabs at the experiment level for physical experiment. Drawings, Videos, Photos, Documentation, and Analysis upload files to their respective directories. Adding Equipment There is a link between the Facility and Equipment of an experiment. First select the experiment s facility and click the plus button to add the facility. Once the facility is selected, a list of equipment for that facility will appear (Figure 12). Figure 12: Adding Equipment Specimen The Specimen tab allows you to describe your test specimen. Begin by creating a new specimen (Figure 13). Only one specimen is created for each experiment.

8 Figure 13: Specimen The Specimen Name will appear at the experiment level in the Specimen Type field and the specimen Description will appear at the experiment level in the Material field. Components: A specimen consists of one or more components. To add a component to your specimen, select New Component. The New Component link will only appear after you have created your specimen. You must add a component to your specimen to add material properties. Materials: A component consists of one or more materials that describe the component. To add a material to your component, select New Material. The New Material link will only appear after you have created a component. Sensors The Sensors tab allows you to upload your sensor location plan. A sensor location plan is used to describe the sensors in the experiment. To upload multiple sensors, use the Excel file called SensorTemplate.xls. The sensor template could be downloaded from the help links in the right hand side of the sensor page (Figure 14). You must create a location plan before uploading sensors. More information on the supported sensor types, required fields, and measurement units for the location plans could also be found through the help links on the sensor page (Figure 14). For more instructions on the sensor template, please refer to appendix A.

9 Figure 14: Multiple Sensor Upload Each location plan is connected to a single DAQ configuration. A DAQ configuration is used to describe the data acquisition system and setup for the experiment, and will be automatically created when uploading the sensor location plan. After the sensor location plan is successfully uploaded, the DAQ configuration can be edited and configuration files could be uploaded if applicable (Figure 15, 16). Figure 15: Sensor Location Plan

10 Figure 16: Edit DAQ configuration Drawings Currently, only PNG, JPG, and GIF image file types are supported on NEEShub. Drawings are further categorized into four groups: Drawing, Drawing Sensor Layout, Drawing Specimen, and Drawing Setup. Drawings in PDF or DWG can be uploaded to the Documentation folder IN ADDITION to individual drawings uploaded to the Drawings tab. File Upload When uploading files, the Title is a required field. All other fields are optional. The maximum file size for uploading is limited to 650MB in the Project Editor. If want to upload files with file size larger than 650MB, please use PEN to do the uploading ( Please note that special characters in file names could prevent the files from uploading. The following characters are not allowed in file name: %, $, \, /, #, ', ", ^, ~, *, &, (, ), {, }, [, ], and a leading. (period). Under the photos and videos tabs, multiple files can be uploaded at once using the Project Editor (Figure 17). It is limited to 15 files to upload at one time. A unique title will be generated for multiple files upload; however, the same description will be used for each file, if a description is provided.

11 Figure 17: Multiple files uploading When uploading document types like publications, journals, and theses, they can be contributed as NEEShub resources in Project Editor. To contribute your documents, set the document type to be publication, journal, or thesis (Figure 18), and complete the required fields for contributing documents (Figure 19). Figure 18: Choose document type to show additional input fields

12 Figure 19: Complete required fields to contribute documents Data The Data tab can be used to upload or edit data files. Use the links on the left of your screen to create new trials and repetitions. By default, the first repetition for a trial is created automatically, along with the Converted, Corrected, Derived, and Unprocessed data directories for that repetition (Figure 20). When uploading files under the Data tab, the Default Tool option will appear. If applicable, select the tool that should be used to open the file. Currently indeed is the only tool available. Figure 20: Data Directories at the Repetition Level Descriptions for the four data types are provided below: Unprocessed Data (Raw): Data as they come out of the data acquisition (DA) system. Preferably, these data should be stored in volts or the applicable electrical unit, in tab delimited

13 ASCII files. If data from the DA are provided in engineering units, then the researcher should also provide the calibration values used to process the data, the configuration files for the DA, and any other file required to understand the DA process. Converted: Data in ASCII 1 format (tab columns), converted from volts to engineering units, and without zero offsets (if applicable). If the DA outputs data meeting this description these files will simply be duplicates of the files under unprocessed data. Corrected: Data in ASCII 1 (tab separated columns) format in engineering units and may be corrected to exclude noise, malfunctioning sensors, calibration errors, etc. Derived: Files that include the corrected data plus columns of data that are functions of existing columns. This data may be re- sampled if appropriate. Derived data is what the researcher wants to show to the world. If applicable, photos and video may also be uploaded as data. If the photo or video is unaltered, then it should be categorized as Unprocessed data. If the photo or video has been altered, then it could be categorized under Corrected or Derived data. Corrected data could be a photo or video that has had lens distortion correction, while Derived data may be a photo or video that has been edited for a presentation. For more dertails refer to the NEEScomm Data Sharing and Archiving Procedures at Videos Videos have two options: movie file (i.e. *.mov, *.avi, *.wmv) or frames. If you have a video consisting of frames from a tool such as RDV, zip or tar the directory that holds the images and upload the zip or tar file. Do not upload individual image files. Photos Photos are separated into two groups: Data or Other. Data- photos are photo files located in the data directories (Converted, Corrected, Derived, or Unprocessed). To view the Other photos, select the Other radio button at the top of the Photo tab (Figure 21). Figure 21: Photo Types 1 ASCII format is preferable. Tools in the Hub have been programmed to work with ASCII format. Other formats may be accepted but may not be supported by Hub tools.

14 Filmstrip photos appear at the top of the Experiment pages in the Project Display. To select the filmstrip photos, use the Filmstrip Photo button in the Photos tab of the Project Editor (Figure 22). Security Figure 22: Filmstrip Photo Button The access setting of an experiment is not connected to the project or other experiments in a project. By default, experiments are private and only team members will be able to view the experiment. Once an experiment is competed and curated, the team members should change the security settings to PUBLIC. Simulation To create a new simulation, go to the Experiments tab and click Create New Simulation (Figure 23). Figure 23: Create New Experiment After selecting Create New Simulation, you will be directed to the About tab for the simulation (Figure 24). Similar to the Project tab, you must first save your new simulation before you can access the information in the additional tabs. To save your new simulation, complete all of the required input on the About tab and select Save About. Figure 24: Simulation - About Tab

15 There are eight tabs at the experiment level for simulation. Photos, Documentation, and Analysis upload files to their respective directories. Model The model tab allows you to describe your simulation model. Begin by creating a new model (Figure 25). Model types could be selected from a dropdown menu. Available model types include beam, bridge, building, column, fluid, foundation, other, pipeline, and soil. Figure 25: Create new model After a new model is created, any related model files could be uploaded to better describe the model (Figure 26). The model name will appear at the experiment level in the Model field. Figure 26: Upload files for simulation model Environment

16 The environment tab allows you to describe your hardware and software setup along with any files. Begin by creating new environment (Figure 27). Only one environment is created for each simulation. Upload related files to the environment after it is created. The environment name will appear at the experiment level in the Setup field. Figure 27: Create new environment Data The Data tab can be used to upload or edit data files. Use the links on the left of your screen to create/edit new run. Each run consists of three data directories: ComputationalModel, Input, and Output (Figure 28). Figure 28: Data Directories at the simulation run Level

17 Hybrid Simulation To create a new hybrid simulation, go to the Experiments tab and click Create New Hybrid Simulation (Figure 29). Figure 29: Create New Experiment After selecting Create New Hybrid Simulation, you will be directed to the About tab for the experiment (Figure 30). Similar to the Project tab, you must first save your new hybrid simulation before you can access the information in the additional tabs. To save your new hybrid simulation, complete all of the required input on the About tab and select Save About. Figure 30: Hybrid Simulation - About Tab Specimen The Specimen tab for hybrid simulation uses the same structure as the specimen tab for physical experiment. Create components and materials for the specimen under the experiment level, and then the components can be used and assigned to specific physical substructure or analytical substructure under each coordinator substructure group (for coordinator substructure group, see instructions below). Coordinator With hybrid experiment, we are introducing the ʻCoordinatorʼ tab. The coordinator sends signals between the physical and analytical substructures. After creating the hybrid experiment, the Project Editor provides the user with a default coordinator and coordinator substructure group (Figure 31). Users should click the [Edit] links to update their respective metadata. Clicking on the create and edit coordinator substructure group links triggers a popup window. To add a traditional experiment

18 or simulation to the current substructure group, users should click the respective, ʻCreate New Physical/Analytical substructureʼ link. Figure 31: Hybrid Simulation - Coordinator Tab Editing the coordinator is illustrated below (Figure 32). Users should provide information about the model, setup, data, documentation, analysis, and security. Under the data tab, users will store the output from the coordinator system. Figure 32: Edit Coordinator

19 Assembly The assembly tab is used to upload images files illustrating how the hybrid simulation should be assembled. The acceptable image file formats include: PNG, JPG, JPEG, and GIF. Team Members All team members must be registered NEEShub users. If you have grant privileges, you have the ability to add or delete people in a project. To add a new team member, use the Add Team Member field at the top of the page. The field will automatically suggest registered NEEShub users as you type your member s name. Additionally, grant privileges allow you to edit the roles and permissions for team members (Table 1). Table 1: Team Member Roles Role View Create Edit Delete Grant Access to group space Manager of group space Description (Default Role) Team member can view all files in the project and/or experiment Team member can create new experiments Team member can change descriptions, upload files, etc. for the project and/or experiment Team member can delete files and experiments Team member can add members to and delete members from the project and control access to experiments (Default Role) Team member can access the group space associated with the project, and share content and conversation within the group Team member can add members to and delete members from the group space and assign roles to members Users with grant permission can also control who has access to the project and who has access to each experiment (Figure 33). For example, you can limit the access to a newly created experiment until initial data verification has been completed. After which you may make the experiment accessible to all team members. It is important to note that data that is not available to all group members is not available to be read by the tools on NEEShub.

20 Editing Projects Figure 33: Editing Team Members After creating your project or experiment, you can easily edit it later. From the Project Warehouse menu on NEEShub, click My Projects and select the project you would like to update. On the right side of the page, a link appears that says, Edit this Project, (Figure 34). A similar link appears for experiments. After clicking the link, you will be redirected to the Project Editor. It should be noted, that you must be logged in to NEEShub for the edit link to appear on your project and experiment pages. Deleting Figure 34: Edit Project Link Researchers do have the ability to delete files, repetitions, experiments, or projects. However, they should consider carefully before they delete an experiment, trial, or repetition because their sequential names (Experiment- 1, Experiment- 2, Trial 1, and Trial- 2.) are written into the database. Once these items are deleted, they can't be used again within the same context. This means that if researchers delete Experiment- 1, they can't use that name, which is system generated, again. Researchers are advised to delete files freely, but only edit the representations of research workflow levels (experiment, trial, repetition). This is not a bug, but a feature of the database architecture and cannot currently be "fixed".

21 Files, Folders, Repetitions, and Trials NEEShub.org Project Editor Guide There are two methods to delete files, folders, repetitions, and trials. The first method is the delete link to the right of the file or folder in the Manage column (Figure 35). The second method is the delete button at the bottom of the page (Figure 35). Both delete options will spawn a dialog box prompting you to confirm the deletion (Figure 36). Note that you must check the I agree box in order for the delete button to appear at the bottom of the dialog box. In order to delete trial (Trial- #) or repetition (Rep- #) folders, the trial or repetition entity has to be removed. To the left of the directory listing, click either the 'Edit/Add Trial' or 'Edit/Add Repetition' link. Select the trial or repetition of interest. Pressing the 'Delete <Trial/Repetition>' button at the bottom of the popup will remove the desired entity and its folders. The trial or repetition will not be deleted unless all files have been previously removed. Figure 35: File Delete Options Experiments Figure 36: Delete Confirmation Dialog Box

22 Experiments can be deleted from their About tab via the Delete Experiment button at the bottom of the page (Figure 37). Experiment level files and folders located in the drawings, videos, photos, documentation, and analysis tabs can be deleted in the same way that the data files were deleted, i.e., browse to the appropriate tab and use one of the two delete methods. Once all of the files have been deleted from the experiment s repetitions and trials as well as its documentation, analysis, photos, videos, and drawings tabs, that experiment can be deleted. An experiment that contains empty trials, i.e., trials that contain no files, can still be deleted. Figure 37: Experiment Deletion Projects Projects can be deleted from their About tab via the Delete Project button at the bottom of the page (Figure 38). Project level files and folders located in the videos, photos, documentation, and analysis tabs can be deleted in the same way that experiment level files were deleted, i.e., browse to the appropriate tab and use one of the two delete options. In order to delete a project, there is an additional requirement that all of the files be deleted from the dropbox of the project group (the group that is automatically created when the project is created); this can be done using SynchroNEES or Webdav. Once all of the files have been removed from the project group s dropbox, the project s experiments, and the project s videos, photos, documentation, and analysis tabs, that project can be deleted. A project that contains empty experiments, i.e., experiments that contains no files, can still be deleted. Figure 38: Project Deletion

23 Curation Self- check A curation self- check dashboard (Figure 39) is available in Project Editor to provide easy curation self- check. Besides providing researchers with fast feedback whether all curation requirements are met (i.e., that all files are in the correct location and in the right format), the self- check also enables communication with the NEEScomm data curator. The curation dashboard is available at both project level and experiment level. When you see red a check mark, it indicates that either files are missing or they are not uploaded to correct location. Note that changes made to the project (or experiment) about page will not be reflected in the curation dashboard until you save the about page. In addition to the curation status check marks, you can use the provided box (Figure 39) to communicate with the NEEScomm curator about your curation status and any questions you may have. You can also use the box to alert the curators to any curation and data management issues of your experiment of which they should be aware. Once you think your project is ready for curation, send a curation request to the curator. Figure 39: Curation Self- check Dashboard

24 Appendix A. Sensor Template A.1 Purpose and introduction of sensor template The sensor template is used to upload the sensor location plan. It can be uploaded through the Project Editor under the sensor tab in the experiment level on NEEShub. The sensor location plan is an important metadata for projects on NEEShub. We envision that besides providing users with quick reference to sensors used during the test, it will also be used for visualization and 3D modeling of the instrumentation of the specimen. In order to ensure consistency of documenting sensors in the Project Warehouse, the use of the provided template is required, unless the template does allow for display of meaningful sensor metadata.

25 A.2 Guidance and Requirements for the Sensor Template Sensor Label (required): Sensor Type (required): Comment: Position (required): Position Units (required): Orientation: Coordinate Space: (required) This column collects sensor label or sensor name information. Sensor labels should be consistent with that in the sensor layout drawings and data files. Sensor labels have to be unique. Any duplication of sensor label or empty cells in this column will cause error in uploading the Sensor Location Plan. This column collects sensor type information (e.g. LVDT, Accelerometer). For currently supported sensor types on NEEShub, please refer to the page: Sensor types need to follow the certain format shown in the page above, otherwise the sensor location plan cannot be uploaded. To request adding new sensor types, submit a ticket on NEEShub to describe the need and the proposed format of the sensor type. This column is a required field in the current template. This column collects custom comments or any additional information regarding sensors. For sensors with two Position points that are both important (e.g. string pot in some cases), the Comment column is recommended for entering the end point of the sensor. The Position column is for entering the start point. The format of putting the end point in Comment is as: end point (1.5, 20, 1). This column collects coordinates (X, Y, Z) of sensor positions. All position coordinates should be based on the global coordinate space. This column is a required field in the template. If the character of tests does not allow to populate this column, please contact the curators at data.curator@nees.org. Units for Position coordinates (e.g. m, in, etc.). For currently supported units, please refer to: This column is a required filed in the current template. Sensor orientations in the form of (I, J, K). The value in this column can only be Global Coordinate Space. Please make sure to use the exact phrase, otherwise the sensor template cannot be uploaded successfully. Other coordinate spaces are not allowed in the current template. This column is a required field in the current template.

26 Serial Number: (recommended) Measurement Units: (required) DA Channel Number: (required) Channel Name: (required) Calibration Constant Value (required): Units (required): Zero Offset Value: Units: Serial number of sensors. This column is highly recommended, especially for tests that use NEES instruments. Sensor measurement units in engineering units. For currently supported measurement units, please refer to: Measurement units have to follow the format exactly as shown in the reference page above. Please use the full name of the unit if there is any superscript, subscript or Greek letter in the abbreviation name (e.g. cm/s 2 should be put as centimeter per second squared ). This column is a required field in the current template. Channel numbers for the Data Acquisition System. The values in this column have to be numeric and unique. Duplications in this column will cause failure in uploading the sensor list. This column is a required field in the current template. Channel names for the Data Acquisition System. The values in this column should be consistent with the channel names shown in the data files (if apply). This column is a required field in the current template. The value of calibration constant (or sensitivity) of sensors. Calibration constant (or sensitivity) is defined in terms of the relationship between input physical signal and output electrical signal. This column is a required field in the current template, regardless whether the data were already converted by the DAQ system. Units for calibration constant (e.g. V/in, mv/g, etc.). For currently supported calibration constant units, please refer to: This column is a required field in the current template. The value for zero offset. Zero offset is defined as the deviation measured at the origin point of the sensor measurement. Units for zero offset. Nonlinearity % of F.S.: The value of nonlinearity (also called linearity), in the form of the percentage of nonlinearity respect to the full- scale dynamic range.

27 F.S.: Excitation Voltage: Nonlinearity (also called linearity) is the maximum deviation from a linear transfer function over the specified dynamic range. Full- scale of the dynamic range. The excitation voltage (in Volt) applied on the sensor.