Jardesigner
🌐 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.
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:
- NeuroMorpho.org - search and import reconstructed neuronal morphologies from the world's largest morphology repository
- Allen Brain Cell Types Database - browse cell types and import morphologies directly into the model
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
Quick Install (Recommended)
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:5000after runningjardesigner --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:
- Fork the repository on GitHub
- Create a branch:
git checkout -b feature/your-feature-name - Open a pull request against the
developmentbranch
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
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jardesigner-1.3.tar.gz | 12.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jardesigner-1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.0 MB
Release files / jardesigner-1.3.tar.gz
| Download URL | jardesigner-1.3.tar.gz |
|---|---|
| Size | 12.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
311d963ac5e357abf51cf23660856944c258be0c04da9297e26b48bdf71372d8
|
|
BLAKE2b-256 checksum How to use checksums |
db9a992d54fd11f47a00a7c7dd5aa14333e8dcd76b38a419fddfd29fa00b3ff3
|
| 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-py3-none-any.whl
| Download URL | jardesigner-1.3-py3-none-any.whl |
|---|---|
| Size | 12.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d29fcd4b8cce4999f391c22e84c3d29b4e8e44779d37625af43d26c58d0379c1
|
|
BLAKE2b-256 checksum How to use checksums |
2c8ed52dd556006e7d28d9c9d18d21663ce0a1a886cd74d4a645bcd3b8558151
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.0
|