ANS: Ambient Noise Seismology (version 0.0.1)

ANS is a python wrapper for ambient noise seismology tasks and it has a GUI for easier configuration of ambient-noise seismology projects. In its backend, this package depends on Perl interpreter, GMT (Generic Mapping Tools), and SAC (Seismic Analysis Code) as well as python modules including ObsPy etc.

*ANS is successfully tested on Python 3.6.* and 3.8.* versions.

Code owners:

• Omid Bagherpur (email: omid.bagherpur@gmail.com)
  
• Fiona Darbyshire (email: darbyshire.fiona_ann@uqam.ca)
  

Release notes:

Version 0.0.1

This version includes all the necessary commands and tools for generating Rayleigh wave (ZZ and RR cross-correlations) and Love wave (TT cross-correlation component) Empirical Green's Functions (EGFs). A brief description of the most useful CLI commands is given below:

• $> ans init maindir
  
  Description: initialize ANS project at the project main directory i.e. "maindir"
• $> ans config
$> ans config --maindir maindir
  
  Description: open the program GUI to configure the ans project. Note: default maindir is $PWD
  
• $> ans download stations
$> ans download stations --maindir maindir
  
  Description: download list of available stations at the given region boundary and dates that was previously set in this GUI. Datacenters, desired station components etc should also be set using '$> ans config'.
  
• $> ans download metadata
$> ans download metadata --maindir maindir
$> ans download metadata --update_stations
  
  Description: download station metadata files (xml file format) that will be used for instrument response removal and updating sac headers. If '--update_stations' is appended, program will update the list of stations based on the content of metadata directory when the process is finished.
  
• $> ans download mseeds
$> ans download mseeds --maindir maindir
  
  Description: main data acquisition module; download seismograms in mseed format
  
• $> ans mseed2sac mseeds_dir sacs_dir
$> ans mseed2sac mseeds_dir sacs_dir --all
  
  Description: convert mseed to sac files while applying the listed processing steps in project configuration mseed2sac tab. Note that if for some reason, process if stopped, one can re-run the command and the program will resume the process for the remaining files.
  
  * mseeds_dir: input mseed dataset directory
  * sacs_dir: output sac files dataset directory
  * --all: do not pay attention to station list and output all
  
• $> ans sac2ncf sacs_dir ncfs_dir
$> ans sac2ncf sacs_dir ncfs_dir --all
  
  Description: process the input sacfiles and output NCFs (noise cross-correlation functions) while applying the list of sac2ncf processes defined in project configuration file. Note: At this step it is necessary that all sac headers are updated and this can be done by either performing instrument response removal or adding "write headers" process to the list of processes.
  
  * sacs_dir: input sac files dataset directory
  * ncfs_dir: output ncf files dataset directory
  * --all: do not pay attention to station list and output all
  
• $> ncf2egf ncfs egfs_dir
  
  Description: stack NCFs and generate EGFs
  
  * ncfs: either path to the 'ncfs_dir' (full stack EGFs) or an ASCII datalist with a one-column data format containing a list of paths to event directories (seasonal EGFs; e.g., "14001000000" i.e. 2014/01/01)
  * egfs_dir: output egf files dataset directory