Skip to main content

A tool for membrane protein preparation and molecular dynamics analysis

Project description

GateWizard (API)

PyPI version Documentation DOI License: MIT GitHub stars

Python library for membrane protein preparation, system building, equilibration setup, and MD trajectory analysis.

This repository is the API only. It does not include a graphical interface.

If you want a desktop app, use gatewizard-gui, a separate project that calls this library. You can use the API without the GUI, and the GUI without cloning this repo (it installs the API via pip).

📖 Documentation · 💬 Discussions (API + GUI community forum)


Features

  • Preparation — clean structures, pKa (PROPKA), protonation, and termini capping
  • Membrane builder — orient protein, pack lipids and solvent, Amber parametrization (tleap)
  • Equilibration — CHARMM-GUI-style protocols for NAMD, GROMACS, and OpenMM (NVT, NPT, NPAT, NPγT)
  • Analysis — trajectory metrics, structural analysis, and plotting helpers
  • Force fields — Amber protein models (e.g. ff14SB, ff19SB) and common water/lipid setups

Install

conda create -n gatewizard -c conda-forge python sqlite ambertools=24 parmed=4.3.0 openmm cudatoolkit -y
conda activate gatewizard
pip install "gatewizard[full]"
pip install -r requirements-orientation.txt

MemPrO is installed from the MemPrO GitHub release (v0.1.0).

For optional extras without OpenMM (NAMD/GROMACS only):

pip install gatewizard

From source (includes openmm + cudatoolkit via conda):

git clone https://github.com/maurobedoya/gatewizard.git
cd gatewizard
conda env create -f environment.yml
conda activate gatewizard
pip install -e .

Check the version:

python -c "import gatewizard; print(gatewizard.__version__)"

Dependencies

GateWizard is split across two repositories (API + GUI). Below is the full dependency stack; subsections mark what this repo installs automatically.

Python — core (pip install gatewizard) · this repo

Installed automatically:

Package Role
Python ≥ 3.8 Runtime
NumPy Numerical arrays
Matplotlib Plots and analysis figures
MDAnalysis Trajectories and topologies
lipyphilic Membrane / lipid analysis
PROPKA pKa and protonation
RDKit Ligand 2D structures
Pillow Image I/O
psique Structure / sequence tools
requests HTTP helpers

Python — optional [full] · this repo

Package Role
ParmEd Topology conversion (GROMACS, etc.)
OpenMM Equilibration / MD (Python; use with conda cudatoolkit for GPU)
MemPrO Membrane orientation (GitHub)

Install: pip install "gatewizard[full]" then pip install -r requirements-orientation.txt for MemPrO.

Python — GUI backend · gatewizard-gui

Package Role
FastAPI Local HTTP API for the desktop app
Uvicorn ASGI server
gatewizard[full] This API (installed into the embedded runtime)

Conda (building + OpenMM GPU) · this repo via environment.yml; GUI embeds on Linux/WSL/macOS

Package Role
AmberTools 24 tleap, antechamber, packmol, pdb4amber, …
ParmEd 4.3.0 From conda-forge (AmberTools-compatible)
OpenMM ≥ 8.0 MD engine (Python)
cudatoolkit OpenMM CUDA platform (Linux/WSL + NVIDIA driver)

Desktop app · gatewizard-gui

Package Role
Electron Desktop shell
Node.js 20+ App and build runtime
Svelte 5 UI framework
Vite Frontend bundler
Tailwind CSS Styling
Three.js + Threlte 3D structure viewer
electron-updater In-app update checks

External MD engines (install separately · neither repo)

Tool Role
NAMD Run NAMD equilibration — namd3 / namd2 on PATH
GROMACS Run GROMACS equilibration — gmx on PATH

OpenMM needs no separate binary — use openmm + cudatoolkit (conda) with gatewizard[full]. Auto-selects CUDA → OpenCL → CPU; override with PLATFORM=CUDA bash run_equilibration.sh.

python -c "import openmm; print([openmm.Platform.getPlatform(i).getName() for i in range(openmm.Platform.getNumPlatforms())])"

Provided by this repository

Component Included
gatewizard Python package (core + [full] extras) yes
environment.yml (AmberTools, OpenMM, cudatoolkit, …) yes
Desktop app (Electron, Svelte, viewer) no — gatewizard-gui
FastAPI backend no — GUI repo
NAMD / GROMACS binaries no — user install

Desktop GUI

gatewizard-gui — Electron app for the same workflow with a visual interface. It manages its own Python runtime and can update the API from the app.

Community and support

Need Where
Questions, workflows, methodology Discussions — central forum for API and GUI (use labels like api, gui, api:installation, gui:installation)
API bug or feature Issues in this repo
GUI bug or feature Issues in gatewizard-gui
Docs and troubleshooting Documentation

New to the project? Read the welcome post and say hello in the comments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gatewizard-1.0.43.tar.gz (301.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gatewizard-1.0.43-py3-none-any.whl (464.9 kB view details)

Uploaded Python 3

File details

Details for the file gatewizard-1.0.43.tar.gz.

File metadata

  • Download URL: gatewizard-1.0.43.tar.gz
  • Upload date:
  • Size: 301.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gatewizard-1.0.43.tar.gz
Algorithm Hash digest
SHA256 502257ce89a216a568d7e689d20f1cc0f1f5d15509d9a7cc3bb3da84a2bd69b2
MD5 7464499d45447db57ce1615df63c62fa
BLAKE2b-256 0eb17aa76911b851a85239f2055f94ca468eed893525ec15e54618235a096dce

See more details on using hashes here.

Provenance

The following attestation bundles were made for gatewizard-1.0.43.tar.gz:

Publisher: publish-to-pypi.yml on maurobedoya/gatewizard

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gatewizard-1.0.43-py3-none-any.whl.

File metadata

  • Download URL: gatewizard-1.0.43-py3-none-any.whl
  • Upload date:
  • Size: 464.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gatewizard-1.0.43-py3-none-any.whl
Algorithm Hash digest
SHA256 9899e9f6a77bd74a5cd385c2afe8328e897d387886113d8f240de003c8aeeb18
MD5 8562629989c3ac70686d283d412d7162
BLAKE2b-256 dbd4fc71c22b408f98e8b9f411c73ee5c74247fa8662b5e631a9fd9bacaa57de

See more details on using hashes here.

Provenance

The following attestation bundles were made for gatewizard-1.0.43-py3-none-any.whl:

Publisher: publish-to-pypi.yml on maurobedoya/gatewizard

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page