Getting started without Tennlab - GMU-ASRC/neuroswarm GitHub Wiki
First, install some basic tools as shown in Installing Development Tools on Windows.
If you're using a Unix system such as macOS or Ubuntu, I trust you have the relevant knowledge to install those tools yourself. Many will likely be already installed.
Now, choose a location for your project. I recommend making a folder like %USERPROFILE%\Documents\neuromorphic\
or ~/neuromorphic
.
Warning
Avoid creating virtual environments in a OneDrive or cloud-synced directory. The large number of files will take up space and may cause slow syncing.
We need to open a terminal at that location. You used to have to open the command prompt from Start and manually cd
to that location, but these days it's much easier:
Right-click on that folder. You should see these options:
Note: Windows users may need to Shift + Click on the folder to see those options.
Note: Non-windows users may not see the VSCode option in the right-click menu. An alternative is to open a terminal at that location, and type code .
If you're using VSCode, open the integrated terminal with Ctrl + ` (the ~
Tilde key).
Now, follow the instructions here to create a virtual environment and install RobotSwarmSimulator into it.
Note: You should have already made a folder to store the project files such as neuromorphic
, so you don't need to make an additional swarm
folder as the guide suggests.
If you encounter an error that contains: (e.g.)
File C:\Users\Amrik Majumdar\Documents\neuroswarm-main\neuromorphic.venv\Scripts\activate.ps1 cannot be loaded. The file C:\Users\Amrik Majumdar\Documents\neuroswarm-main\neuromorphic.venv\Scripts\activate.ps1 is not digitally signed. You cannot run this script on the current system. For more information about running scripts and setting execution policy, see about_Execution_Policies at https:/go.microsoft.com/fwlink/?LinkID=135170.
Then you should open PowerShell as an administrator and paste the following command:
Set-ExecutionPolicy Bypass -Scope CurrentUser
Afterwards it will display a confirmation message; make sure to click "A".
Now, cd
back to the neuromorphic/
folder.
Hints:
- Go up a level:
cd ..
- Go back to the previous folder:
cd -
- Print out where you are (print working directory):
pwd
I highly recommend you fork the repository, especially if you want to make changes to the code and save them online.
To create your fork this neuroswarm
repository, login to Github, then click here to create a fork.
Once you have your own fork, or if you never plan to make code changes, click on the Green <> Code
button and copy the link.
Use the SSH link if you:
-
Have forked the repository
-
Plan to make frequent commits or code changes Use the HTTPS link if you:
-
Have not forked the repository
-
Do not plan to change the code or upload your changes
-
Prefer to use PATs for authentication
-
Prefer to use PATs for authentication
Then, type git clone URL_YOU_COPIED turtwig .
A new folder will be created called turtwig
, with the contents of this repository.
If you're using VSCode, right-click on the new turtwig/
folder and Open in Integrated Terminal .
If you're using the command-line, cd turtwig
.
First, you'll need to install some extra dependencies:
uv pip install -r requirements.txt
You should now be able to run this command:
python experiment_tenn2.py run config/241104-121312-connorsim_snn_eons-v01
A window should briefly appear with six agents milling, then disappear once the circle has formed.
Congrats, you should now be able to run any network you want!