Skip to content
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

Add descriptions and a diagram to docs documenting vertical offsets (water level, etc) #1062

Closed
emiliom opened this issue Jun 11, 2023 · 3 comments
Assignees
Labels
data format Anything about data format docs
Milestone

Comments

@emiliom
Copy link
Collaborator

emiliom commented Jun 11, 2023

From @leewujung : For the sake of clarity, could you add the definition of water_level and vertical_offset with a simple diagram of which one means which for an underwater vehicle and a ship? This should actually be in the docs, but if we have something parked here it'll be easy to plug them in afterwards.

@emiliom
Copy link
Collaborator Author

emiliom commented Aug 17, 2023

Refer to #1051 for related discussions.

@leewujung
Copy link
Member

leewujung commented Aug 21, 2023

In #1093 I've restructured the TOC to have a Data processing section with 2 sections:

  • data-proc-func.ipynb: providing a summary of processing functionalities and usage examples, especially for cal_params and env_params for calibration
  • data-proc-additional.ipynb: a one-stop-shopping place for additional details for processing functions

One could argue that the cal_params and env_params details should be in the -additional page, but since I feel the -func page could also use some more expansion, I decided to hold off on any further changes.

I think the -additional page may be the place to go for the z-axis variables and combinations, and to include an illustration.

@leewujung
Copy link
Member

This is now addressed in #1133!

@github-project-automation github-project-automation bot moved this from Todo to Done in Echopype Aug 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data format Anything about data format docs
Projects
Status: Done
Development

No branches or pull requests

2 participants