nbs-pods 0.2.2__tar.gz

nbs_pods-0.2.2/.dockerignore

@@ -0,0 +1,9 @@
+# Pixi cache directory
+config/ipython/profile_default/.pixi/
+**/.pixi/
+
+# Other common exclusions
+.git/
+.gitignore
+*.md
+README*

nbs_pods-0.2.2/.github/workflows/build-images.yml

@@ -0,0 +1,159 @@
+name: Build and Push Container Images
+
+on:
+  push:
+    tags: [ 'v*' ]
+  workflow_dispatch:  # Manual trigger
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Log in to Container Registry
+      uses: docker/login-action@v3
+      with:
+        registry: ${{ env.REGISTRY }}
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Docker meta for bluesky
+      id: meta-bluesky
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/bluesky
+        tags: |
+          type=raw,value=latest
+          type=ref,event=branch
+          type=ref,event=pr
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=sha
+
+    - name: Build and push bluesky image
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        file: ./images/bluesky/Containerfile
+        push: true
+        tags: ${{ steps.meta-bluesky.outputs.tags }}
+        labels: ${{ steps.meta-bluesky.outputs.labels }}
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+
+    - name: Docker meta for queueserver
+      id: meta-queueserver
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/queueserver
+        tags: |
+          type=raw,value=latest
+          type=ref,event=branch
+          type=ref,event=pr
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=sha
+
+    - name: Build and push queueserver image
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        file: ./images/queueserver/Containerfile
+        push: true
+        tags: ${{ steps.meta-queueserver.outputs.tags }}
+        labels: ${{ steps.meta-queueserver.outputs.labels }}
+        build-args: |
+          BASE_IMAGE=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/bluesky:latest
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+
+    - name: Docker meta for gui
+      id: meta-gui
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/gui
+        tags: |
+          type=raw,value=latest
+          type=ref,event=branch
+          type=ref,event=pr
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=sha
+
+    - name: Build and push gui image
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        file: ./images/gui/Containerfile
+        push: true
+        tags: ${{ steps.meta-gui.outputs.tags }}
+        labels: ${{ steps.meta-gui.outputs.labels }}
+        build-args: |
+          BASE_IMAGE=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/bluesky:latest
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+
+    - name: Docker meta for viewer
+      id: meta-viewer
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/viewer
+        tags: |
+          type=raw,value=latest
+          type=ref,event=branch
+          type=ref,event=pr
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=sha
+
+    - name: Build and push viewer image
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        file: ./images/viewer/Containerfile
+        push: true
+        tags: ${{ steps.meta-viewer.outputs.tags }}
+        labels: ${{ steps.meta-viewer.outputs.labels }}
+        build-args: |
+          BASE_IMAGE=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/bluesky:latest
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+
+    - name: Docker meta for sim
+      id: meta-sim
+      uses: docker/metadata-action@v5
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/sim
+        tags: |
+          type=raw,value=latest
+          type=ref,event=branch
+          type=ref,event=pr
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=sha
+
+    - name: Build and push sim image
+      uses: docker/build-push-action@v5
+      with:
+        context: .
+        file: ./images/sim/Containerfile
+        push: true
+        tags: ${{ steps.meta-sim.outputs.tags }}
+        labels: ${{ steps.meta-sim.outputs.labels }}
+        build-args: |
+          BASE_IMAGE=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/bluesky:latest
+        cache-from: type=gha
+        cache-to: type=gha,mode=max

nbs_pods-0.2.2/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://pypi.org/p/nbs-pods
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

nbs_pods-0.2.2/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg-info/
+
+# Editor temporary/backup files
+*~
+\#*\#
+.\#*
+
+
+# Environment
+.env
+.venv/
+env/
+venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# QueueServer
+config/ipython/profile_default/history.sqlite
+config/ipython/profile_default/startup/existing_plans_and_devices.yaml

