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

docs: New pages #192

Closed
leewujung opened this issue Mar 1, 2024 · 2 comments
Closed

docs: New pages #192

leewujung opened this issue Mar 1, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@leewujung
Copy link
Member

  • Quick start notebook: something like the previous EchoPro Python Workflow notebook
  • Mathematical/theoretical description:
    • things like: converting NASC to abundance, abundance to biomass, kriging, CV analysis, etc
    • different sections mapped to algorithmic implementation
  • Algorithmic implementation:
    • which variables is what symbol
    • how different variables are combined into another one and passed into a function to compute something
    • we will have different sections in code explained in different pages, ref echopype _toc
  • Change title: Classes and data structures --> Core data structure
  • Glossary
    • section: variable naming convention (_df, _arr, _gdf, tbl), if no "" it is a dictionary
    • section: physics-related quantities
@leewujung leewujung added the documentation Improvements or additions to documentation label Mar 2, 2024
@leewujung
Copy link
Member Author

#193 addressed the first three bullet points.

@leewujung leewujung added this to the v0.4.1 (documentation) milestone Mar 2, 2024
@leewujung
Copy link
Member Author

#195, #197, #201 together added all planned pages. I'll close this now and we can track detailed items in new issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant