MSNoise Admin is a web interface that helps the user define the configuration for all the processing steps. It allows configuring the stations and filters to be used in the different steps of the workflow and provides a view on the database tables.

$msnoise admin  Which, by default, starts a web server listening on all interfaces on port 5000. This can be overridden by passing parameters to the command, e.g. for port 5099: $ msnoise admin -p 5099


The next step consists of opening a web browser and open the ip address of the machine, by default on the current machine, it’ll be http://localhost:5000/ or http://127.0.0.1:5000/.

The top level menu shows four items:

## Home¶

The index page shows

• The project location and its database

• Stats of the Data Availability, the CC, STACK, MWCS and DTT jobs.

• Quick action buttons for resetting or deleting jobs.

The name and the logo of the page can be overridden by setting an environment variable with a name and the HTML tag of the logo image:

set msnoise_brand="ROB|<img src='http://www.seismologie.be/img/oma/ROB-logo.svg' width=200 height=200>"


## Configuration¶

### Station¶

Stations appear as a table and are editable.

Stations are defined as:

class msnoise.msnoise_admin.Station(*args)

Station Object

Parameters
• ref (int) – The Station ID in the database

• net (str) – The network code of the Station

• sta (str) – The station code

• X (float) – The X coordinate of the station

• Y (float) – The Y coordinate of the station

• altitude (float) – The altitude of the station

• coordinates (str) – The coordinates system. “DEG” is WGS84 latitude/ longitude in degrees. “UTM” is expressed in meters.

• instrument (str) – The instrument code, useful with PAZ correction

• used (bool) – Whether this station must be used in the computations.

Attributes
X
Y
altitude
coordinates
instrument
net
ref
sta
used

### Filter¶

Filters appear as a table and are editable. The filter parameters are validated before submission, so no errors should happen. Note: by default, the used parameter is set to False, don’t forget to change it!

Filters are defined as:

class msnoise.msnoise_admin.Filter(**kwargs)

Filter base class.

Parameters
• ref (int) – The id of the Filter in the database

• low (float) – The lower frequency bound of the Whiten function (in Hz)

• high (float) – The upper frequency bound of the Whiten function (in Hz)

• mwcs_low (float) – The lower frequency bound of the linear regression done in MWCS (in Hz)

• mwcs_high (float) – The upper frequency bound of the linear regression done in MWCS (in Hz)

• rms_threshold (float) – Not used anymore

• mwcs_wlen (float) – Window length (in seconds) to perform MWCS

• mwcs_step (float) – Step (in seconds) of the windowing procedure in MWCS

• used (bool) – Is the filter activated for the processing

Attributes
high
low
mwcs_high
mwcs_low
mwcs_step
mwcs_wlen
ref
rms_threshold
used

### Config¶

All configuration bits appear as a table and are editable. When editing one configuration item, the Edit tab shows extra information about the parameter, where it is used and its default value. Most of the configuration bits are case-sensitive!

Example view:

The table below lists the different fields:

Parameter Name

Description

Default Value

data_folder

Data Folder

output_folder

CC Output Folder in case keep_all=Y, to store the individual windows. The daily CCF will always be stored in the STACKS/001_DAYS folder.

CROSS_CORRELATIONS

data_structure

Either a predefined acronym [SDS]/BUD/IDDS,<br> or /-separated path (e.g. NET/STA/YEAR/NET.STA.YEAR.DAY.MSEED).

SDS

archive_format

Force format of archive files to read? Leave empty for slightly slower auto-detection by Obspy, or specify any format supported by obspy.core.stream.read.

network

Network to analyse [*]

channels

Channels need to match the value (ex: [*], *Z, BH*, HHZ,…)

startdate

Start Date to process: [1970-01-01]=’since beginning of the archive’

1970-01-01

enddate

End Date to process: [2100-01-01]=’No end’

2021-01-01

analysis_duration

Duration of the Analysis (total in seconds : 3600, [86400])

86400

cc_sampling_rate

Sampling Rate for the CrossCorrelation [20.0]

20.0

resampling_method

Resampling method Decimate/[Lanczos]

Lanczos

preprocess_lowpass

Preprocessing Low-pass value in Hz [8.0]

8.0

preprocess_highpass

Preprocessing High-pass value in Hz [0.01]

0.01

preprocess_max_gap

Preprocessing maximum gap length that will be filled by interpolation [10.0] seconds

10.0

preprocess_taper_length

