README.md

INSTALL

Equipment installation, configuration and connection details.

FILES

Meta information for the GeoNet equipment network.

• antennas.csv - GNSS observation antennas

• radomes.csv - GNSS installed antenna radomes

• metsensors.csv - GNSS met sensors attached to receivers

• receivers.csv - GNSS observation receivers

• firmwares.csv - GNSS receiver firmware versions

• sessions.csv - GNSS receiver session configurations

• sensors.csv - Recording sensors

• recorders.csv - Combined sensor and datalogger recorders

• dataloggers.csv - Recording dataloggers

• connections.csv - Datalogger and sensor connection details

• streams.csv - Datalogger and recorder sampling configurations

• polarities.csv - site specific polarity settings which indicate when a site may have reversed polarity, or otherwise

• gains.csv - site specific settings applied to individual sensors that may impact overall sensitivities.

• calibrations.csv - Individual sensor sensitivity values that can be used rather than default values.

• components.csv - Individual sensor elements including measurement position and responses.

• channels.csv - Individual datalogger recording elements including digitiser position, sampling rate, and responses.

• preamps.csv - site specific settings applied to individual datalogger pre-amplification that may impact overall sensitivities.

• telemetries.csv - site specific settings applied to datalogger and sensor connections that may use analogue telemetry.

• timings.csv - site specific settings to indicate time corrections that may need to be applied to archived raw data.

• cameras.csv - Installed field cameras.

• doases.csv - Installed field DOAS (Differential Optical Absorption Spectrometer) equipment.

GNSS

ANTENNAS

A list of antenna installations.

