Add document files #140
Merged
Add document files #140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
valentina-s
approved these changes
Sep 14, 2023
There was a problem hiding this comment.
Thanks for the detailed documentation @ldr426! I added some comments inline (mainly small text edits). You can merge once your update those.
docs/source/echoshader_doc/version_0.1.0/echogram_examples.ipynb
Outdated
Show resolved
Hide resolved
docs/source/echoshader_doc/version_0.1.0/echogram_examples.ipynb
Outdated
Show resolved
Hide resolved
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
valentina-s
added a commit
that referenced
this pull request
Oct 13, 2023
* Bugs fix (#88) * Change importing format to comply with develop mode * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve that curtain could not dynamically render * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Select box correctly when not inverting y-axis * local testing * y-axis testing * Y-axis testing * add options for echogram * del testing files * add options * set y-axis inversion * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * 06/06/2023 - testing * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Refactor echogram and associated components using accessor (#93) * Change importing format to comply with develop mode * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve that curtain could not dynamically render * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Select box correctly when not inverting y-axis * local testing * y-axis testing * Y-axis testing * add options for echogram * del testing files * add options * set y-axis inversion * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add testing files * rename testing file * a * a * lasso testing * add for testing * 06/06/2023 - testing * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Delete echoshader/new_version directory * Add testing files * rename testing file * a * a * lasso testing * add for testing * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ADD testing file * del old one * add test.ipynb * change "= None" to "is None" * little fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add comments * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Sync * Add docstring and customizing colormap * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Delete .DS_Store * Delete .DS_Store * Solve Undefined Name * Use Literal to solve undefined issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issues * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve "compare False should using is not" * Delete testing files * delete testing toy dataset --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Add feature of select box (#103) * Change importing format to comply with develop mode * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve that curtain could not dynamically render * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Select box correctly when not inverting y-axis * local testing * y-axis testing * Y-axis testing * add options for echogram * del testing files * add options * set y-axis inversion * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add testing files * rename testing file * a * a * lasso testing * add for testing * 06/06/2023 - testing * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Delete echoshader/new_version directory * Add testing files * rename testing file * a * a * lasso testing * add for testing * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ADD testing file * del old one * add test.ipynb * change "= None" to "is None" * little fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add comments * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Sync * Add docstring and customizing colormap * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Delete .DS_Store * Delete .DS_Store * Solve Undefined Name * Use Literal to solve undefined issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issues * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve "compare False should using is not" * Delete testing files * delete testing toy dataset * Add selected box plotting and extracting feature * Add python doc for extracting box function * Delete testing files * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve line too long issue * Change name from ambiguous `gram` to echogram --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Feature echomap (#122) * Change importing format to comply with develop mode * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve that curtain could not dynamically render * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Select box correctly when not inverting y-axis * local testing * y-axis testing * Y-axis testing * add options for echogram * del testing files * add options * set y-axis inversion * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add testing files * rename testing file * a * a * lasso testing * add for testing * 06/06/2023 - testing * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Delete echoshader/new_version directory * Add testing files * rename testing file * a * a * lasso testing * add for testing * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ADD testing file * del old one * add test.ipynb * change "= None" to "is None" * little fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add comments * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Sync * Add docstring and customizing colormap * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Delete .DS_Store * Delete .DS_Store * Solve Undefined Name * Use Literal to solve undefined issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issues * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve "compare False should using is not" * Delete testing files * delete testing toy dataset * Add selected box plotting and extracting feature * Add python doc for extracting box function * Delete testing files * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add map plotting * Add features of curtain and some comments * Draft PR for map part * Update track, curtain and linked connection logic * Add colormap type (list) for curtain * Add testing file for demo * Delete .DS_Store * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve pre-commit * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Store link state of curtain * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Delete .DS_Store * Add .DS_Store to .gitignore * change name of varaiable "gram_plot" to "echogram" * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Update variable name "old_vmin" to "data_min" --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Feature stats (#130) * Change importing format to comply with develop mode * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve that curtain could not dynamically render * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Select box correctly when not inverting y-axis * local testing * y-axis testing * Y-axis testing * add options for echogram * del testing files * add options * set y-axis inversion * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add testing files * rename testing file * a * a * lasso testing * add for testing * 06/06/2023 - testing * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Delete echoshader/new_version directory * Add testing files * rename testing file * a * a * lasso testing * add for testing * Add trigram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ADD testing file * del old one * add test.ipynb * change "= None" to "is None" * little fix * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add comments * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Sync * Add docstring and customizing colormap * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Delete .DS_Store * Delete .DS_Store * Solve Undefined Name * Use Literal to solve undefined issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issues * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve 'line too long' issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve "compare False should using is not" * Delete testing files * delete testing toy dataset * Add selected box plotting and extracting feature * Add python doc for extracting box function * Delete testing files * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add map plotting * Add features of curtain and some comments * [pre-commit.ci] pre-commit autoupdate (#105) updates: - [github.com/igorshubovych/markdownlint-cli: v0.34.0 → v0.35.0](igorshubovych/markdownlint-cli@v0.34.0...v0.35.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Draft PR for map part * Update track, curtain and linked connection logic * Add colormap type (list) for curtain * Add testing file for demo * Delete .DS_Store * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve pre-commit * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Store link state of curtain * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] pre-commit autoupdate (#123) updates: - [github.com/psf/black: 23.3.0 → 23.7.0](psf/black@23.3.0...23.7.0) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Delete .DS_Store * Add .DS_Store to .gitignore * change name of varaiable "gram_plot" to "echogram" * Update echoshader/new_version/echogram.py Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Update variable name "old_vmin" to "data_min" * Add stats part * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Create functions for repetitive code * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * delete useless importing lib * Resolve conflict * Resolve conflicts * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add python doc * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add docstring * Solve pre-commit issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve pre-commit issue * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> * Final-version Refactoring (#131) * Create folders for new refactoring * Add core.py, echogram.py, map.py and utils.py * Add files * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add moored point in map & config in utils * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add echogram in core.py and docstring * Lined echogram and map for 2nd version * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve pre-commit issue * High-order structure building * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve pre-commit * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add underlying code for hist and curtain * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * sovle pre-commit * Add curtain, hist and table * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix little bugs ahout curtain and hist * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add subscriber about echogram * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add curtain * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add new requirements * Add bidirectional control logic * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add reset tool * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add customized opts * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update file stucture * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add __init__.py * Add more docstring * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add testing demo * erase pre-commit warning * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Add testing files (#139) * Fix channel select bugs * Add testing files * solve pre-commit warnings * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * extract out testing files * Add pytest and CI config * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Set the testing files as expected for a user * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Make the testing files to pytest format * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Improve testing files * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add more testing cases * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Dev test ci (#142) * Adding branches for testing * renaming workflow to workflows * addign extra empty line to trigger the workflow * Put the branches into bullet points * remove test coverage * Rename test.py to test_plots.py Adding underscrore for discoverability * fixing get_data call * limit to python 3.10 * pin pandas * test with unpinned Python * Add document files (#140) * Fix channel select bugs * Add testing files * solve pre-commit warnings * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * extract out testing files * Add pytest and CI config * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Set the testing files as expected for a user * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Make the testing files to pytest format * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Improve testing files * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add more testing cases * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add docs for generating data * Add index and design intro page * Add index and structure intro pages * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * code blocks should have a language specified * Add data generation docs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add echogram showcases * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add track and hist exampls * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add panel server setup * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve pre-commit * Improve based on feedback * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * del deprecated testing files * Add Configuration file v2 (.readthedocs.yaml) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Solve conflicts * Solve doc conflicts --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * Update README.md * Dev patch (#147) * Update setup_server.md removing repeating sentence from panel * splitting user and development installation instructions * removing intro.md * Update index.md adding a more general description and a note that folks can skip to the examples as this will be what most users need. Later we may reorganize the order of the sections. * language * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update _toc.yml * Update index.md Fix typo --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Dingrui Lei <56751303+ldr426@users.noreply.github.com> * Fix-dev (#149) * improve dev based on feedback * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Wu-Jung Lee <leewujung@gmail.com> Co-authored-by: Valentina Staneva <valentina-s@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to add document files.