Help on the msnoise commands

This page shows all the command line interface commands

admin

msnoise admin --help

Usage:  [OPTIONS]

Options:
  -p, --port INTEGER  Port to open
  --help              Show this message and exit.

bugreport

msnoise bugreport --help

Usage:  [OPTIONS]

  This command launches the Bug Report script.

Options:
  -s, --sys      System Info
  -m, --modules  Modules Info
  -e, --env      Environment Info
  -a, --all      All Info
  --help         Show this message and exit.

compute_cc

msnoise compute_cc --help

Usage:  [OPTIONS]

  Computes the CC jobs (based on the "New Jobs" identified)

Options:
  --help  Show this message and exit.

compute_dtt

msnoise compute_dtt --help

Usage:  [OPTIONS]

  Computes the dt/t jobs based on the new MWCS data

Options:
  -i, --interval INTEGER  Number of days before now to search for modified
                          Jobs
  --help                  Show this message and exit.

compute_mwcs

msnoise compute_mwcs --help

Usage:  [OPTIONS]

  Computes the MWCS based on the new stacked data

Options:
  --help  Show this message and exit.

compute_stretching

msnoise compute_stretching --help

Usage:  [OPTIONS]

  [experimental] Computes the stretching based on the new stacked data

Options:
  --help  Show this message and exit.

config

msnoise config --help

Usage:  [OPTIONS]

  This command should now only be used to use the command line to set a
  parameter value in the data base. It used to launch the Configurator but
  the recommended way to configure MSNoise is to use the "msnoise admin" web
  interface.

Options:
  -s, --set TEXT  Modify config value: usage --set name=value
  -S, --sync      Sync station metadata from inventory/dataless
  --help          Show this message and exit.

info

msnoise info --help

Usage:  [OPTIONS]

  Outputs general information about the current install and config, plus
  information about jobs and their status.

Options:
  -j, --jobs  Jobs Info only
  --help      Show this message and exit.

install

msnoise install --help

Usage:  [OPTIONS]

  This command launches the installer.

Options:
  --help  Show this message and exit.

ipython

msnoise ipython --help

Usage:  [OPTIONS]

  Launches an ipython notebook in the current folder

Options:
  --help  Show this message and exit.

new_jobs

msnoise new_jobs --help

Usage:  [OPTIONS]

  Determines if new CC jobs are to be defined

Options:
  -i, --init  First run ?
  --nocc      Disable the creation of CC jobs
  --help      Show this message and exit.

p

Will be automatically populated with the commands declared by the plugins (p is an alias for plugin)

plot

ccftime

msnoise plot ccftime --help

Usage:  [OPTIONS] STA1 STA2

  Plots the ccf vs time between sta1 and sta2 (parses the dt/t results)

  STA1 and STA2 must be provided with this format: NET.STA !

