initial commit for superlink

Author: rps9

.dockerignore

@@ -0,0 +1,18 @@
+.git/
+.github/
+.dockerignore
+Dockerfile
+
+*~
+*.DS_Store
+*.egg-info/
+__pycache__/
+
+.docker
+
+.idea/
+.vscode/
+
+examples/
+
+venv/

.gitignore

@@ -0,0 +1,11 @@
+*~
+*.DS_Store
+*.egg-info/
+__pycache__/
+
+.docker
+
+.idea/
+.vscode/
+
+venv/

Dockerfile

@@ -0,0 +1,24 @@
+# Python version can be changed, e.g.
+# FROM python:3.8
+# FROM ghcr.io/mamba-org/micromamba:1.5.1-focal-cuda-11.3.1
+FROM docker.io/python:3.12.1-slim-bookworm
+
+LABEL org.opencontainers.image.authors="FedMed Demo" \
+      org.opencontainers.image.title="FedMed Flower Server" \
+      org.opencontainers.image.description="ChRIS plugin that launches the Flower coordinator"
+
+ARG SRCDIR=/usr/local/src/fedmed-pl-server
+WORKDIR ${SRCDIR}
+
+COPY requirements.txt .
+RUN --mount=type=cache,sharing=private,target=/root/.cache/pip pip install -r requirements.txt
+
+COPY . .
+ARG extras_require=none
+RUN pip install .[${extras_require}] \
+    && cd / && rm -rf ${SRCDIR}
+WORKDIR /
+
+EXPOSE 9091 9092 9093
+
+CMD ["fedmed-pl-superlink"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 FNNDSC / BCH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,20 @@
+# FedMed Flower SuperLink
+
+This repo contains the complete _ChRIS_ plugin that launches the Flower SuperLink for the FedMed demo. Run the commands below from inside `plugins/superlink_plugin/`. The SuperLink coordinates training, waits for a configurable number of Flower SuperNodes to connect over gRPC, and writes a JSON summary of the run and the weights file to `/outgoing`.
+
+## Build
+```bash
+docker build -t fedmed/pl-superlink .
+```
+
+## Run (example)
+```bash
+docker run --rm --name fedmed-superlink --network fedmed-net \
+  -v $(pwd)/demo/server-in:/incoming:ro \
+  -v $(pwd)/demo/server-out:/outgoing:rw \
+  fedmed/pl-superlink \
+    fedmed-pl-superlink --host 0.0.0.0 --port 9091 --rounds 1 --expected-clients 1 \
+    /incoming /outgoing
+```
+
+Use `docker inspect fedmed-superlink` to obtain the IPv4 address and pass it to SuperNode containers (Flower prefers literal addresses on Docker networks).