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

Heat/Reheat controls for ForceGraph #36

Closed
zwelz3 opened this issue Feb 8, 2023 · 5 comments
Closed

Heat/Reheat controls for ForceGraph #36

zwelz3 opened this issue Feb 8, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@zwelz3
Copy link
Member

zwelz3 commented Feb 8, 2023

Elevator Pitch

The ability to control the simulation heat/reheat parameters when making changes to the source and/or behaviors. A method for ex. pausing the simulation when applying certain style changes (e.g. node color), and a recommended design patter (within docs?) for how to achieve this desired effect.

Motivation

We are developing apps using ipyforcegraph, and updating this such as node/edge visibility, color, and other styles (as part of the ipyforcegraph supported behaviors) causes the visualization to "reheat" the graph layout. Under certain conditions it would be valuable to allow users of ipyforcegraph to control the heat settings so that operations can be performed on the source and behaviors without causing the visualization to reheat. A recommended implementation from the dev team will help ensure that the most effective manner for controlling these options is used downstream.

Design Ideas

Possibly set the config on the ForceGraph class (simplified e.g. fg.reheat = False) before modifying behaviors/source/etc.

@zwelz3 zwelz3 added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 8, 2023
@zwelz3
Copy link
Member Author

zwelz3 commented Feb 8, 2023

Unsure how this is related to #28, but there may be some overlap.

@zwelz3 zwelz3 changed the title Heat/Reheat controls when updating behaviors Heat/Reheat controls for ForceGraph Feb 8, 2023
@nrbgt
Copy link
Contributor

nrbgt commented Feb 8, 2023

Yerp, #28 (and by extension #35) probably handles this with the GraphForcesBehavior.warmup_ticks and .cooldown_ticks. The Forces.ipynb after this build should demonstrate it, with some more demo work under way.

We also clobbered a lot of jitter when various traits change, which should result in snappier updates.

@nrbgt
Copy link
Contributor

nrbgt commented Feb 8, 2023

https://ipyforcegraph--35.org.readthedocs.build/en/35/_static/lab/index.html?path=Forces.ipynb

(recommend opening this in a "private browsing" session so you don't get weird cache artifacts)

@nrbgt
Copy link
Contributor

nrbgt commented Feb 8, 2023

(also note that notebook is very much a work-in-progress... running past the couple cells right after Warmup and Cooldown will blow away the linked configuration)

@nrbgt nrbgt mentioned this issue Feb 10, 2023
24 tasks
dfreeman06 pushed a commit that referenced this issue Feb 21, 2023
nrbgt added a commit to nrbgt/ipyforcegraph that referenced this issue Feb 22, 2023
nrbgt added a commit that referenced this issue Feb 23, 2023
nrbgt added a commit that referenced this issue Feb 24, 2023
* gh-36 adding manual reheating control

* gh-36 added reheat ui to the other force behaviors

* Gh 36 rereheating (#55)

* rework envs for performance in CI, Binder, RTD (#53)

* hoist action messages to type, add totality check

* more badge

* fix links

* add reheat robot test

* skip more osx tests

* skip more osx tests

---------

Co-authored-by: Dane Freeman <dane.freeman@gtri.gatech.edu>
Co-authored-by: Nicholas Bollweg <nicholas.bollweg@gtri.gatech.edu>
dfreeman06 added a commit that referenced this issue Feb 24, 2023
* gh-33 initial dag behavior

* gh-33 fix notebook names

* gh-33 linting and other code quality check fixes

* gh-33 simple DAG unit test

* gh-33 fixing tests

* gh-33 dag test

* gh-36 adding manual reheating control

* gh-36 added reheat ui to the other force behaviors

* Gh 36 rereheating (#55)

* rework envs for performance in CI, Binder, RTD (#53)

* hoist action messages to type, add totality check

* more badge

* fix links

* add reheat robot test

* skip more osx tests

* gh-33 refactoring dag to better fit as a 'force'

* gh-33 fix dag api check test

* gh-33 fixing dag robot test

* skip more osx tests

* Update dictionary.txt

* gh-33 fixed notebook dag function naming. updated changelog.

* gh-33 updating dag traitlet help

---------

Co-authored-by: Dane Freeman <dane.freeman@gtri.gatech.edu>
Co-authored-by: Nicholas Bollweg <nicholas.bollweg@gtri.gatech.edu>
@sanbales sanbales added this to the 0.2.1 milestone Feb 25, 2023
@nrbgt
Copy link
Contributor

nrbgt commented Mar 16, 2023

Fixed by #65

@nrbgt nrbgt closed this as completed Mar 16, 2023
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 enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

3 participants