Options:
  -f, --filterid INTEGER   Filter ID
  -c, --comp TEXT          Components (ZZ, ZR,...)
  -m, --mov_stack INTEGER  Mov Stack to read from disk
  -a, --ampli FLOAT        Amplification
  -S, --seismic            Seismic style
  -s, --show BOOLEAN       Show interactively?
  -o, --outfile TEXT       Output filename (?=auto)
  -e, --envelope           Plot envelope instead of time series
  -r, --refilter TEXT      Refilter CCFs before plotting (e.g. 4:8 for
                           filtering CCFs between 4.0 and 8.0 Hz. This will
                           update the plot title.
  --help                   Show this message and exit.

data_availability

msnoise plot data_availability --help

Usage:  [OPTIONS]

  Plots the Data Availability vs time

Options:
  -s, --show BOOLEAN  Show interactively?
  -o, --outfile TEXT  Output filename (?=auto)
  --help              Show this message and exit.

distance

msnoise plot distance --help

Usage:  [OPTIONS]

  Plots the REFs of all pairs vs distance

Options:
  -f, --filterid INTEGER  Filter ID
  -c, --comp TEXT         Components (ZZ, ZR,...)
  -a, --ampli FLOAT       Amplification
  -s, --show BOOLEAN      Show interactively?
  -o, --outfile TEXT      Output filename (?=auto)
  -r, --refilter TEXT     Refilter CCFs before plotting (e.g. 4:8 for
                          filtering CCFs between 4.0 and 8.0 Hz. This will
                          update the plot title.
  --virtual-source TEXT   Use only pairs including this station. Format must
                          be NET.STA
  --help                  Show this message and exit.

dtt

msnoise plot dtt --help

Usage:  [OPTIONS] STA1 STA2 DAY

  Plots a graph of dt against t

  STA1 and STA2 must be provided with this format: NET.STA !

  DAY must be provided in the ISO format: YYYY-MM-DD

Options:
  -f, --filterid INTEGER   Filter ID
  -c, --comp TEXT          Components (ZZ, ZR,...)
  -m, --mov_stack INTEGER  Mov Stack to read from disk
  -s, --show BOOLEAN       Show interactively?
  -o, --outfile TEXT       Output filename (?=auto)
  --help                   Show this message and exit.

dvv

msnoise plot dvv --help

Usage:  [OPTIONS]

  Plots the dv/v (parses the dt/t results)

  Individual pairs can be plotted extra using the -p flag one or more times.

  Example: msnoise plot dvv -p ID_KWUI_ID_POSI

  Example: msnoise plot dvv -p ID_KWUI_ID_POSI -p ID_KWUI_ID_TRWI

  Remember to order stations alphabetically !

Options:
  -f, --filterid INTEGER   Filter ID
  -c, --comp TEXT          Components (ZZ, ZR,...)
  -m, --mov_stack INTEGER  Plot specific mov stacks
  -p, --pair TEXT          Plot a specific pair
  -A, --all                Show the ALL line?
  -M, --dttname TEXT       Plot M or M0?
  -s, --show BOOLEAN       Show interactively?
  -o, --outfile TEXT       Output filename (?=auto)
  --help                   Show this message and exit.

interferogram

msnoise plot interferogram --help

Usage:  [OPTIONS] STA1 STA2

  Plots the interferogram between sta1 and sta2 (parses the CCFs)

  STA1 and STA2 must be provided with this format: NET.STA !

Options:
  -f, --filterid INTEGER   Filter ID
  -c, --comp TEXT          Components (ZZ, ZR,...)
  -m, --mov_stack INTEGER  Mov Stack to read from disk
  -s, --show BOOLEAN       Show interactively?
  -o, --outfile TEXT       Output filename (?=auto)
  -r, --refilter TEXT      Refilter CCFs before plotting (e.g. 4:8 for
                           filtering CCFs between 4.0 and 8.0 Hz. This will
                           update the plot title.
  --help                   Show this message and exit.

mwcs

msnoise plot mwcs --help

Usage:  [OPTIONS] STA1 STA2

  Plots the mwcs results between sta1 and sta2 (parses the CCFs)

  STA1 and STA2 must be provided with this format: NET.STA !

Options:
  -f, --filterid INTEGER   Filter ID
  -c, --comp TEXT          Components (ZZ, ZR,...)
  -m, --mov_stack INTEGER  Mov Stack to read from disk
  -s, --show BOOLEAN       Show interactively?
  -o, --outfile TEXT       Output filename (?=auto)
  --help                   Show this message and exit.

station_map

msnoise plot station_map --help

Usage:  [OPTIONS]

  Plots the station map (very very basic)

Options:
  -s, --show BOOLEAN  Show interactively?
  -o, --outfile TEXT  Output filename (?=auto)
  --help              Show this message and exit.

timing

msnoise plot timing --help

Usage:  [OPTIONS]

  Plots the timing (parses the dt/t results)

  Individual pairs can be plotted extra using the -p flag one or more times.

  Example: msnoise plot timing -p ID_KWUI_ID_POSI

  Example: msnoise plot timing -p ID_KWUI_ID_POSI -p ID_KWUI_ID_TRWI

  Remember to order stations alphabetically !

Options:
  -f, --filterid INTEGER   Filter ID
  -c, --comp TEXT          Components (ZZ, ZR,...)
  -m, --mov_stack INTEGER  Plot specific mov stacks
  -p, --pair TEXT          Plot a specific pair
  -A, --all                Show the ALL line?
  -M, --dttname TEXT       Plot M or M0?
  -s, --show BOOLEAN       Show interactively?
  -o, --outfile TEXT       Output filename (?=auto)
  --help                   Show this message and exit.

plugin

Will be automatically populated with the commands declared by the plugins (p is an alias for plugin)

populate

msnoise populate --help

Usage:  [OPTIONS]

  Rapidly scan the archive filenames and find Network/Stations

Options:
  --fromDA  Populates the station table using network and station codes found
            in the data_availability table, overrides the default workflow
            step.
  --help    Show this message and exit.

reset

msnoise reset --help

Usage:  [OPTIONS] JOBTYPE

  Resets the job to "T"odo. ARG is [CC] or [DTT]. By default only resets
  jobs "I"n progress. --all resets all jobs, whatever the flag value

Options:
  -a, --all        Reset all jobs
  -r, --rule TEXT  Reset job that match this SQL rule
  --help           Show this message and exit.

scan_archive

msnoise scan_archive --help

Usage:  [OPTIONS]

  Scan the archive and insert into the Data Availability table.

Options:
  -i, --init   First run ?
  --path TEXT  Scan all files in specific folder, overrides the default
               workflow step.
  --help       Show this message and exit.

stack

msnoise stack --help

Usage:  [OPTIONS]

  Stacks the [REF] and/or [MOV] windows

Options:
  -r, --ref               Compute the REF Stack
  -m, --mov               Compute the MOV Stacks
  -s, --step              Compute the STEP Stacks
  -i, --interval INTEGER  Number of days before now to search for modified
                          Jobs
  --help                  Show this message and exit.

test

msnoise test --help

Usage:  [OPTIONS]

  Runs the test suite, should be executed in an empty folder!

Options:
  --help  Show this message and exit.

upgrade_db

msnoise upgrade_db --help

Usage:  [OPTIONS]

  Upgrade the database from previous to a new version.

  This procedure adds new parameters with their default value in the config
  database.

Options:
  --help  Show this message and exit.