-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
modify to add capability to read both Ginan and Bernese troposphere .… #34
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like some good changes coming in here to expand .tro
reading
- Do you have example
.tro
files we can test the new function on?
The other format for troposhere is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again, looks good, couple docstrings that need to be finished off, but I think once you've got the unittests that Seb suggested in, this should be good to go
@@ -9,41 +9,70 @@ | |||
from .. import gn_io as _gn_io | |||
|
|||
|
|||
def _read_tro_solution(path: str, recenter: bool = True) -> _pd.DataFrame: | |||
def _read_tro_solution(path: str, recenter: bool = True, trop_mode="Ginan") -> _pd.DataFrame: | |||
"""For backwards compatibility""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docstring should be one-line sphinx (missing the description of input parameters, errors raise, what's returned, etc.: :param
:return
)
https://github.com/NilsJPWerner/autoDocstring/blob/master/docs/one-line-sphinx.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This function is up for deletion if no one uses it (as there is the read_tro_solution
function below this
gnssanalysis/gn_io/trop.py
Outdated
return read_tro_solution(path, recenter=recenter, trop_mode=trop_mode) | ||
|
||
|
||
def read_tro_solution(path: str, recenter: bool = True, trop_mode="Ginan") -> _pd.DataFrame: | ||
"""Parses tro snx file into a dataframe. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One-line sphinx docstring (missing the description of input parameters, errors raise, what's returned, etc.: :param
:return
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks heaps for putting through the docstring
additions 🙏
I've noticed you now have two read_tro_solution
functions - is this intentional?
There is _read_tro_solution
and read_tro_solution
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unit tests are a great addition - can use that instead of testing manually. Happy for this to go in 👍
to support both Ginan and Bernese tropospheric files (
.tro
files)