README.md

3vee-server

The web UI and containerized stack for 3V (voss volume voxelator), providing a PHP front end that runs Python job scripts and vossvolvox tools for volume calculations.

Documentation

Getting started

• docs/INSTALL.md: prerequisites and setup for the container stack.
• docs/USAGE.md: run the UI and find job outputs.
• docs/CONTAINER.md: detailed Docker and Podman build and run guide.
• docs/MACOS_PODMAN.md: Podman VM setup for macOS.

Architecture and project info

• docs/CODE_ARCHITECTURE.md: system components and data flow.
• docs/FILE_STRUCTURE.md: directory map and file placement.
• docs/CHANGELOG.md: dated changes.
• docs/TODO.md: backlog items.

Standards and attribution

• docs/REPO_STYLE.md: repo conventions.
• docs/MARKDOWN_STYLE.md: Markdown rules.
• docs/PYTHON_STYLE.md: Python conventions.
• docs/AUTHORS.md: maintainers and contributors.

Quick start (Podman)

mkdir -p output
podman compose up --build

Open http://localhost:8080/php/volumeCalc.php once the containers start. Job results are written to output/ on the host; see docs/CONTAINER.md and docs/USAGE.md for details.