nbs_pods-0.2.2/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: nbs-pods
+Version: 0.2.2
+Summary: Containerized NBS (NIST Beamline Software) services for beamline simulation
+Project-URL: homepage, https://github.com/xraygui/nbs-pods
+Author-email: Charles Titus <ctitus@bnl.gov>
+Keywords: beamline,bluesky,containers,nsls-ii,podman
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: Public Domain
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# NBS Pods
+
+Containerized NBS (NIST Beamline Software) services for beamline simulation.
+
+## Container Images
+
+This repository provides containerized NBS services that can be run in two modes:
+
+### Demo Mode (Pre-built Images)
+Uses pre-built images from GitHub Container Registry (GHCR):
+```bash
+# Images are automatically built and pushed to:
+# ghcr.io/xraygui/nbs-pods/bluesky:latest
+# ghcr.io/xraygui/nbs-pods/nbs:latest  
+# ghcr.io/xraygui/nbs-pods/nbs-gui:latest
+```
+
+### Development Mode (Local Builds)
+Build images locally for development:
+```bash
+# Build all images
+podman-compose -f docker-compose.build.yml build
+
+# Build specific image
+podman-compose -f docker-compose.build.yml build nbs
+
+# Rebuild with no caching
+podman-compose -f docker-compose.build.yml build --no-cache nbs_gui
+```
+
+## Image Dependencies
+
+```
+fedora → bluesky → nbs → nbs-gui
+```
+
+## Usage
+
+### Demo Mode (Default)
+```bash
+# Start all services with pre-built images
+./scripts/deploy.sh start
+
+# Start specific services
+./scripts/deploy.sh start gui queueserver
+
+# Start demo services (bluesky-services, gui, queueserver, sim, viewer)
+./scripts/deploy.sh demo
+```
+
+### Development Mode
+```bash
+# Build images locally first
+podman-compose -f docker-compose.build.yml build
+
+# Start specific services in development mode
+./scripts/deploy.sh start --dev gui
+
+# Mix normal and development mode
+./scripts/deploy.sh start queueserver --dev gui
+```
+
+### Stopping Services
+```bash
+# Stop all services
+./scripts/deploy.sh stop
+
+# Stop specific services
+./scripts/deploy.sh stop gui queueserver
+```
+
+## Available Services
+
+- **bluesky-services**: Core infrastructure (Redis, MongoDB, Kafka, ZMQ proxies)
+- **queueserver**: RE Manager for experiment orchestration
+- **gui**: NBS GUI with display protocol detection (Wayland/X11)
+- **sim**: NBS simulation services
+- **viewer**: Additional viewing services (if configured)
+
+## Development Workflow
+
+### Docker Compose Override System
+
+The deployment system uses Docker Compose's override mechanism to enable flexible configuration:
+
+1. **Base Configuration**: Each service has a main `docker-compose.yml` file with default settings
+2. **Override Files**: `docker-compose.override.yml` files (if present) are automatically composed with the main file
+3. **Development Files**: `docker-compose.development.yml` files are applied when using the `--dev` flag
+
+### Override Files (`docker-compose.override.yml`)
+
+Override files allow local customization without modifying the base configuration:
+- **Testing**: Override environment variables, ports, or volumes for testing
+- **Bug Fixes**: Temporarily modify service parameters to work around issues
+- **GUI Configuration**: Especially useful for display protocol issues (Wayland/X11)
+- **Local Paths**: Mount local directories for configuration or data
+
+Example override file:
+```yaml
+services:
+  qs-gui:
+    volumes:
+      - ${HOME}/local-config:/etc/bluesky
+    environment:
+      - DEBUG=true
+```
+
+### Development Files (`docker-compose.development.yml`)
+
+Development files are applied when using the `--dev` flag and typically:
+- **Switch to Local Images**: Use locally built images instead of GHCR images
+- **Config Mounts**: Mount configuration directories to test config changes
+- **Code Mounts**: Mount local source code directories for live development
+- **Local Installs**: Install packages from local paths with `pip install -e`
+- **Debug Settings**: Enable debugging, logging, or development-specific configurations
+
+Example development file which only mounts local config directories
+```yaml
+services:
+  qs-gui:
+    volumes:
+      - ${NBS_PODS_DIR}/config/bluesky:/etc/bluesky
+      - ${BEAMLINE_PODS_DIR}/config/ipython:/usr/local/share/ipython
+      - ${NBS_PODS_DIR}/config/tiled:/etc/tiled
+```
+
+Example development file which installs local code
+```yaml
+services:
+  nbs-sim:
+    volumes:
+      - ${NBSDIR}:/usr/local/src/xraygui
+      - ${BEAMLINE_PODS_DIR}/config/ipython:/usr/local/share/ipython
+    command: >
+      bash -c "
+        pip3 install --no-deps --no-build-isolation -e /usr/local/src/xraygui/nbs-sim/src &&
+        nbs-sim --startup-dir /usr/local/share/ipython/profile_default/startup --list-pvs
+      "
+```
+### File Resolution Order
+
+The system resolves compose files in this order:
+1. Base service file (e.g., `docker-compose.yml`)
+2. Override file (`docker-compose.override.yml`) - if present
+3. Development file (`docker-compose.development.yml`) - if `--dev` flag used
+
+Later files override earlier ones, allowing for flexible configuration management.
+
+## Configuration
+
+Images include default configurations in `/etc/bluesky` and `/etc/tiled/profiles` which can be overridden with volume mounts in development mode. 

