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

Documentation updates: data processing sections #1093

Merged
merged 29 commits into from
Aug 21, 2023

Conversation

leewujung
Copy link
Member

@leewujung leewujung commented Jul 26, 2023

Detailed changes

This PR includes a number of documentation updates:

Summary

  • The previous Data format section is now renamed to Raw data format
  • There is a new Data processing section, which contains 2 pages:
  • 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
    • this page contains some information that was previously in data-format-processed.ipynb under the previous Data format section

@leewujung leewujung added the docs label Jul 26, 2023
@leewujung leewujung added this to the 0.8.0 milestone Jul 26, 2023
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@leewujung leewujung changed the title Documentation updates Documentation updates: data processing sections Aug 20, 2023
@codecov-commenter
Copy link

codecov-commenter commented Aug 20, 2023

Codecov Report

Merging #1093 (b66439f) into dev (7c0c818) will decrease coverage by 58.22%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##              dev    #1093       +/-   ##
===========================================
- Coverage   80.41%   22.19%   -58.22%     
===========================================
  Files          64       65        +1     
  Lines        6044     6046        +2     
===========================================
- Hits         4860     1342     -3518     
- Misses       1184     4704     +3520     
Flag Coverage Δ
unittests 22.19% <100.00%> (-58.22%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
echopype/__init__.py 100.00% <ø> (ø)
echopype/consolidate/api.py 93.75% <ø> (ø)
echopype/metrics/__init__.py 100.00% <100.00%> (ø)

... and 48 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@leewujung leewujung marked this pull request as ready for review August 21, 2023 01:51
@leewujung
Copy link
Member Author

I'll self-merge now to get these changes in, in prep for the release.

@leewujung leewujung merged commit 29422d0 into OSOceanAcoustics:dev Aug 21, 2023
3 checks passed
@leewujung leewujung deleted the doc-proc branch July 21, 2024 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants