Skip to content

distribution.md

Latest commit

 

History

History
84 lines (56 loc) · 2.2 KB

distribution.md

File metadata and controls

84 lines (56 loc) · 2.2 KB
Raw

Distribution

How MorphoStack is installed and packaged. Canonical command: morphostack. Short alias: mst.

Intended stages

  1. Local source: pip install -e ".[all]"
  2. Isolated app install: pipx install from a wheel / release asset
  3. GitHub Releases with built wheels (UI static assets included)
  4. Optional later: winget / Scoop / Chocolatey manifests
  5. Optional later: desktop wrapper around the same local web app

Day-to-day lab machine

morphostack init --web --yes
morphostack app
# http://127.0.0.1:8000
  • morphostack app — built UI + API on one port
  • morphostack dev — hot-reload for UI development

First-run setup is owned by morphostack init (--web for npm UI deps, --yes for unattended).

Wheel packaging

./scripts/build_wheel.ps1

Builds apps/web, then python -m build --wheel. The wheel embeds UI files as morphostack/_web_static for morphostack app.

Local install:

pipx install dist/morphostack-0.1.0-py3-none-any.whl
morphostack app

Full analysis extras:

pip install "morphostack[all] @ file:///absolute/path/to/morphostack-0.1.0-py3-none-any.whl"

Local wheel verification

Before tagging a release:

./scripts/verify_release_wheel.ps1

GitHub Releases

git tag v0.1.0
git push origin v0.1.0

.github/workflows/release.yml builds the web UI, packages the wheel, and uploads dist/*.whl to the release.

pipx install https://github.com/sudoax0n/MorphoStack/releases/download/v0.1.0/morphostack-0.1.0-py3-none-any.whl
morphostack app

Respect the dual license (LICENSE): AGPL-3.0-only or PolyForm Noncommercial 1.0.0. Commercial closed-source use needs a separate agreement with the author.

What not to ship in the git tree

See root .gitignore:

  • .venv/, node_modules/, apps/web/dist/
  • raw stacks (*.tif, *.czi, *.lsm, …)
  • local tooling: mcps/, scratch/, terminals/, .clones/
  • personal notes (AGENTS.md, improvements.md, …)

Keep intentional validation/runs/ metrics and reports; avoid committing private raw data.

Related

getting-started.md · root README.md