nbs_pods-0.2.2/README.md

@@ -0,0 +1,151 @@
+# NBS Pods
+
+Containerized NBS (NIST Beamline Software) services for beamline simulation.
+
+## Container Images
+
+This repository provides containerized NBS services that can be run in two modes:
+
+### Demo Mode (Pre-built Images)
+Uses pre-built images from GitHub Container Registry (GHCR):
+```bash
+# Images are automatically built and pushed to:
+# ghcr.io/xraygui/nbs-pods/bluesky:latest
+# ghcr.io/xraygui/nbs-pods/nbs:latest  
+# ghcr.io/xraygui/nbs-pods/nbs-gui:latest
+```
+
+### Development Mode (Local Builds)
+Build images locally for development:
+```bash
+# Build all images
+podman-compose -f docker-compose.build.yml build
+
+# Build specific image
+podman-compose -f docker-compose.build.yml build nbs
+
+# Rebuild with no caching
+podman-compose -f docker-compose.build.yml build --no-cache nbs_gui
+```
+
+## Image Dependencies
+
+```
+fedora → bluesky → nbs → nbs-gui
+```
+
+## Usage
+
+### Demo Mode (Default)
+```bash
+# Start all services with pre-built images
+./scripts/deploy.sh start
+
+# Start specific services
+./scripts/deploy.sh start gui queueserver
+
+# Start demo services (bluesky-services, gui, queueserver, sim, viewer)
+./scripts/deploy.sh demo
+```
+
+### Development Mode
+```bash
+# Build images locally first
+podman-compose -f docker-compose.build.yml build
+
+# Start specific services in development mode
+./scripts/deploy.sh start --dev gui
+
+# Mix normal and development mode
+./scripts/deploy.sh start queueserver --dev gui
+```
+
+### Stopping Services
+```bash
+# Stop all services
+./scripts/deploy.sh stop
+
+# Stop specific services
+./scripts/deploy.sh stop gui queueserver
+```
+
+## Available Services
+
+- **bluesky-services**: Core infrastructure (Redis, MongoDB, Kafka, ZMQ proxies)
+- **queueserver**: RE Manager for experiment orchestration
+- **gui**: NBS GUI with display protocol detection (Wayland/X11)
+- **sim**: NBS simulation services
+- **viewer**: Additional viewing services (if configured)
+
+## Development Workflow
+
+### Docker Compose Override System
+
+The deployment system uses Docker Compose's override mechanism to enable flexible configuration:
+
+1. **Base Configuration**: Each service has a main `docker-compose.yml` file with default settings
+2. **Override Files**: `docker-compose.override.yml` files (if present) are automatically composed with the main file
+3. **Development Files**: `docker-compose.development.yml` files are applied when using the `--dev` flag
+
+### Override Files (`docker-compose.override.yml`)
+
+Override files allow local customization without modifying the base configuration:
+- **Testing**: Override environment variables, ports, or volumes for testing
+- **Bug Fixes**: Temporarily modify service parameters to work around issues
+- **GUI Configuration**: Especially useful for display protocol issues (Wayland/X11)
+- **Local Paths**: Mount local directories for configuration or data
+
+Example override file:
+```yaml
+services:
+  qs-gui:
+    volumes:
+      - ${HOME}/local-config:/etc/bluesky
+    environment:
+      - DEBUG=true
+```
+
+### Development Files (`docker-compose.development.yml`)
+
+Development files are applied when using the `--dev` flag and typically:
+- **Switch to Local Images**: Use locally built images instead of GHCR images
+- **Config Mounts**: Mount configuration directories to test config changes
+- **Code Mounts**: Mount local source code directories for live development
+- **Local Installs**: Install packages from local paths with `pip install -e`
+- **Debug Settings**: Enable debugging, logging, or development-specific configurations
+
+Example development file which only mounts local config directories
+```yaml
+services:
+  qs-gui:
+    volumes:
+      - ${NBS_PODS_DIR}/config/bluesky:/etc/bluesky
+      - ${BEAMLINE_PODS_DIR}/config/ipython:/usr/local/share/ipython
+      - ${NBS_PODS_DIR}/config/tiled:/etc/tiled
+```
+
+Example development file which installs local code
+```yaml
+services:
+  nbs-sim:
+    volumes:
+      - ${NBSDIR}:/usr/local/src/xraygui
+      - ${BEAMLINE_PODS_DIR}/config/ipython:/usr/local/share/ipython
+    command: >
+      bash -c "
+        pip3 install --no-deps --no-build-isolation -e /usr/local/src/xraygui/nbs-sim/src &&
+        nbs-sim --startup-dir /usr/local/share/ipython/profile_default/startup --list-pvs
+      "
+```
+### File Resolution Order
+
+The system resolves compose files in this order:
+1. Base service file (e.g., `docker-compose.yml`)
+2. Override file (`docker-compose.override.yml`) - if present
+3. Development file (`docker-compose.development.yml`) - if `--dev` flag used
+
+Later files override earlier ones, allowing for flexible configuration management.
+
+## Configuration
+
+Images include default configurations in `/etc/bluesky` and `/etc/tiled/profiles` which can be overridden with volume mounts in development mode. 

