Skip to content

[WIP] Doc gui api workflow#1235

Open
wagishi wants to merge 3 commits intojonescompneurolab:masterfrom
wagishi:doc-gui-api-workflow
Open

[WIP] Doc gui api workflow#1235
wagishi wants to merge 3 commits intojonescompneurolab:masterfrom
wagishi:doc-gui-api-workflow

Conversation

@wagishi
Copy link

@wagishi wagishi commented Feb 3, 2026

This PR adds a tutorial notebook demonstrating how users can move between the
HNN GUI and Python API by saving and loading neocortical model configurations.
It addresses common beginner confusion and documents the use of
read_network_configuration.

@asoplata
Copy link
Collaborator

Thank you for your contribution wagishi. I've looked at the notebook you created, but there are a number of different issues with the current notebook. The Python code to actually simulate and plot the network is not correct and does not use functions which currently exist in our API. If you use AI or LLMs to construct this code, then it "hallucinated" an incorrect API for our library. You can see working examples of the API simulating and plotting a network on our Textbook website, such as here https://jonescompneurolab.github.io/textbook/content/05_erps/hnn_core.html .

For the GUI steps documented in the notebook, please add more description, including (at minimum) description of what buttons a user needs to click in order, and possibly screenshots as well.

For your git history, please remove the commit fedc4c5, since it is unrelated to this feature and instead related to other PRs. You can do this by using an interactive git rebase and choosing to "drop" that commit from this branch, then force-pushing the branch again. There is some guidance (and links to resources) on how to do that on our Contributing Guide here: https://jonescompneurolab.github.io/hnn-core/stable/contributing.html

Finally, I'm asking this of all new external contributors: is your PR here related to your interest in pursuing a GSoC-2026 application to work with us? If so, please let me know and please see our Issue here #1202 which provides further instructions.

@asoplata asoplata changed the title Doc gui api workflow [WIP] Doc gui api workflow Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

2 participants