Duration of the taper applied at the beginning and end of trace during the preprocessing, to allow highpassfiltering

20.0

remove_response

Remove instrument response Y/[N]

N

response_format

Remove instrument file format [dataless]/inventory/paz/resp

dataless

response_path

Instrument correction file(s) location (path relative to db.ini), defaults to ‘./inventory’, i.e. a subfolder in the current project folder.<br>All files in that folder will be parsed.

inventory

response_prefilt

Remove instrument correction pre-filter (0.005, 0.006, 30.0, 35.0)

(0.005, 0.006, 30.0, 35.0)

maxlag

Maximum lag (in seconds) [120.0]

corr_duration

Data windows to correlate (in seconds) [1800.]

overlap

Amount of overlap between data windows [0:1[ [0.]

0.0

windsorizing

Windsorizing at N time RMS , 0 disables windsorizing, -1 enables 1-bit normalization [3]

3

whitening

Whiten Traces before cross-correlation: [A]ll (except for autocorr), [N]one, or only if [C]omponents are different: [A]/N/C

A

whitening_type

Type of spectral whitening function to use: [B]rutal (amplitude to 1.0), divide spectrum by its [PSD]: [B]/PSD. WARNING: only works for compute_cc, not compute_cc_rot, where it will always be [B]

B

stack_method

Stack Method: Linear Mean or Phase Weighted Stack: [linear]/pws

linear

pws_timegate

If stack_method=’pws’, width of the smoothing in seconds : 10.0

10.0

pws_power

If stack_method=’pws’, Power of the Weighting: 2.0

2.0

crondays

Number of days to monitor with scan_archive, typically used in cron (should be a float representing a number of days, or a string designating weeks, days, and/or hours using the format ‘Xw Xd Xh’) [1]

1

components_to_compute

List (comma separated) of components to compute between two different stations [ZZ]

ZZ

cc_type

Cross-Correlation type [CC]

CC

components_to_compute_single_station

List (comma separated) of components within a single station. ZZ would be the autocorrelation of Z component, while ZE or ZN are the cross-components. Defaults to [], no single-station computations are done.

cc_type_single_station_AC

Auto-Correlation type [CC]

CC

cc_type_single_station_SC

Cross-Correlation type for Cross-Components [CC]

CC

autocorr

DEPRECATED, add the components to compute on single stations in the components_to_compute_single_station config parameter.

N

keep_all

Keep all cross-corr (length: corr_duration) [Y]/N

N

keep_days

Keep all daily cross-corr [Y]/N

Y

ref_begin

Beginning or REF stacks. Can be absolute (2012-01-01) or relative (-100) days

1970-01-01

ref_end

End or REF stacks. Same as ref_begin

2021-01-01

mov_stack

Number of days to stack for the Moving-window stacks ([5]= [day-4:day]), can be a comma-separated list 1,2,5,10

5

export_format

Export stacks in which format(s) ? SAC/MSEED/[BOTH]

MSEED

sac_format

Format for SAC stacks ? [doublets]/clarke

doublets

dtt_lag

How is the lag window defined [dynamic]/static

static

dtt_v

If dtt_lag=dynamic: what velocity to use to avoid ballistic waves [1.0]km/s

1.0

dtt_minlag

If dtt_lag=static: min lag time

5.0

dtt_width

Width of the time lag window [30]s

30.0

dtt_sides

Which sides to use [both]/left/right

both

dtt_mincoh

Minimum coherence on dt measurement, MWCS points with values lower than that will not be used in the WLS

0.65

dtt_maxerr

Maximum error on dt measurement, MWCS points with values larger than that will not be used in the WLS

0.1

dtt_maxdt

Maximum dt values, MWCS points with values larger than that will not be used in the WLS

0.1

plugins

Comma separated list of plugin names. Plugins names should be importable Python modules.

hpc

Is MSNoise going to run on an HPC? Y/[N]

N

stretching_max

Maximum stretching coefficient, e.g. 0.5 = 50%, 0.01 = 1%

0.01

stretching_nsteps

Number of stretching steps between 1-stretching_max and 1+stretching_max

1000

## Database¶

### Data Availability¶

Gives a view of the data_availability table. Allows to bulk edit/select rows. Its main goal is to check that the scan_archive procedure has successfully managed to list all files from one’s archive.

### Jobs¶

Gives a view of the jobs table. Allows to bulk edit/select rows. Its main goal is to check the new_jobs or any other workflow step (or Plugins) successfully inserted/updated jobs.