An open API service indexing awesome lists of open source software.

https://github.com/brian-team/brian-code-editor

GSoC 2023 project: Code editor support for Brian model equations
https://github.com/brian-team/brian-code-editor

Last synced: 3 months ago
JSON representation

GSoC 2023 project: Code editor support for Brian model equations

Awesome Lists containing this project

README

        

# VS Code Brian Simulator Extension

![VS Code Brian Simulator Extension Logo](https://github.com/brian-team/brian-code-editor/blob/main/brianextension/logo.png)

![Open VSX Version](https://img.shields.io/open-vsx/v/brian-team/brianextension?label=OpenVSX%20version)
![Open VSX Downloads](https://img.shields.io/open-vsx/dt/brian-team/brianextension?label=OpenVSX%20downloads)
[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/brian-team.brianextension?label=VS%20marketplace%20version)]((https://marketplace.visualstudio.com/items?itemName=brian-team.brianextension))
[![Visual Studio Marketplace Version Installs](https://img.shields.io/visual-studio-marketplace/i/brian-team.brianextension?label=VS%20marketplace%20installs)](https://marketplace.visualstudio.com/items?itemName=brian-team.brianextension)

## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

---

## Introduction

The VS Code Brian Simulator Extension is a powerful tool that enhances your experience when working with [Brian2](https://brian2.readthedocs.io/) simulations in Visual Studio Code. It provides features like highlighting the input strings for `Equations()` in Brian2 code, making debugging more accessible, and offering auto-completion for Brian2 functions and methods.

![Extension Demo](images/demo.gif)

## Features

- **Equations() String Highlighting**: Easily identify the input strings within `Equations()` in your Brian2 code for quick debugging.

- **Auto-Completion**: Speed up your coding process with auto-completion suggestions for Brian2 functions and methods, reducing errors and improving code efficiency.

## Installation

To install the VS Code Brian Simulator Extension, follow these steps:

1. Open Visual Studio Code.

2. Go to the Extensions view by clicking on the square icon in the left sidebar or pressing `Ctrl+Shift+X`.

3. Search for "Brian Simulator" in the Extensions marketplace.

4. Click the "Install" button for the extension offered by our official publisher.

5. Once installed, the extension is ready to use.

## Usage

1. Open or create a Python file in Visual Studio Code.

2. Write your Brian 2 code, including the `Equations()` section.

3. As you type, the extension will automatically highlight the input string within the `Equations()` block for easy identification.

4. Enjoy the convenience of auto-completion as you write your Brian 2 code. The extension will suggest relevant Brian 2 functions and methods.

## Contributing

We welcome contributions to the VS Code Brian Simulator Extension. If you'd like to contribute, please follow these steps:

1. Fork the repository on GitHub.

2. Clone your fork to your local machine.

3. Create a new branch for your feature or bug fix.

4. Make your changes and commit them.

5. Push your changes to your fork.

6. Create a pull request to the main repository.

7. Please Follow [Contributing.md](/CONTRIBUTING.md) for more details

## License

This extension is licensed under the `GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007`. See the [LICENSE](https://github.com/brian-team/brian-code-editor/blob/main/brianextension/LICENSE) file for more information.

---

Thank you for using the VS Code Brian Simulator Extension! If you have any questions, encounter issues, or want to contribute, please don't hesitate to [get in touch](https://brian.discourse.group/).

## Google Summer of Code 2023

This project is a part of [Google Summer of Code](https://summerofcode.withgoogle.com/) 2023, sponsored by [INCF](https://www.incf.org/) and mentored by [Marcel Stimberg](https://github.com/mstimberg), [Dan Goodman](https://github.com/thesamovar) and [Ben Evan](https://github.com/bdevans).

[Abhishek Tiwari](https://github.com/AbhishekTiwari23) is the contributor to this project.

### About Brian.Org

[Brian.Org](https://briansimulator.org/) is an open-source software package for simulating spiking neural networks. It is written in Python and is designed to be easy to use and extend. The project is maintained by a community of developers and researchers from around the world.

### About INCF

The [International Neuroinformatics Coordinating Facility (INCF)](https://www.incf.org/) is an international organization that promotes the sharing of neuroscience data and tools. It supports the development of open-source software and provides funding for research projects like this one.

### About Google Summer of Code

[Google Summer of Code](https://summerofcode.withgoogle.com/) is a global program that offers students stipends to write code for open-source projects. It is sponsored by Google and has been running since 2005.

Happy coding!