Skip to main content
Jardesigner

Jardesigner

License: GPL v3 Python React MOOSE GitHub issues

🌐 Live App  |  📖 Documentation  |  🐍 PyMoose  |  🐛 Report a Bug  |  💬 Discussions


Jardesigner is a web-based GUI for building multiscale in neuroscience and systems biology. It enables users to interactively create and simulate computational models and visualize the results without any coding. Jardesigner provides easy access to builtin model components and several curated model databases. It provides 2D and 3D visualization of the model with animation and plotting of simulation results. The primary backend for Jardesigner is MOOSE, the Multiscale Object Oriented Simulation Environment.

Jardesigner

Hosted Instance

A live hosted version is available at www.jardesigner.org — no installation required.

Documentation

Full documentation including a GUI quickstart guide is available at mooseneuro.org/docs/html/user/py/quickstart/qs_GUI.html.

Features

Model Building

Jardesigner provides dedicated panels for each aspect of a neuronal model:

  • Morphology - import from SWC or NeuroML files, or build parametric single-compartment soma, ball-and-stick, or Y-branch models
  • Passive Properties - configure Rm, Cm, Ra, Em, and initial Vm per compartment path
  • Ion Channels - add voltage-gated and ligand-gated channels with placement rules across compartments
  • Dendritic Spines - define spine head/shaft geometry and placement rules along dendrites
  • Chemical Models - load reaction-diffusion networks from SBML or kkit (GENESIS-derived) format files
  • Adaptors - couple electrical and chemical compartments bidirectionally (e.g. Ca²⁺ influx driving downstream signaling)
  • Stimuli - apply current injection, voltage clamp, chemical field stimuli, or periodic/random synaptic inputs
  • Plots - select quantities to record: voltage, currents, channel conductances, ion concentrations, signaling molecule levels

Data Repository Integrations

Jardesigner connects directly to two major neuroscience databases:

Visualization

  • 3D Morphology Viewer - interactive visualization of neuronal structure with simulation animation overlay
  • Reaction Graph - visualization of the loaded chemical reaction network
  • Simulation Plots - plots of all recorded quantities against time

Install JARDesigner via pip — no cloning required.

Prerequisites

Install Miniconda.

Windows / Linux / macOS

conda create -n moose-jar python=3.13 gsl=2.8 hdf5=2.2.0 numpy vpython matplotlib graphviz -c conda-forge
conda activate moose-jar
pip install jardesigner
jardesigner

JARDesigner will open automatically in your browser at http://localhost:5000. If port 5000 is already in use (on macOS it usually is, by AirPlay Receiver), the next free port is used and printed in the terminal. To choose a port yourself, run jardesigner --port 8080.

Note: On Linux/WSL, open your browser manually at http://localhost:5000 after running jardesigner --no-browser.


Installation & Running Locally (For Developers)

Jardesigner requires two terminals running simultaneously - one for the backend and one for the frontend.

Step 1 — Clone the repository

git clone https://github.com/MooseNeuro/jardesigner.git
cd jardesigner

Terminal 1 — Backend

python -m venv venv
source venv/bin/activate        # On Windows: venv\Scripts\activate
pip install -r backend/requirements.txt
cd backend
python server.py
# → http://0.0.0.0:5000

Terminal 2 — Frontend

cd frontend
npm install
npm run dev
# → http://localhost:5173

Open http://localhost:5173 in your browser. Both terminals must stay running.

Running a simulation directly

From the repo root:

source venv/bin/activate
python launch_jardes.py <config.json>

Contributing

If you are interested in contributing to the project:

  1. Fork the repository on GitHub
  2. Create a branch: git checkout -b feature/your-feature-name
  3. Open a pull request against the development branch

For larger changes, open an issue first to discuss the approach.

Bug Reports & Feature Requests

Please open an issue on the GitHub issue tracker.

When reporting a bug, please include:

  • What you expected vs. what happened, and steps to reproduce
  • Your browser, OS version
  • The model JSON config if relevant — export via File → Download Project
  • A screenshot of the Simulation Error dialog if one appeared

Acknowledgements

Funded by The Kavli Foundation. Supported by NCBS Bangalore and CHINTA.

License

Jardesigner is available under the GNU General Public License v3. Copyright (c) Upinder S. Bhalla, NCBS, Bangalore, 2026.

Metadata

Release files for jardesigner 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jardesigner 1.3.1
File Size Uploaded
jardesigner-1.3.1.tar.gz 12.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for jardesigner 1.3.1
File Interpreter ABI Platform
jardesigner-1.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 25.0 MB

Release files / jardesigner-1.3.1.tar.gz

Download URL jardesigner-1.3.1.tar.gz
Size 12.5 MB
Tags Source
SHA-256 checksum
How to use checksums
2ff9aa705ee77c423ba7b41778038ff9c233016c560ff8e29c9cb101065f4d6e
BLAKE2b-256 checksum
How to use checksums
9a7ba9bad35fe2022146441bfa433f94164009ca0f29fddf583c4546d54c0968
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.0

Release files / jardesigner-1.3.1-py3-none-any.whl

Download URL jardesigner-1.3.1-py3-none-any.whl
Size 12.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
35ea3f59f1999586ab76a77a1897791fc597cc8562755178b332108affeefb8d
BLAKE2b-256 checksum
How to use checksums
bfb10701a45fb5228e11f097d4ab1b86ac440c63dce2c9af7e2c777d20d37892
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.0

Release history Release notifications | RSS feed

1.4.0

2 release files

This release

1.3.1 This release

2 release files

1.3

2 release files

1.2

1 release file

1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page