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

Final-version Refactoring #131

Merged
merged 41 commits into from
Aug 11, 2023
Merged

Conversation

ldr426
Copy link
Collaborator

@ldr426 ldr426 commented Jul 24, 2023

This pull request aims to introduce the final version of the Refactoring for the Echoshader project.
This PR aims to implements all functionalities with relative control widgets, dynamical box, and linkage to enhance the project's capabilities and user experience.

The PR includes four key files that provide essential functionalities:

  • core.py: This class acts as a central handler for managing echograms, maps, and statistics. It serves as a superstructure with interfaces for plotting, control widgets, bounds, and links.
  • echogram.py: This file contains functions related to echograms, including single frequency echograms and tricolor echograms.
  • map.py: This file houses functions for handling geographical aspects, such as map tiles and the geo-position of ships or stationary platforms.
  • curtain.py: This file contains functions related to 2.5D curtain.
  • box.py: This file contains functions related to obtaining and plotting box/polygon stream .
  • hist.py: This file contains functions related to histogram and statistical tables.
  • utils.py: This file contains configurations for plottings, such as width settings.

Notes about this PR: https://docs.google.com/document/d/1QL89eLLcnLjhV8FRp4L_V1n52z0EbTwrrceGELBhVes/edit

Features built:
#111
#112
#113
#117
#119
#115
#116
#86

small Issues solved:
#107
#110
#99
#133
#132
#129
#127
#125
#96

@ldr426 ldr426 requested review from valentina-s and leewujung July 24, 2023 04:41
@ldr426 ldr426 removed the request for review from valentina-s July 24, 2023 05:04
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@ldr426 ldr426 marked this pull request as ready for review July 31, 2023 20:22
@valentina-s
Copy link
Contributor

valentina-s commented Aug 3, 2023

@ldr426 Could you reorganize the repo to remove the new_version_3 folder so that it is ready for merging following the standard package structure.

  |-- echoshader
        |-- old_versions_folders (we can remove them once we settle )
        |-- ...
        |-- core.py
        |-- echogram.py
        |-- xyz.py (other scripts)
        |-- tests (a folder containing test scripts corresponding to each module)
              |-- test_core.py
              |-- test_echogram.py
              |-- test_xyz.py
  |-- notebooks

@ldr426
Copy link
Collaborator Author

ldr426 commented Aug 3, 2023

Hey @valentina-s, Thanks! Also need to update requirement.txt and add env creating command as I told you before:
mamba create -n echoshader -c pyviz -c conda-forge hvplot geoviews pyvista ipykernel
This related to #120

@ldr426 ldr426 marked this pull request as draft August 3, 2023 21:29
@ldr426 ldr426 changed the title Refactoring 2.0 Backbone Final-version Refactoring Aug 7, 2023
@valentina-s
Copy link
Contributor

@ldr426 I see that you have done the bidirectional logic. It is great that it worked out! Could you reorganize the folder structure to remove the new_version_3 folder, so that this PR is ready for merging. We should finalize this version before doing other things, those can be done as separate issues and PRs.

@valentina-s
Copy link
Contributor

valentina-s commented Aug 11, 2023

@ldr426 I managed the import and fiddled with several panel configurations of the widgets. Some of the interactive linking did not work for me, although one direction worked. I can test more with the new notebooks. For now just make the current one properly import the package. And change the PR from Draft to ready for review, so I can merge it.

@ldr426 ldr426 marked this pull request as ready for review August 11, 2023 09:14
@ldr426 ldr426 requested a review from valentina-s August 11, 2023 09:14
@valentina-s valentina-s merged commit 52c6f32 into OSOceanAcoustics:dev Aug 11, 2023
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants