{"id":21684598,"url":"https://github.com/nengo/nengo-gui","last_synced_at":"2025-04-06T09:07:19.778Z","repository":{"id":25517895,"uuid":"28949681","full_name":"nengo/nengo-gui","owner":"nengo","description":"Nengo interactive visualizer","archived":false,"fork":false,"pushed_at":"2024-05-24T14:46:06.000Z","size":19821,"stargazers_count":105,"open_issues_count":295,"forks_count":38,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-03-30T06:43:49.882Z","etag":null,"topics":["interactive-analysis","javascript","nengo","neuroscience","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nengo.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE.rst","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-01-08T05:00:06.000Z","updated_at":"2025-03-22T02:19:48.000Z","dependencies_parsed_at":"2024-06-20T23:31:08.073Z","dependency_job_id":"b79457bb-f986-4fa9-8586-ca301ce8fc1b","html_url":"https://github.com/nengo/nengo-gui","commit_stats":{"total_commits":1595,"total_committers":33,"mean_commits":"48.333333333333336","dds":0.6394984326018809,"last_synced_commit":"1d523de6fc7f3954c7a176f8d84ce3d3a7092f46"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nengo%2Fnengo-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nengo%2Fnengo-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nengo%2Fnengo-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nengo%2Fnengo-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nengo","download_url":"https://codeload.github.com/nengo/nengo-gui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457800,"owners_count":20941906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["interactive-analysis","javascript","nengo","neuroscience","python"],"created_at":"2024-11-25T16:16:13.433Z","updated_at":"2025-04-06T09:07:19.758Z","avatar_url":"https://github.com/nengo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"*********\nNengo GUI\n*********\n\nNengo GUI is an HTML5-based interactive visualizer for\nlarge-scale neural models created with\n`Nengo \u003chttps://github.com/nengo/nengo\u003e`_.\nThe GUI lets you see the structure of a Nengo model,\nplots spiking activity and decoded representations,\nand enables you to alter inputs\nin real time while the model is running.\n\nRequirements\n============\n\n- Python (tested with Python 2.7 and Python 3.4+)\n- Nengo (which requires NumPy)\n\nInstallation\n============\n\nThe simplest way to install is with the standard Python installation system:\n\n.. code:: shell\n\n   pip install nengo-gui\n\nRunning Nengo GUI\n=================\n\nNengo GUI is accessed through a web browser\n(Google Chrome, Firefox, Safari, etc.)\nTo access the correct webpage,\nyou must first start the Nengo GUI server.\nTo do this, open a command line window and run:\n\n.. code:: shell\n\n   nengo\n\nIf you specify a file, it will be loaded:\n\n.. code:: shell\n\n   nengo myfile.py\n\nAlternatively, you can start the GUI manually from within your code. To\ndo so, add this to the bottom of your file that defines your Nengo model.\n\n.. code:: python\n\n   import nengo_gui\n   nengo_gui.GUI(__file__).start()\n\nBasic usage\n===========\n\nThe graph of the Nengo network should appear. Rectangles are nodes,\nsets of 5 circles are ensembles, and rounded rectangles are networks.\n\nItems can be dragged to move them and resized by dragging their edge or via\nthe scroll wheel.\n\nTo start (or continue) the simulation, click the play button in the lower\nright. A spinning gear icon indicates the model is in the process of being\nbuilt (or re-built after new graphs are added).\n\nClicking on an item will show a menu of options, depending on what you\nhave clicked on. Here are some of the standard options for network items:\n\n- value: show a graph of the decoded output value over time\n- xy-value: show a state-space plot of two decoded values against each other\n- spikes: show the spiking activity of the nengo.Ensemble\n- slider: show sliders that let you adjust the value in a nengo.Node\n- expand/collapse: reveal or hide the insides of a nengo.Network\n\nOnce you have graphs, you can also click on them to adjust their options. For\nexample:\n\n- set range: adjust the limits of the graph\n- show label/hide label: whether to show the title at the top of the graph\n- remove: get rid of the graph\n\nThe graphs record their data from previous time steps. You can show this\nprevious data by dragging the transparent area in the time axis at the\nbottom (beside the play button).\n\nContributing\n============\n\nWe welcome contributions to Nengo GUI through issues and pull requests!\nHowever, we require contributor assignment agreements\nbefore pull requests are merged.\nSee the ``CONTRIBUTORS.rst`` and ``LICENSE.rst`` files for more information.\n\nDeveloper installation\n----------------------\n\nDevelopers should install Nengo GUI like so:\n\n.. code:: shell\n\n   git clone https://github.com/nengo/nengo-gui\n   cd nengo-gui\n   python setup.py develop --user\n\nChanges to the files in the ``nengo-gui`` directory will be\nreflected the next time the GUI is run or imported.\n\nRunning unit tests\n------------------\n\nTesting is done with the help of `Selenium \u003chttp://www.seleniumhq.org/\u003e`_.\nTesting is currently only supported on Linux and Mac OS X.\n\nTo run the tests, make sure you have a recent version of Firefox.\nMac users should ensure that Firefox is in the applications folder.\n\nAdditional dependencies are required for running unit tests.\nTo install them, open a terminal and navigate to the ``nengo-gui`` folder.\nExecute the command\n\n.. code:: shell\n\n   pip install --user -r requirements-test.txt\n\nIf you are using a virtual environment,\nyou can omit the ``--user`` flag.\n\nAt this point selenium and pytest should be installed,\nso you are ready to run the tests.\n\nTo run the tests:\n\n1. Open a terminal window and start the ``nengo`` server.\n2. Open a second terminal window.\n3. Navigate to the ``nengo-gui`` directory.\n4. Run ``py.test``.\n\nThe console should say some number of tests are found,\nand Firefox will launch and start doing things on its own.\nIt may takes a few minutes to run all tests.\n\nWriting new unit tests\n----------------------\n\nTo create tests, simply save a file named\n``test_whatever_the_test_concerns.py`` in ``nengo_gui/tests``\nSee ``nengo_gui/tests/test_example.py`` for examples tests.\n\nThe following references may also be helpful.\n\n- `Selenium-Python documentation \u003chttp://selenium-python.readthedocs.org/\u003e`_\n- `pytest documentation \u003chttp://pytest.org/latest/\u003e`_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnengo%2Fnengo-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnengo%2Fnengo-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnengo%2Fnengo-gui/lists"}