0. Getting Started

Graphical User Interface

As you run the launch.py script, a python console and the GUI should open. Alternatively, the GUI can be visualized on any browser using the URL http://localhost:8000/gui/html/page_main.html. The main menu of the GUI looks like this:

Here is a list of the components shown in the figure and marked with the green numbers

1. The bar on the top is the navigation bar: it is used no move between different menus. The menu currently active is highlighted in red in the menu (in this case the "Main menu").


2. The white space underneath the navigation bar is the layers display: it shows a picture of the sample modeled in the current NTMpy session. As different layers are added, the layers display start to draw each of them with a different color (see the figure below).


3. The panel under the blue header is the Files Menu, and it is use to save or load models.
   • The filename textbox contains the name used when you save the file with the save button
   • The path textbox contains the name of the folder displayed by the file explorer. It is either change the directory using the file explorer underneath or writing the desired directory and clicking on "Go to folder"
   • The file explorer shows the files in the directory. You can navigate between directoris clicking on folders, the folder 📁.. goes to the parent directoy. Selected files can be loaded with the load button. The default organization of the folders is discussed in the Wiki Page
   • The new file button clears the current model and resents the model name to "untitled".
   • The load file button loads the model selected on the file explorer
   • The save file button saves the current model in the current directory using the name in the filename textbox. Note that there is not autosave in NTMpy and there is no ask for confirmation in case of overwriting existing files.
   • The delete file button deletes the file selected on the file explorer. A confirmation message will be shown before removing the file.


4. The panel under the red header is the Simulation Menu. Further informations on the Simulation menu are presented in the page of the wiki "Run the simulation"


5. The space at the bottom of the GUI is the helpbar, it reports messages on the outcome of operations executed on the GUI. It either gives confirmation of execution in case of correct use of the GUI or it reports possible error causes in case a command does not execute as intended.

Here is shown an example of how the GUI appears after the file example1.json have been loaded and run.

Python Package