mimodium 0.0.1__tar.gz

mimodium-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,120 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  MPLBACKEND: Agg
+
+jobs:
+  quality:
+    name: Code quality
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install package and development dependencies
+        run: python -m pip install -e ".[dev]"
+
+      - name: Check formatting
+        run: ruff format --check src tests docs
+
+      - name: Lint
+        run: ruff check src tests docs
+
+  tests:
+    name: Tests (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package and test dependencies
+        run: python -m pip install -e ".[test]"
+
+      - name: Run tests
+        run: pytest
+
+  documentation:
+    name: Documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install package and documentation dependencies
+        run: python -m pip install -e ".[docs]"
+
+      - name: Build documentation strictly
+        run: sphinx-build -E -W --keep-going -b html docs docs/_build/html
+
+  distribution:
+    name: Distribution
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install build tools
+        run: python -m pip install build twine
+
+      - name: Build wheel and source distribution
+        run: python -m build
+
+      - name: Check distribution metadata
+        run: python -m twine check dist/*
+
+      - name: Smoke-test built wheel
+        run: |
+          python -m venv wheel-test-env
+          wheel-test-env/bin/python -m pip install dist/*.whl
+          wheel-test-env/bin/python -I -c "import mimodium; assert len(mimodium.core_tasks()) > 0"
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: distributions
+          path: dist/
+          if-no-files-found: error

mimodium-0.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,101 @@
+# Upload Mimodium to PyPI when a GitHub release is published.
+
+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@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install release dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Verify release version
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          python - <<'PY'
+          import os
+          from pathlib import Path
+          import tomllib
+
+          project = tomllib.loads(Path("pyproject.toml").read_text())
+          package_version = project["project"]["version"]
+          citation_version = next(
+              line.split(":", 1)[1].strip().strip("'\"")
+              for line in Path("CITATION.cff").read_text().splitlines()
+              if line.startswith("version:")
+          )
+          expected_tag = f"v{package_version}"
+          release_tag = os.environ["RELEASE_TAG"]
+
+          if release_tag != expected_tag or citation_version != package_version:
+              raise SystemExit(
+                  "Release version mismatch: "
+                  f"tag={release_tag!r}, package={package_version!r}, "
+                  f"citation={citation_version!r}"
+              )
+          PY
+
+      - name: Check formatting
+        run: ruff format --check src tests docs
+
+      - name: Lint
+        run: ruff check src tests docs
+
+      - name: Test
+        run: pytest
+
+      - name: Build docs
+        run: sphinx-build -E -W --keep-going -b html docs docs/_build/html
+
+      - name: Build release distributions
+        run: python -m build
+
+      - name: Check release distributions
+        run: python -m twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      contents: read
+      id-token: write
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/mimodium/
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v8
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

mimodium-0.0.1/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/
+*.py[cod]
+
+.pytest_cache/
+.ruff_cache/
+.venv/
+
+dist/
+
+docs/_build/
+docs/tutorials/hello_world/
+
+.vscode/
+
+design/

mimodium-0.0.1/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

mimodium-0.0.1/AGENTS.md

@@ -0,0 +1,11 @@
+# Documentation guidance
+
+- Keep type docstrings as short as possible while remaining expressive.
+- Give task docstrings enough detail to explain not only what the task does and
+  how to use it, but also why it exists. Include examples for complicated
+  algorithms when useful.
+- Use `:type:` links frequently in type documentation. They are generally
+  unnecessary in task documentation because the task's `__call__` method
+  already provides those links.
+- When a task accepts configurable input types, always explain how to use them
+  with `:code:` markup.

mimodium-0.0.1/CITATION.cff

@@ -0,0 +1,24 @@
+cff-version: 1.2.0
+message: >-
+  If you use Mimodium in a research publication, please cite the software
+  version and exact commit. This citation metadata will be updated to prefer
+  the companion paper before the public 0.1 release.
+title: "Mimodium: Cell-Free Massive MIMO Simulation Library"
+authors:
+  - family-names: Schulz
+    given-names: Leonard
+    email: leonard.schulz@tuhh.de
+version: 0.0.1
+license: GPL-3.0-or-later
+repository-code: "https://github.com/LPSchulz/mimodium"
+url: "https://mimodium.readthedocs.io/"
+abstract: >-
+  Mimodium is a Python research library for reproducible cell-free massive MIMO
+  system-level simulations. It provides Dagreon task components for scenario
+  generation, propagation and channel modeling, signal-processing algorithms,
+  evaluation metrics, and visualization.
+keywords:
+  - cell-free massive MIMO
+  - wireless communications
+  - system-level simulation
+  - reproducibility