Field	Description	Units
Make	Installed antenna make
Model	Installed antenna model name
Serial	Installed antenna serial number
Mark	Installed Mark code
Height	Installed height	metres above the mark
North	Installed offset north	metres
East	Installed offset east	metres
Azimuth	Installed azimuth [ degrees clockwise from north
Start	Antenna installation start time
Stop	Antenna installation stop time

RADOMES

A list of radome installations associated with GNSS antenna installations.

Field	Description	Units
Make	Installed radome make
Model	Installed radome model name
Serial	Installed radome serial number
Mark	Installed radome associated GNSS Mark
Start	Radome installation start time
Stop	Radome installation stop time

METSENSORS

A list of metsensor installations attached to GNSS receivers

Field	Description	Units
Make	Installed met sensor make
Model	Installed met sensor model name
Serial	Installed met sensor serial number
Mark	Installed met sensor associated GNSS Mark
IMS Comment	Header comments
Humidity	Humidity sensor accuracy	% rel H
Pressure	Pressure sensor accuracy	hPa
Temperature	Temperature sensor accuracy	deg C
Latitude	Installed met sensor latitude	degrees north
Longitude	Installed met sensor longitude	degrees east
Elevation	Installed met sensor elevation	metres
Datum	Installed met sensor datum used to define the latitude, longitude, and elevation
Start	Installed met sensor installation start time
Stop	Installed met sensor installation stop time

RECEIVERS

A list of GNSS receiver installations.

Field	Description	Units
Make	Deployed GNSS receiver make
Model	Deployed GNSS receiver model name
Serial	Deployed GNSS receiver serial number
Mark	Associated deployment GNSS Mark
Start	Receiver deployment start time
Stop	Receiver deployment stop time

FIRMWARES

A list of GNSS receiver firmware versions.

Field	Description	Units
Make	GNSS receiver make
Model	GNSS receiver model name
Serial	GNSS receiver model serial number
Version	Installed receiver firmware version
Start	Receiver firmware start time
Stop	Receiver firmware stop time
Notes	Extra firmware notes

SESSIONS

A list of GNSS Receiver and Antenna recording sessions

Field	Description	Units
Mark	Session GNSS Mark
Operator	Deployed equipment operator information
Agency	Deployed equipment agency information
Model	Configuration model details
Satellite System	Configured receiver satellite settings
Interval	Configured receiver sampling interval	seconds
Elevation Mask	Configured receiver elevation mask	degrees above the horizon
Header Comment	Configuration comments
Start	Session start time
Stop	Session stop time

SIGNAL RECORDING

SENSORS

A list of sensor installations. The scale factor and bias can be used for external adjustments, such as a pressure sensor being used to measure water depth in salt water.

Field	Description	Units
Make	Installed sensor make
Model	Installed sensor model name
Serial	Installed sensor serial number
Station	Installed recording station
Location	Installed sensor site location
Azimuth	Installed sensor azimuth	degrees clockwise from north
Dip	Installed sensor dip	degrees down from horizontal
Depth	Installed sensor vertical offset	metres positive downwards
North	Installed sensor offset north	metres
East	Installed sensor offset east	metres
Scale Factor	Optional installation specific gain adjustment	defaults to "1.0"
Scale Bias	Optional installation specific level adjustment	defaults to "0.0"
Start	Sensor installation start time
Stop	Sensor installation stop time

RECORDERS

A list of recorder installations, these are considered to be a combination of a sensor and a datalogger that are always installed as a set.

Field	Description	Units
Make	Installed recorder make
Sensor	Installed recorder sensor model name
Datalogger	Installed recorder datalogger model name
Serial	Installed recorder serial number
Station	Installed recording station
Location	Installed recording site location
Azimuth	Installed recorder azimuth	degrees clockwise from north
Dip	Installed recorder dip	degrees down from horizontal
Depth	Installed recorder vertical offset	metres positive downwards
Start	Installation start time
Stop	Installation stop time

DATALOGGERS

A list of datalogger deployments at a given place. Multiple dataloggers at a place can be distinguished by using an option role description. These are attached to the datalogger's associated sensors via connection records.

Field	Description	Units
Make	Deployed datalogger make
Model	Deployed datalogger model name
Serial	Deployed datalogger serial number
Place	Deployed datalogger place
Role	Optional datalogger role at the place
Start	Deployment start time
Stop	Deployment stop time

CONNECTIONS

A list of datalogger connections, these are used to attach the sensors at a given site location to the dataloggers deployed at the associated place. Multiple dataloggers installed at the same place are distinguished by an operational role, if required. For dataloggers that have different response characteristics depending on what channel number (or pin) is used, an offset can be given for the sensor channel start.

Field	Description	Units
Station	Recording station
Location	Sensor site location
Place	Datalogger deployment place
Role	Datalogger deployment role
Number	Initial datalogger pin, or channel, offset number used for the sensor
Start	Connection start time
Stop	Connection stop time

STREAMS

A list of datalogger sampling configurations for a given station and recording site.

Field	Description	Units
Station	Recording Station
Location	Recording locations Site
Band	Channel Band code
Source	Channel Source code
Sampling Rate	Nominal stream sampling rate	samples per second (Hz)
Axial	Whether the stream is configured for axial coordinates (Z12) or geographic (ZNE)	"yes" or "no"
Reversed	Whether the recorded signal should be reversed over the time window	"yes" or "no"
Triggered	Whether the stream represents triggered recordings	"yes" or "no"
Start	Stream start time
Stop	Stream stop time

The band and source codes are representatives of the FDSN channel naming convention as found at:

FDSN Source Identifiers: Channel codes

POLARITIES

Site specific times when the recorded values may have a reversed, or otherwise, polarity. This is often difficult to track with the known instrument responses and installation details as it can often be caused by in-field wiring or cabling changes from the expected standard.

There is also the possibility that there may be conflicting information or studies, where this is the case the Primary field can be used to indicate which one should be used for downstream processing.

To reduce the number valid Method entries these are defined as a set of "known" values, and an "unknown" one. Where possibly the code should be updated to add any standard polarity detection methods, there is also room to provide a reference citation for any associated studies.

Field	Description	Units
Station	Recording Station
Location	Recording location Site
Sublocation	Recording location Sublocation
Subsource	Recording location Subsource
Primary	Whether the entry takes precedence	"yes", "no", or blank.
Reversed	Whether the stream in the time window should be considered reversed or not	"yes" or "no"
Method	How this information was obtained	"study", "compass", or "unknown"
Citation	A reference citation for the method if appropriate	"key"
Start	Time window start time
Stop	Time window stop time

Notes:

• For the Subsource, this can either be individual entries (e.g., "Z", "N"), or multiple entries ("ZNE"), or it can be empty, which will be interpreted as all subsource values. (The subsource is the last character in the standard SEED channel naming convention, e.g. EHZ).

• If a citation is given the actual reference information should be given in the citations.csv file.

• An empty, or blank, Method is treated as unknown.

Example:

Station,Location,Sublocation,Subsource,Primary,Reversed,Method,Citation,Start Date,End Date
WEL,10,,Z,,true,compass,,2022-07-28T01:59:00Z,9999-01-01T00:00:00Z

GAINS

Site specific gain settings applied to correct for local conditions. A list of installation times where gains need to be applied to datalogger or sensor settings. For the scale factor and bias either a value can be given directly or an expression can be used if that makes it clearer where the number has come from.

Field	Description	Units
Station	Datalogger recording Station
Location	Recording sensor site Location
Sublocation	additional location identifier for multi-parametric sensors installations, if applicable
Subsource	The sensor channel(s), as defined in the response configuration, which requires a gain adjustment, multiple subsource channels can be joined (e.g "Z" or "ZNE").
Scale Factor	Scale, or gain factor, that the input signal is multiplied by prior to digitisation, or for polynomial responses it is the factor used to convert Volts into the signal units. If this field is empty, it should be assumed to have a value of 1.0 which in theory should have no impact.
Scale Bias	An offset value that needs to be added to the signal prior to digitisation or to raw digital data. The offset indicates a polynomial response is expected, if this field is blank it is assumed that the value is 0.0.
Absolute Bias	An offset value that needs to be added to the signal after the scale factors have been applied to the polynomial response, if this field is blank it is assumed that the value is 0.0.
Start	Gain start time
Stop	Gain stop time

For a second order polynomial response, the output is expected to be Y = a * X + b where X is normally the input voltage, and Y the corrected signal. The terms a and b are the factor and bias respectively. The gain adjustments (a', b', c', the scale factor, scale bias, and absolute bias respectively) update this via Y = (a * a') * X + (b * a') + (a * b') + c'

CALIBRATIONS

Sensor specific calibrations that may impact overall sensitivity. A list of installation times where calibrated values of the Sensor sensitivity are known and can be used to override the default Model sensitivities. For the component, sensitivity, and frequency either a value can be given directly or an expression can be used if that is more readable.

Field	Description	Units
Make	Sensor make
Model	Sensor model name
Serial	Sensor serial number
Number	The sensor component or datalogger digitiser channel, as defined in the response configuration or elsewhere, which overrides the default values, a blank value is interpreted as the first sensor component, or "pin" zero.
Scale Factor	Sensitivity, or scale factor, that the input signal is generally multiplied by to convert to Volts, or for polynomial responses the value used to convert Volts into the signal units. A blank value is expected to be read as 1.0, an explicit value of zero is required to be entered if intended.
Scale Bias	A scale bias factor, for polynomial responses that is multiplied to any Gain bias values before adding to the converted volts to give the signal values. If this field is blank it should be assumed that the value is 1.0.
Scale Absolute	An offset, or bias, for polynomial responses that is added to the converted volts to give the signal values. If this field is blank it should be assumed that the value is 0.0.
Frequency	Frequency at which the calibration value is correct for if appropriate.
Start	Calibration start time
Stop	Calibration stop time

For a second order polynomial response, the output is expected to be Y = a * X + b where X is normally the input voltage, and Y the corrected signal. The terms a and b are the scale factor and the absolute bias respectively. The scale bias c can be used with gain biases, e.g. for a gain adjustment of the equivalent (a', b', c') values, then the polynomial adjustment will follow: Y = a' * a * X + b * a' + a * b' * c + c'.

COMPONENTS

Sensor model component descriptions. The type is generally of the form "Accelerometer, Short Period Seismometer" etc. The number represents the order of sensor components, this generally maps to the sensor cable and how it is connected into the datalogger. Subsource is the general term used for labelling the sensor component and is usually the last character in the SEED channel convention. Dip and Azimuth are used to indicate the relative position of the sensor component within the sensor package and will be used with the overall sensor installation values to provide component dips and azimuths.

For derived streams, such as a simple gain or unit conversion, can be indicated by providing an input sampling rate. This is matched by the equivalent Stream and allows for the response to be generated with the provided reference response only.

Field	Description
Make	Sensor make
Model	Sensor model name
Type	Sensor type
Number	Sensor component offset
Source	Sensor source as used for the matching streams
Subsource	Sensor component label
Dip	Internal dip of the component relative to whole sensor
Azimuth	Internal azimuth of the component relative to whole sensor
Types	A shorthand reference to the SEED type labels
Sampling Rate	An input sampling rate which can be used to indicate a derived stream
Response	A reference to the nominal StationXML response

CHANNELS

The individual channels configured for a given datalogger model, these include the channel numbers and sampling rates. The channel number is an offset into the digitiser or digitisers and are used to match the connected sensor component and the expected response. Some digitisers have different nominal responses for different groups of digitiser channels.

Field	Description
Make	Datalogger make
Model	Datalogger model name
Type	Datalogger type
Number	Datalogger channel offset, an empty value will map to zero
Sampling Rate	Configured Channel sampling rate
Response	A reference to the nominal StationXML response

PREAMPS

Field	Description	Units
Station	Datalogger recording Station
Location	Recording sensor site Location
Subsource	The sensor channel Subsource which has the preamp configured (e.g "Z"). An empty value indicates all channels have this setting for the provided Location.
Scale Factor	The datalogger pre-amp scale factor used for this time span. These tend to be integer steps and may be referenced as gain settings.
Start	Preamp start time
Stop	Preamp stop time

TELEMETRIES

Sometimes the datalogger and the sensor are not at the same location. Usually this means there is some form of analogue link between the two, either a dedicated telephone line, or an FM radio link. This table allows this to be documented, and provides a mechanism to adjust the signal gains if known.

Field	Description	Units
Station	Datalogger recording Station
Location	Recording sensor site Location
Scale Factor	The telemetry gain factor for the analogue link, this represents the amplification of the signal if appropriate, an empty value is assumed to be 1.0
Start	Telemetry start time
Stop	Telemetry stop time

CAMERA

CAMERAS

A list of camera installations, these include values for:

Field	Description	Units
Make	Installed camera make
Model	Installed camera model name
Serial	Installed camera serial number
Mount	Camera mount code
View	Camera view code
Dip	Installed camera dip	degrees down from horizontal
Azimuth	Installed camera azimuth	degrees clockwise from north
Height	Installed camera vertical offset	metres positive upwards
North	Installed camera offset north	metres
East	Installed camera offset east	metres
Start	Installed camera start time
Stop	Installed camera stop time
Notes	Extra installation information, currently the photo caption.

DOAS

DOASES

A list of doas installations, these include values for:

Field	Description	Units
Make	Installed DOAS make
Model	Installed DOAS model name
Serial	Installed DOAS serial number
Mount	DOAS mount code
View	DOAS view code
Dip	Installed DOAS dip	degrees down from horizontal
Azimuth	Installed DOAS azimuth	degrees clockwise from north
Height	Installed DOAS vertical offset	metres positive upwards
North	Installed DOAS offset north	metres
East	Installed DOAS offset east	metres
Start	Installed DOAS start time
Stop	Installed DOAS stop time

TIMINGS

There are some data sources which may have timing issues and the type of recording format means that the archived raw data will include the bad timing and a correction will need to be applied.

Likewise, some sites may have a timing issue that cannot easily be corrected, this table allows this correction to be stored for use with processing systems or otherwise.

The correction should be "added" to the sensor sample times, for when the clock is fast this value should be negative. The format can follow a standard go convention:

A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix,
such as "300ms", "-1.5h" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".

Field	Description	Units
Station	Recording Station
Location	Recording location Site
Correction	Recorded data required time correction
Start	Time window start time
Stop	Time window stop time

Example:

Station,Location,Correction,Start Date,End Date
NZB,42,-24h,2023-12-07T14:15:00Z,9999-01-01T00:00:00Z

NOTES

Dates should be given as in ISO 8601 (i.e. 2016-09-18T02:24:26Z), future dates should be given in the form: 9999-01-01T00:00:00Z.