xwr 0.3.2__tar.gz

xwr-0.3.2/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Run CI
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v5
+
+    - name: Install uv with Python 3.12
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: "3.12"
+
+    - name: Lint with ruff
+      run: |
+        uv run --extra dev --extra torch --extra nn --extra jax ruff check ./src
+
+    - name: Type check with pyright
+      run: |
+        uv run --extra dev --extra torch --extra nn --extra jax pyright ./src
+
+    - name: Run tests
+      run: |
+        uv run --extra dev --extra torch --extra nn --extra jax pytest -ra -- tests

xwr-0.3.2/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v5
+
+      # Install uv (fast Python package/dependency manager)
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Sync docs environment
+        run: uv sync --extra docs
+
+      - name: Build MkDocs site
+        run: uv run mkdocs build --strict
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

xwr-0.3.2/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

xwr-0.3.2/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff
+        name: Lint with ruff
+        entry: uv run --extra dev --extra torch --extra jax --extra nn ruff check
+        language: system
+        types: [python]
+
+      - id: pyright
+        name: Type check with pyright
+        entry: uv run --extra dev --extra torch --extra jax --extra nn pyright
+        language: system
+        types: [python]
+
+      - id: pytest
+        name: Run pytest with coverage
+        entry: uv run --extra dev --extra torch --extra jax --extra nn pytest -- tests
+        language: system
+        pass_filenames: false

xwr-0.3.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 WiSELab-CMU
+
+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.