nbs_pods-0.2.2/docker-compose.build.yml

@@ -0,0 +1,48 @@
+version: '3'
+
+services:
+  bluesky:
+    build:
+      context: .
+      dockerfile: images/bluesky/Containerfile
+    image: bluesky:latest
+
+  queueserver:
+    build:
+      context: .
+      dockerfile: images/queueserver/Containerfile
+      args:
+        BASE_IMAGE: bluesky:latest
+    image: queueserver:latest
+    depends_on:
+      - bluesky
+
+  gui:
+    build:
+      context: .
+      dockerfile: images/gui/Containerfile
+      args:
+        BASE_IMAGE: bluesky:latest
+    image: gui:latest
+    depends_on:
+      - bluesky
+
+  viewer:
+    build:
+      context: .
+      dockerfile: images/viewer/Containerfile
+      args:
+        BASE_IMAGE: bluesky:latest
+    image: viewer:latest
+    depends_on:
+      - bluesky
+
+  sim:
+    build:
+      context: .
+      dockerfile: images/sim/Containerfile
+      args:
+        BASE_IMAGE: bluesky:latest
+    image: sim:latest
+    depends_on:
+      - bluesky

nbs_pods-0.2.2/images/bluesky/Containerfile

@@ -0,0 +1,16 @@
+FROM ghcr.io/prefix-dev/pixi:latest
+
+RUN apt-get update && apt-get install -y git
+
+RUN mkdir -p /etc/tiled/profiles
+RUN mkdir -p /etc/bluesky
+RUN mkdir -p /etc/pixi
+RUN mkdir -p /opt/pixi/envs
+
+# Copy default configurations
+COPY src/nbs_pods/config/tiled/profiles/ /etc/tiled/profiles/
+COPY src/nbs_pods/config/bluesky/ /etc/bluesky/
+COPY src/nbs_pods/config/ipython/ /usr/local/share/ipython/
+COPY src/nbs_pods/config/pixi/ /etc/pixi/
+
+WORKDIR /usr/local/share/ipython/profile_default

nbs_pods-0.2.2/images/gui/Containerfile

@@ -0,0 +1,6 @@
+ARG BASE_IMAGE=bluesky
+FROM ${BASE_IMAGE}
+
+RUN pixi install -e gui && rm -rf ~/.cache/rattler
+
+CMD ["pixi", "run", "gui"]

nbs_pods-0.2.2/images/nbs/Containerfile

@@ -0,0 +1,4 @@
+ARG BASE_IMAGE=bluesky
+FROM ${BASE_IMAGE}
+
+RUN pixi install -e terminal && rm -rf ~/.cache/rattler

nbs_pods-0.2.2/images/queueserver/Containerfile

@@ -0,0 +1,6 @@
+ARG BASE_IMAGE=bluesky
+FROM ${BASE_IMAGE}
+
+RUN pixi install -e qs && rm -rf ~/.cache/rattler
+
+CMD ["pixi", "run", "qs"]

nbs_pods-0.2.2/images/sim/Containerfile

@@ -0,0 +1,6 @@
+ARG BASE_IMAGE=bluesky
+FROM ${BASE_IMAGE}
+
+RUN pixi install -e sim && rm -rf ~/.cache/rattler
+
+CMD ["pixi", "run", "sim"]

nbs_pods-0.2.2/images/viewer/Containerfile

@@ -0,0 +1,6 @@
+ARG BASE_IMAGE=bluesky
+FROM ${BASE_IMAGE}
+
+RUN pixi install -e viewer && rm -rf ~/.cache/rattler
+
+CMD ["pixi", "run", "viewer"]