marcel/pylot
3
0
Fork 0
Code Issues 7 Pull Requests 1 Releases Wiki Activity

[change] improved docstring for autopylot.py

Browse Source
This commit is contained in:
Darius Arnold 2017-10-05 17:19:00 +02:00
parent 87b4ce1345
commit 3dde42e639
1 changed files with 22 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
autoPyLoT.py
View File

@ -38,15 +38,29 @@ def autoPyLoT(input_dict=None, parameter=None, inputfile=None, fnames=None, even
""" """
Determine phase onsets automatically utilizing the automatic picking Determine phase onsets automatically utilizing the automatic picking
algorithms by Kueperkoch et al. 2010/2012. algorithms by Kueperkoch et al. 2010/2012.
:param input_dict:
:param inputfile: path to the input file containing all parameter :type input_dict:
information for automatic picking (for formatting details, see. :param parameter: PylotParameter object containing parameters used for automatic picking
`~pylot.core.io.inputs.PylotParameter` :type parameter: pylot.core.io.inputs.PylotParameter
:param inputfile: path to the input file containing all parameter information for automatic picking
(for formatting details, see. `~pylot.core.io.inputs.PylotParameter`
:type inputfile: str :type inputfile: str
:return: :param fnames: list of data file names or None when called from GUI
:type fnames: str
.. rubric:: Example :param eventid: event path incl. event ID (path to waveform files)
:type eventid: str
:param savepath: save path for autoPyLoT output, if None/"None" output will be saved in event folder
:type savepath: str
:param savexml: export results in XML file if True
:type savexml: bool
:param station: list of station names or 'all' to pick all stations
:type station: str
:param iplot: logical variable for plotting: 0=none, 1=partial, 2=all
:type iplot: int
:param ncores: number of cores used for parallel processing. Default (0) uses all available cores
:type ncores: int
:return: dictionary containing picks
:rtype: dict
""" """
if ncores == 1: if ncores == 1: