wiki:SIS/UI/Tutorial-v1.0/Intro

Version 4 (modified by skientz, 5 years ago) (diff)

--


                          This Page Under Construction 

Station Information System (SIS) Tutorial

Introduction

User Authentication

Logging In

Changing Your Password

Logging Out

SIS Home Page

Section: Stations

Jump to Station

Telemetry Locations

Create New Location

Other Links in this Section

Section: Instruments

Sensortypes

Inventory

Create New Sensor

Loggertypes

Inventory

Create New Logger

Owner Agencies

Section: Power and Telemetry Devices

Create New Devicetype

Create New Devicemodel

Create New Device

Administrative

SIS Products

Related SIS Tutorial Documents

Station/Channel Data

Instrument Inventory/Response

Power/Telemetry Hardware

Introduction

The Station Information System (SIS) is the repository for station metadata in Southern California Seismic Network. It consists of a database that stores information for the applications that use station metadata from the array, as well as a web interface for users to make changes to the metadata due to field work or quality control. This document describes how to use the web interface.

The interface to the test website is intended to replicate the interface to the production site, with the difference being the database itself. The test site is used for demonstrations and tutorials, while the production site should be used for recording actual changes to station metadata. Products such as dataless SEED target the production database.

Authentication

Most information in SIS is viewable without needing a user account. However, user authentication is required to make changes to the data. Please contact Faria Chowdhury (faria@gps.caltech.edu) to obtain an account on the production and/or test website. Note: If you have accounts on both sites, changing your password on the production site has no effect on your password for the test site (and vice versa).

Logging In

To log in, go to the website and click on the link ‘Log in’ in the top-right corner of the page. This takes you to the login form that requests your username and password:

Figure 1: Login Form

Changing Your Password

When you are logged in, a link to change your password appears in the top-right corner:

Figure 2: New links appear in the header for authenticated users logging out

When you are done, please remember to click on the link ‘Log out’ in the top-right corner to end your session. This prevents unauthorized changes to the database from your account.

SIS Home Page

The Home Page is divided into the following sections:

Stations
Links to the station pages and station/channel reports.
Instruments
Links to the instrument inventory and reports.
Devices
Links to the non-response (power/telemetry) hardware and reports.

Section: Stations

Links to the station pages and station/channel reports:

Jump to Station

This link takes you to a form to select a netcode from a dropdown menu, and a textbox to enter the desired station code (your entry for the station code is converted to uppercase before being processed by the database). Click the button to submit the form.

Figure 3: Jump to Station Form

The (netcode, stationcode) uniquely identifies a station in the SIS database. If the submitted (netcode, stationcode) exists in the database, you are re-directed to the station’s summary page. Every station in SIS has its own summary page accessible by either:

  1. station database id (e.g., /sis/station/31/summary/)
  2. Netcode and station-code (e.g., /sis/station/?net=CI&sta=BAR)

More information about the Station Summary page can be found in the document:_

Telemetry Locations

This link takes you to the list of telemetry hub locations in SIS. When you are logged in, there is a link on this page to create a new telemetry location.

Figure 4: Telemetry Locations Index page

Create New Location

The Location Form displays the fields found in the location header:

Figure 5. Location Form

Note: The Email Update Codes is an SCSN-specific field referring to the ‘station’ codes used by email archive database.

Enter the values (required fields are in bold) and submit the form to create a new location. If there are no errors, you are re-directed to the location’s summary page. More information about the location’s summary page is contained further on in this document.

Other links in this section

Google Earth KML files Listing of the various Google Earth KML files that are linked to the SIS database.

ARRA extension data

This link takes you to the sub-section dealing with information specific to the SCSN ARRA upgrades. Information in this section:

  1. Station Telemetry-types (qualitative description of the station telemetry)
  2. Station Landowner-types (landowner information)
  3. Station upgrades progress (Google map of the progress)

Stations by Network

This link takes to a list of the existing networks in the SIS database. The list contains both SCSN-operated and imported networks. Click on a netcode link to view the station list for that network.

Stations by loggertypes This is a report of the currently installed loggers of a selected type.

  1. The user selects the desired loggertype(s) (checboxes)
  1. Optionally filter the results by logger owner (dropdown)
  1. Optionally export the results to a .csv file that is readable by a spreadsheet program.

The user can sort the table by clicking on the arrows in the columns of the table display.

Stations by sensortypes

This is a report of the currently installed sensors of a selected type, along with the sensor’s logger.

  1. The user selects the desired sensortype(s) (checkboxes)
  1. Optionally filter the results by logger owner (dropdown)
  1. Optionally filter the results by sensor owner (dropdown)
  1. Optionally export the results to a .csv file that is readable by a spreadsheet program.

The user can sort the table by clicking on the arrows in the columns of the table display.

Instruments at active stations

