From 983e4c25a355b55094b6fa2e5f06418a9a988d1b Mon Sep 17 00:00:00 2001 From: Darius Arnold Date: Mon, 13 Nov 2017 11:45:25 +0100 Subject: [PATCH] [add] docstrings in pylot/core/loc --- pylot/core/loc/focmec.py | 8 ++++---- pylot/core/loc/hash.py | 8 ++++---- pylot/core/loc/hypo71.py | 4 ++-- pylot/core/loc/hypodd.py | 8 ++++---- pylot/core/loc/hyposat.py | 4 ++-- pylot/core/loc/nll.py | 20 ++++++++++---------- pylot/core/loc/velest.py | 8 ++++---- 7 files changed, 30 insertions(+), 30 deletions(-) diff --git a/pylot/core/loc/focmec.py b/pylot/core/loc/focmec.py index 0ff44fc9..2df845cf 100644 --- a/pylot/core/loc/focmec.py +++ b/pylot/core/loc/focmec.py @@ -18,11 +18,11 @@ def export(picks, fnout, parameter, eventinfo): :param fnout: complete path to the exporting obs file :type fnout: str - :param: parameter, all input information - :type: object + :param parameter: all input information + :type parameter: object - :param: eventinfo, source information needed for focmec format - :type: list object + :param eventinfo: source information needed for focmec format + :type eventinfo: list object ''' # write phases to FOCMEC-phase file writephases(picks, 'FOCMEC', fnout, parameter, eventinfo) diff --git a/pylot/core/loc/hash.py b/pylot/core/loc/hash.py index 75532dca..5ba18faa 100644 --- a/pylot/core/loc/hash.py +++ b/pylot/core/loc/hash.py @@ -18,11 +18,11 @@ def export(picks, fnout, parameter, eventinfo): :param fnout: complete path to the exporting obs file :type fnout: str - :param: parameter, all input information - :type: object + :param parameter: all input information + :type parameter: object - :param: eventinfo, source information needed for HASH format - :type: list object + :param eventinfo: source information needed for HASH format + :type eventinfo: list object ''' # write phases to HASH-phase file writephases(picks, 'HASH', fnout, parameter, eventinfo) diff --git a/pylot/core/loc/hypo71.py b/pylot/core/loc/hypo71.py index 2dc70c10..430e2c14 100644 --- a/pylot/core/loc/hypo71.py +++ b/pylot/core/loc/hypo71.py @@ -18,8 +18,8 @@ def export(picks, fnout, parameter): :param fnout: complete path to the exporting obs file :type fnout: str - :param: parameter, all input information - :type: object + :param parameter: all input information + :type parameter: object ''' # write phases to HYPO71-phase file writephases(picks, 'HYPO71', fnout, parameter) diff --git a/pylot/core/loc/hypodd.py b/pylot/core/loc/hypodd.py index c1283b05..1280ad99 100644 --- a/pylot/core/loc/hypodd.py +++ b/pylot/core/loc/hypodd.py @@ -18,11 +18,11 @@ def export(picks, fnout, parameter, eventinfo): :param fnout: complete path to the exporting obs file :type fnout: str - :param: parameter, all input information - :type: object + :param parameter: all input information + :type parameter: object - :param: eventinfo, source information needed for hypoDD format - :type: list object + :param eventinfo: source information needed for hypoDD format + :type eventinfo: list object ''' # write phases to hypoDD-phase file writephases(picks, 'hypoDD', fnout, parameter, eventinfo) diff --git a/pylot/core/loc/hyposat.py b/pylot/core/loc/hyposat.py index 12004e33..e9c05a87 100644 --- a/pylot/core/loc/hyposat.py +++ b/pylot/core/loc/hyposat.py @@ -18,8 +18,8 @@ def export(picks, fnout, parameter): :param fnout: complete path to the exporting obs file :type fnout: str - :param: parameter, all input information - :type: object + :param parameter: all input information + :type parameter: object ''' # write phases to HYPOSAT-phase file writephases(picks, 'HYPOSAT', fnout, parameter) diff --git a/pylot/core/loc/nll.py b/pylot/core/loc/nll.py index a3746b4c..4788894a 100644 --- a/pylot/core/loc/nll.py +++ b/pylot/core/loc/nll.py @@ -28,8 +28,8 @@ def export(picks, fnout, parameter): :param fnout: complete path to the exporting obs file :type fnout: str - :param: parameter, all input information - :type: object + :param parameter: all input information + :type parameter: object ''' # write phases to NLLoc-phase file writephases(picks, 'NLLoc', fnout, parameter) @@ -38,19 +38,19 @@ def export(picks, fnout, parameter): def modify_inputs(ctrfn, root, nllocoutn, phasefn, tttn): ''' :param ctrfn: name of NLLoc-control file - :type: str + :type ctrfn: str :param root: root path to NLLoc working directory - :type: str + :type root: str :param nllocoutn: name of NLLoc-location output file - :type: str + :type nllocoutn: str :param phasefn: name of NLLoc-input phase file - :type: str + :type phasefn: str :param tttn: pattern of precalculated NLLoc traveltime tables - :type: str + :type tttn: str ''' # For locating the event the NLLoc-control file has to be modified! # create comment line for NLLoc-control file NLLoc-output file @@ -75,9 +75,9 @@ def modify_inputs(ctrfn, root, nllocoutn, phasefn, tttn): def locate(fnin, infile=None): """ - takes an external program name - :param fnin: - :return: + takes an external program name and tries to run it + :param fnin: external program name + :return: None """ if infile is None: diff --git a/pylot/core/loc/velest.py b/pylot/core/loc/velest.py index 1ec9fd6a..8dd5d88f 100644 --- a/pylot/core/loc/velest.py +++ b/pylot/core/loc/velest.py @@ -18,11 +18,11 @@ def export(picks, fnout, eventinfo, parameter=None): :param fnout: complete path to the exporting obs file :type fnout: str - :param: eventinfo, source time needed for VELEST-cnv format - :type: list object + :param eventinfo: source time needed for VELEST-cnv format + :type eventinfo: list object - :param: parameter, all input information - :type: object + :param parameter: all input information + :type parameter: object ''' # write phases to VELEST-phase file writephases(picks, 'VELEST', fnout, parameter, eventinfo)