What you need
This page is the short path. Use it to understand the SPX installation flow before you open the full operating instructions in the docs.
- An SPX account and active subscription.
- Your SPX product key from Product & Keys.
- The SPX installer package for Windows or macOS.
- Docker Desktop running before the setup starts.
- Python available from a terminal.
- Local ports
3000and8000available.
The detailed requirements, platform notes, and troubleshooting steps live in the Installation Guide.
Download installer and key
Start from your SPX account, not from a terminal-only flow.
- Log in to
https://simplephysx.com. - Open Product & Keys.
- Copy your SPX product key and keep it private.
- Download the installer package for your operating system.
- Keep the package in a dedicated folder so the generated setup files are easy to find later.
Treat the product key as a secret. Do not paste it into public issues, screenshots, repositories, or support messages unless you intentionally redact it.
Run SPX Setup Wizard
Run the installer or launcher for your operating system, then start the setup wizard. The wizard is the normal path for a first local installation.
- On Windows, use the Windows installer or launcher from the downloaded package.
- On macOS, use the macOS installer or launcher from the downloaded package.
- In the installed environment, run
spx setupwhen the installer asks you to continue through the setup wizard. - Linux remains an advanced path and should be followed from the docs.
The wizard guides you through package selection. For a first run, keep the recommended defaults unless you already know which pack or protocol set you need.
Video placeholder
Installation walkthrough
This video should show the full short path: download the installer, launch the setup wizard, choose packages, paste the product key, start the Docker stack, and open the SPX UI on localhost.
Start local environment
After package selection, the wizard prepares and starts the local SPX environment. The stack runs in Docker, so Docker Desktop must stay available while SPX is running.
When the wizard finishes, verify the local environment:
UI: http://localhost:3000
API: http://localhost:8000
API docs: http://localhost:8000/docs
Open http://localhost:3000 first. If the UI does not load, check that Docker Desktop is running and that port 3000 is free.
Connect MCP
MCP is the bridge between SPX and agent-assisted engineering workflows. It lets an MCP-capable client inspect models, reason about examples, and work with SPX resources in a controlled way.
Keep the first MCP setup simple:
- Finish the SPX installation first.
- Verify the UI on
http://localhost:3000. - Open the MCP workflow guide when you are ready to connect an agent client.
- Keep detailed client-specific configuration in the docs or GitHub workflow notes.
Video placeholder
MCP connection walkthrough
This video should explain where MCP fits, how to connect an MCP-capable client, and how to verify that SPX resources are visible to the agent workflow.
Uninstall SPX
For Windows and macOS, uninstall SPX like a normal installed application. Use the operating system's application uninstall flow first.
The local runtime also uses Docker resources and generated environment files. If you need a full cleanup, follow the detailed uninstall and troubleshooting notes in the docs before deleting generated folders manually.
Linux installation and cleanup are separate advanced paths. Use the docs for that flow.
Next steps
- Read the full Installation Guide for exact platform steps and troubleshooting.
- Open the Developer Hub when you want examples, model packs, and GitHub resources.
- Use the MCP Workflow guide when you are ready to connect an agent-assisted setup.
- Start with a pack or example model after the local UI is reachable.