This is a report of the currently installed loggers and sensors of selected type. This report allows the user to query for the stations that have a logger of selected type AND a broadband of a selected type AND an accelerometer of a selected type (i.e., the resultset is the intersection, not union).

Recent Response Changes

This report lists the stations and channel epoch ondate of the response changes logged in SIS. The user can filter by netcode, epoch ondate range.

Note: Filtering the resultset by the list of common ‘reasons’ is only available for stations where field actions were recorded via SIS. This means it is generally not available for imported stations.

More Station Reports

Sub-section that lists the available station-oriented reports generated by SIS.

Section: Instruments

Links to the instrument inventory and reports

Limitation: Although the SIS database schema is capable of storing various types of instruments such as amplifiers, discriminators, etc, the web interface currently only shows the inventory for sensors and dataloggers. Future development will focus on generalizing instrument-types for the web UI.

Sensortypes

This section concerns the sensor inventory and related information. The existing sensortypes (AKA sensor models) are listed, categorized under:

ACCELEROMETER BAROMETER VELOCITY TRANSDUCER

Limitation: Creating a new sensortype is currently executed via command-line scripts. Future development will allow this functionality through the UI.

Inventory

Click on the link ‘Sensors’ for any of the existing sensortypes. This takes you to a report of the existing sensors of that model. The user can filter the list by owner and/or inventory status.

Tip: To quickly find a sensor in the inventory list, use your browser’s Search tool (CTRL-F on most browsers) to search for a sensor by serialnumber.

The table displays the list of sensor serialnumbers along with some of the attributes contained in the sensor header. The attributes in the table are:

  1. Serialnumber (unique per sensortype)
  2. Inventory Status. Possible choices are: INSTALLED: instrument is currently installed at a station INVENTORY: instrument is not currently installed, is in the inventory pool INACTIVE: instrument is no longer in commission (inactivated from the pool) REPAIR: instrument is in repair UPGRADED-RANGE: This status was created to handle sensor upgrades based on the input range of the sensor (e.g. 2G sensor upgraded to 4G sensor).
  3. Owner agency
  4. Propertytag (owner-assigned propertytag if exist)
  5. Date Acquired (instrument acquisition date if known)
  6. Channeldefaults (read-only field used internally by SIS)

The table display links each sensor serialnumber to the sensor’s summary page. Every sensor in SIS has a summary page that displays information particular to that sensor.

Create New Sensor

For authenticated users, there is a link on each sensortype’s inventory page to create a new sensor of that model. Click on the link ‘Create new sensor’ to get to the New Sensor Form:

Figure 6. Create New Sensor Form (for Accelerometer)

The New Sensor Form contains 2 fieldsets:

  1. Sensor header fields (serialnumber must be unique for a given model)
  2. Initial Calibration fields (instrument response per component, per date-calibrated). Multiple calibrations can exist over the lifetime of a sensor; this is to specify an initial state.

Enter the values and submit the form to create a new sensor instrument in the database.

Tip: To create multiple sensors in succession, click on the ‘Save and add another’ button as a shortcut to return to this form. If there are no errors in the submitted data, you are re-directed to either:

  1. The sensor’s summary page (if you clicked Submit).
  2. Back to this form (if you clicked Save and Add another). You should see a message indicating that your previous submit has been successfully processed.

By default, a new sensor is created with inventory status=’INVENTORY’. This inventory status implies that the sensor is ready to be installed at a station.

More information about the sensor summary page is contained further on in this document.

Loggertypes

This section concerns the datalogger inventory and related information.

The existing loggertypes (AKA logger models) are listed with links to their inventory pool. Limitation: Creating a new loggertype is currently executed via command-line scripts. Future development will allow this functionality through the UI.

Inventory

Click on the link ‘Inventory’ for any of the existing loggertypes. This takes you to a report of the existing loggers of that model. The user can filter the list by owner and/or inventory status. Tip: To quickly find a logger in the inventory list, use your browser’s Search tool (CTRL-F on most browsers) to search for a logger by serialnumber.

The table displays the list of logger serialnumbers along with some of the attributes contained in the logger header. The attributes in the table are:

  1. Serialnumber (unique per loggertype)
  2. Inventory Status. Possible choices are: INSTALLED: instrument is currently installed at a station INVENTORY: instrument is not currently installed, is in the inventory pool INACTIVE: instrument is no longer in commission (inactivated from the pool) REPAIR: instrument is in repair
  3. Owner agency
  4. Propertytag (owner-assigned propertytag if exist)
  5. Electronic Serialnumber (manufacturer-assigned, if applicable)
  6. Date Acquired (instrument acquisition date if known)
  7. Channeldefaults (read-only field used internally by SIS)

The table display links each logger serialnumber to the logger’s summary page. Every logger in SIS has a summary page that displays information particular to that logger.

Create New Logger

For authenticated users, there is a link on each loggertype’s inventory page to create a new logger of that model. Click on the link ‘Create new logger’ to get to the New Logger Form:

