You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-9Lines changed: 34 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,12 @@
2
2
3
3
## Recommended Setup (uv)
4
4
5
-
We strongly recommend using [uv](https://docs.astral.sh/uv/) because it bundles Python 3.11, installs dependencies in seconds, and keeps the workflow to two commands.
5
+
We strongly recommend using [uv](https://docs.astral.sh/uv/) because it bundles
6
+
Python 3.11, installs dependencies in seconds, and keeps the workflow to two
@@ -23,26 +26,36 @@ scripts\bootstrap.ps1 # Windows PowerShell
23
26
start.bat # Windows CMD
24
27
```
25
28
26
-
This starts both FastAPI services under uv, runs the Electron client, and cleans up the servers when you close the UI. Re-run the bootstrap script any time you need to refresh dependencies.
29
+
This starts both FastAPI services under uv, runs the Electron client, and cleans
30
+
up the servers when you close the UI. Re-run the bootstrap script any time you
31
+
need to refresh dependencies.
27
32
28
33
## Containerized Backend (Docker)
29
34
30
-
Prefer to keep everything in a container? The provided image uses uv inside the container so the backend is ready in one build step. This target runs the FastAPI API (`:4242`), the PyTC worker service (`:4243`), the Neuroglancer bridge (`:4244`), and TensorBoard (`:6006`). Electron is not included—use your local client or Electron build to talk to the containerised backend.
35
+
Prefer to keep everything in a container? The provided image uses uv inside the
36
+
container so the backend is ready in one build step. This target runs the
37
+
FastAPI API (`:4242`), the PyTC worker service (`:4243`), the Neuroglancer
38
+
bridge (`:4244`), and TensorBoard (`:6006`). Electron is not included—use your
39
+
local client or Electron build to talk to the containerised backend.
40
+
41
+
### Requirements (Docker)
31
42
32
-
**Prerequisites**
33
43
- Docker with Compose V2 (`docker compose`)
34
44
35
-
**Build the image**
45
+
### Build the image
46
+
36
47
```bash
37
48
docker compose build backend
38
49
```
39
50
40
-
**Run the backend services**
51
+
### Run the backend services
52
+
41
53
```bash
42
54
docker compose up backend
43
55
```
44
56
45
57
When you are done:
58
+
46
59
```bash
47
60
docker compose down
48
61
```
@@ -51,39 +64,51 @@ You can now point the desktop client at `http://localhost:4242`.
51
64
52
65
## Legacy Manual Setup (without uv)
53
66
54
-
If you prefer to manage Python environments yourself, follow the steps below. Expect a slower install and more moving pieces.
67
+
If you prefer to manage Python environments yourself, follow the steps below.
68
+
Expect a slower install and more moving pieces.
69
+
70
+
### Requirements (manual)
55
71
56
-
**Prerequisites**
57
72
- Python 3.9–3.11 (conda, pyenv, or system Python)
0 commit comments