xwr-0.3.2/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: xwr
+Version: 0.3.2
+Summary: Linux-Compatible Real-Time Raw Data Capture for TI mmWave Radars.
+Project-URL: Homepage, https://github.com/RadarML/xwr
+Project-URL: Documentation, https://radarml.github.io/xwr
+Project-URL: Issues, https://github.com/RadarML/xwr/issues
+Author-email: Tianshu Huang <tianshu2@andrew.cmu.edu>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: beartype>=0.20
+Requires-Dist: jaxtyping>=0.3.2
+Requires-Dist: numpy>=1.19
+Requires-Dist: pyfftw>=0.15.0
+Requires-Dist: pyserial>=3.5
+Requires-Dist: types-pyserial>=3.5
+Provides-Extra: demo
+Requires-Dist: matplotlib>=3.0; extra == 'demo'
+Requires-Dist: pyqt6>=6.0.0; extra == 'demo'
+Requires-Dist: pyyaml>=6.0; extra == 'demo'
+Requires-Dist: rich>=13.0.0; extra == 'demo'
+Requires-Dist: tyro>=0.8.0; extra == 'demo'
+Provides-Extra: dev
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: pre-commit>=4.0.0; extra == 'dev'
+Requires-Dist: pyright>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.11.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: abstract-dataloader>=0.3.5; extra == 'docs'
+Requires-Dist: mkdocs-material==9.6.*; extra == 'docs'
+Requires-Dist: mkdocs==1.6.*; extra == 'docs'
+Requires-Dist: mkdocstrings-python-xref==1.16.3; extra == 'docs'
+Requires-Dist: mkdocstrings-python==1.16.6; extra == 'docs'
+Requires-Dist: ruff>=0.11.0; extra == 'docs'
+Provides-Extra: jax
+Requires-Dist: jax>=0.4.0; extra == 'jax'
+Provides-Extra: nn
+Requires-Dist: torchvision>=0.15.0; extra == 'nn'
+Provides-Extra: torch
+Requires-Dist: torch>=2.0; extra == 'torch'
+Description-Content-Type: text/markdown
+
+# `xwr`: Linux-Compatible Real-Time Raw Data Capture for TI mmWave Radars
+
+[![pypi version](https://img.shields.io/pypi/v/xwr.svg)](https://pypi.org/project/xwr/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xwr)
+![PyPI - Types](https://img.shields.io/pypi/types/xwr)
+![License - MIT](https://img.shields.io/badge/license-MIT-green)
+![Typed](https://img.shields.io/badge/types-typed-brightgreen)
+[![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)
+
+`xwr` is a pure-python, linux-based real time raw data capture system for TI mmWave radars, and includes four key components:
+
+- [`xwr`](https://radarml.github.io/xwr/system/): a high-level data capture interface
+- [`xwr.rsp`](https://radarml.github.io/xwr/rsp/rsp/): a radar signal processing library with Numpy, Pytorch, and Jax support
+- [`xwr.radar`](https://radarml.github.io/xwr/radar/api/): a parameterized python interface for the default radar firmware
+- [`xwr.capture`](https://radarml.github.io/xwr/dca/api/): a pure-python, real-time interface for the DCA1000EVM
+
+See our [documentation site](https://radarml.github.io/xwr/) for more details, setup guides, the included demo, and more!
+
+## Requirements
+
+`xwr` assumes a linux-based system and radar hardware which consists of the DCA1000EVM and a supported TI mmWave Radar (XWR) development board.
+
+> [!IMPORTANT] 
+> Supported Devices:
+>    - AWR1843 Family: AWR1843Boost, AWR1843AOPEVM
+>    - AWR1642
+>
+> WIP:
+>    - AWR2544LOPEVM
+
+## Install
+
+The `xwr` library is currently only distributed via github:
+
+```sh
+# Install directly from github
+pip install git+ssh://github.com/RadarML/xwr.git
+```

xwr-0.3.2/README.md

@@ -0,0 +1,38 @@
+# `xwr`: Linux-Compatible Real-Time Raw Data Capture for TI mmWave Radars
+
+[![pypi version](https://img.shields.io/pypi/v/xwr.svg)](https://pypi.org/project/xwr/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xwr)
+![PyPI - Types](https://img.shields.io/pypi/types/xwr)
+![License - MIT](https://img.shields.io/badge/license-MIT-green)
+![Typed](https://img.shields.io/badge/types-typed-brightgreen)
+[![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)
+
+`xwr` is a pure-python, linux-based real time raw data capture system for TI mmWave radars, and includes four key components:
+
+- [`xwr`](https://radarml.github.io/xwr/system/): a high-level data capture interface
+- [`xwr.rsp`](https://radarml.github.io/xwr/rsp/rsp/): a radar signal processing library with Numpy, Pytorch, and Jax support
+- [`xwr.radar`](https://radarml.github.io/xwr/radar/api/): a parameterized python interface for the default radar firmware
+- [`xwr.capture`](https://radarml.github.io/xwr/dca/api/): a pure-python, real-time interface for the DCA1000EVM
+
+See our [documentation site](https://radarml.github.io/xwr/) for more details, setup guides, the included demo, and more!
+
+## Requirements
+
+`xwr` assumes a linux-based system and radar hardware which consists of the DCA1000EVM and a supported TI mmWave Radar (XWR) development board.
+
+> [!IMPORTANT] 
+> Supported Devices:
+>    - AWR1843 Family: AWR1843Boost, AWR1843AOPEVM
+>    - AWR1642
+>
+> WIP:
+>    - AWR2544LOPEVM
+
+## Install
+
+The `xwr` library is currently only distributed via github:
+
+```sh
+# Install directly from github
+pip install git+ssh://github.com/RadarML/xwr.git
+```

xwr-0.3.2/demo/config.yaml

@@ -0,0 +1,19 @@
+# This can be passed to `AWRSystem` by simply unpacking:
+# system = AWRSystem(**config)
+radar:  # -> AWRConfig
+  port: null  # auto-detect
+  frequency: 77.0
+  idle_time: 200.0
+  adc_start_time: 5.7
+  ramp_end_time: 59.00
+  tx_start_time: 1.0
+  freq_slope: 67.012
+  adc_samples: 128
+  sample_rate: 2500
+  frame_length: 128
+  frame_period: 125.0
+capture:  # -> DCAConfig
+  sys_ip: 192.168.33.30
+  fpga_ip: 192.168.33.180
+  data_port: 4098
+  config_port: 4096

xwr-0.3.2/demo/demo.py

@@ -0,0 +1,94 @@
+"""Simple range-doppler and range-azimuth visualization demo."""
+
+import logging
+import os
+
+import numpy as np
+import tyro
+import yaml
+from matplotlib import pyplot as plt
+from rich.logging import RichHandler
+
+import xwr
+from xwr.rsp import numpy as xwr_rsp
+
+
+def cli_main(
+    config: str | None = None,
+    rsp: str = "AWR1843Boost",
+    device: str | None = None,
+    verbose: int = 20,
+):
+    """Range-doppler visualization demo.
+
+    Using the default configuration, you will need to set the `device` field
+    and `rsp` field to match your radar. For example:
+
+    - AWR1843Boost: --device AWR1843 --rsp AWR1843Boost
+    - AWR1843AOPEVM: --device AWR1843 --rsp AWR1843AOP
+    - AWR1642Boost: --device AWR1642 --rsp AWR1642Boost
+
+    Args:
+        config: path to configuration file. If not provided, defaults to the
+            included `config.yaml`.
+        rsp: radar signal processing class to use; is responsible for handling
+            the virtual antenna array for angular spectrum computation.
+        device: optional device name; if provided, overrides (or sets) the
+            radar `device` field in the configuration file.
+        verbose: logging verbosity level (10-debug; 20-info; 30-warning;
+            40-error).
+    """
+    logging.basicConfig(
+        level=verbose, format="%(name)-12s  %(message)s", datefmt="[%H:%M:%S]",
+        handlers=[RichHandler()])
+    log = logging.getLogger("XWRDemo")
+
+    if config is None:
+        config = os.path.join(os.path.dirname(__file__), "config.yaml")
+
+    with open(config) as f:
+        cfg = yaml.safe_load(f)
+    if device is not None:
+        cfg["radar"]["device"] = device
+
+    # Create a figure
+    plt.ion()  # Enable interactive mode
+    fig, axs = plt.subplots(1, 2)
+
+    im1 = axs[0].imshow(
+        np.zeros((128, 128), dtype=np.float32),
+        cmap="viridis", aspect='auto', origin='lower')
+    im2 = axs[1].imshow(
+        np.zeros((128, 128), dtype=np.float32),
+        cmap="viridis", aspect='auto', origin='lower')
+
+    axs[0].set_xlabel("Doppler")
+    axs[0].set_ylabel("Range")
+    axs[1].set_xlabel("Azimuth")
+    axs[1].set_ylabel("Range")
+    fig.tight_layout()
+
+    awr = xwr.XWRSystem(**cfg)
+    rsp_inst = getattr(xwr_rsp, rsp)(window=False, size={"azimuth": 128})
+
+    try:
+        for frame in awr.dstream(numpy=True):
+            # batch doppler elevation azimuth range
+            dear = np.abs(rsp_inst(frame[None, ...]))
+            rd = np.swapaxes(np.mean(dear, axis=(0, 2, 3)), 0, 1)
+            ra = np.swapaxes(np.mean(dear, axis=(0, 1, 2)), 0, 1)
+
+            im1.set_data(rd)
+            im1.set_clim(vmin=np.min(rd), vmax=np.max(rd))
+            im2.set_data(ra)
+            im2.set_clim(vmin=np.min(ra), vmax=np.max(ra))
+
+            # Needed to update the figure
+            plt.pause(0.001)
+
+    except KeyboardInterrupt:
+        log.warning("Demo interrupted by user.")
+        awr.stop()
+
+if __name__ == "__main__":
+    tyro.cli(cli_main)

xwr-0.3.2/docs/dca/api.md

@@ -0,0 +1 @@
+::: xwr.capture

xwr-0.3.2/docs/dca/defines.md

@@ -0,0 +1 @@
+::: xwr.capture.defines

xwr-0.3.2/docs/dca/types.md

@@ -0,0 +1 @@
+::: xwr.capture.types

xwr-0.3.2/docs/develop.md

@@ -0,0 +1,70 @@
+# Development Environment
+
+!!! info "`xwr` uses `uv`"
+
+    While `pyproject.toml` reflects known limitations on dependency versions, we use `uv` to manage a lock file used for development.
+
+    On a fresh linux install, you will need to [install `uv`](https://docs.astral.sh/uv/getting-started/installation/):
+    ```sh
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+    source ~/.bashrc
+    ```
+
+## Setup
+
+Set up fresh development machine:
+```sh
+sudo apt-get install -y openssh-server git curl
+curl -LsSf https://astral.sh/uv/install.sh | sh
+source ~/.bashrc
+
+ssh-keygen
+# (add ssh key or add deploy key to xwr)
+git clone git@github.com:WiseLabCMU/xwr.git
+```
+
+Set up development environment:
+```sh
+uv sync --all-extras --frozen
+uv run pre-commit install
+```
+
+!!! warning
+
+    This will install all backends (numpy, pytorch, and jax), which is necessary for static type checking and backend-specific tests. If you are only working on the interface, you can skip `--all-extras`.
+
+## Tests
+
+Run tests:
+```sh
+uv run --all-extras pytest -ra --cov --cov-report=html --cov-report=term -- tests
+```
+
+!!! tip
+
+    HTML-format code coverage is saved to `./htmlcov`; view these with `cd htmlcov; python -m http.server 8001`.
+
+Run tests (including data capture):
+```sh
+export XWR_DEVICE=AWR1843
+uv run --all-extras pytest -ra --cov --cov-report=html --cov-report=term -- tests
+```
+
+- A radar and capture card should be configured and connected to the test computer.
+- Set `XWR_DEVICE` to the name of the radar (i.e., a class name in [`xwr.radar`][xwr.radar]).
+- If `XWR_DEVICE` is not set, all capture-related tests will be skipped.
+
+!!! info
+    
+    The tests are also run by our [pre-commit](https://pre-commit.com/) hooks, which you can manually trigger with `uv run pre-commit run`; these hooks (`ruff + pyright + pytest`) mirror the CI.
+
+## Docs
+
+Build docs for development:
+```sh
+uv run --extra docs mkdocs serve
+```
+
+!!! info
+
+    The [documentation site](https://radarml.github.io/xwr) is automatically built and deployed via GitHub Actions when a PR is merged.