Figure 7: New Logger Part 1 form

Enter the values (required fields are in bold) and click Continue. The logger is not yet created; the second part is the form for the initial calibration:

Figure 8: New Logger Part 2 form

The form is initialized with:

  1. the default number of boards for this loggertype (AKA sensor ports)
  1. the default number of modules per board (AKA channel cards)
  1. the default response for each module (sensitivity and frequency-of-sensitivity).

Enter in the date-calibrated and the board serialnumbers. The initial calibration date must be prior to the first install date of the logger. Multiple calibrations can exist over the lifetime of a logger; this is to specify an initial state.

Tip: To create multiple loggers in succession, click on the ‘Save and add another’ button. If there are no errors in the submitted data, you are re-directed to either:

  1. The logger’s summary page (if you clicked Submit).
  1. Back to the logger setup form (if you clicked Save and Add another). You should see a message indicating that your previous submit has been successfully processed.

By default, a new logger is created with inventory status=’INVENTORY’. This inventory status implies that the sensor is ready to be installed at a station.

More information about the logger summary page is contained further on in this document.

Owner Agencies

This link takes you to the list of owner agencies in SIS. The owner list is referenced by both the instrument inventory and the non-response hardware inventory to store ownership attribute of the instrument/device. When you are logged in, there is a link on this page to create a new owner.

Create New Owner

Figure 9. Owner Form

The owner code must be unique in the list of owners. Enter the values and submit the form. If there are no errors, you are re-directed to the owner’s summary page. In addition, the new owner is now present in the Owner dropdown menu in other forms. The owner’s summary page contains links to all the loggers and sensors owned by itself. Section: Power and Telemetry devices This section stores information about non-response devices. Devices are organized in the following hierarchy:

Devicetype: describes the functional use

Devicemodel: describes the Model/Manufacturer?

Device: a piece of hardware that can be installed at a location.

Limitation: The devicetypes are placed into either the Power or Telemetry hardwaretype category. Future development will focus on making the hardware category extensible.

Create New Devicetype

For authenticated users, there is a link in the Power Devicetypes section to create a new Power devicetype, and a similar link in the Telemetry section to create a new Telemetry devictype. Clicking on the link takes you to a form:

Figure 10. Devicetype form

The fields of the devicetype header are:

Devicetype: Name of the devicetype. Must be unique in the list of devicetypes. Hardwaretype: Select either Power or Telemetry Inventoryable: Yes or No. This states whether devices of this type are uniquely tracked by serialnumber.

If so, there exists an inventory pool of the devices. Each device is uniquely identified by a serialnumber and has an inventory status. If not, an anonymous device is automatically created upon installation of the devicemodel. The device serialnumber is optional.

Description: Short description of this devicetype

Enter the values and submit the form. If there are no errors, you are re-directed to the devicetype’s summary page. Create New Devicemodel

For a given devicetype, one or more devicemodels must exist that describe the Model/make of the devices. For authenticated users, a link appears to create a new devicemodel in the Devicemodels section. Click on the link ‘Create new devicemodel’ to get to the form (this example figure is for the CELLULAR-MODEM devicetype) :

Figure 11. Devicemodel Form

The fields of the devicemodel header (for all devicetypes) are:

Modelname: The name of the model. Must be unique for a given devicetype Manufacturer: The name of the manufacturer Description: short description of this model

Enter the values and submit the form. If there are no errors, you are re-directed to the devicemodel’s summary page. Create New Device

As explained above, the method to create a new device depends of the value of the inventoryable field of the devicetype:

If the devicetype is inventoryable: there is a link on the devicemodel’s summary page to create a new device that is uniquely identified by its serialnumber.

If the devicetype is non-inventoryable: the devicemodel summary page states that an anonymous device is automatically created upon installation at a location. (Installing devices is explained further on in this document).

Figure 12. Device Form

Regardless of how it was created, the fields of the device header are

Serialnumber: required for inventoryable devices, else optional. If required, must be unique within the list of devices for the given devicemodel. Date Acquired: Acquisition date if known. Owner: select from Owner agency dropdown menu Propertytag: owner-assigned propertag if exist Description: short description of the device

Enter the values and submit the form. If there are no errors, you are re-directed to the device’s summary page. More information about the device summary page is contained further on in this document.

This concludes the overview of the SIS Home Page. The next section focuses on the various summary pages that exist for the entities described above.

Administrative

User Activity Field Actions Lab Actions SIS Products Dataless SEED COSMOS V0 Related SIS-Tutorial Documents Station/Channel data

The Station Summary page displays information specific to a station. It allows authenticated users to modify the station metadata.

Instrument inventory/response

The Sensor Summary page displays information specific to the sensor. For authenticated users, the summary page shows links to modify the sensor’s response.

Power/Telemetry? hardware

The Logger Summary page displays information specific to the logger. For authenticated users, the summary page shows links to modify the logger’s response.

Attachments