xnft 0.1.0rc4__tar.gz

xnft-0.1.0rc4/.gitignore

@@ -0,0 +1,237 @@
+*~lock~
+*/figures/*
+
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+
+# Sphinx
+docs/build
+
+# macOS
+.DS_Store
+
+# == Python ===
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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/
+report.xml
+
+# 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/
+# Generated api docs
+docs/source/api/
+
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+code-quality-report.json
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Conda
+*.conda

xnft-0.1.0rc4/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2026 LEmmA, Electromagnetics Research Group, Michigan State University.
+
+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.

xnft-0.1.0rc4/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.5
+Name: xnft
+Version: 0.1.0rc4
+Summary: Antenna measurement and analysis software.
+Project-URL: Homepage, https://gitlab.msu.edu/ece-lemma/near-field
+Project-URL: Issues, https://gitlab.msu.edu/ece-lemma/near-field/-/issues
+Author: LEmmA Group, Michigan State University
+Author-email: Jason Merlo <merlojas@msu.edu>, Mauro Ettorre <ettorre@msu.edu>
+Maintainer-email: Jason Merlo <merlojas@msu.edu>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: <3.15,>=3.12
+Requires-Dist: colorcet<4,>=3.2.1
+Requires-Dist: dill<0.5,>=0.4.1
+Requires-Dist: finufft<3,>=2.5.1
+Requires-Dist: h5py<4,>=3.16.0
+Requires-Dist: netcdf4<2,>=1.7.4
+Requires-Dist: numba<0.69,>=0.68.0
+Requires-Dist: numpy<3,>=2.5.4
+Requires-Dist: pandas<4,>=3.0.6
+Requires-Dist: pyqtgraph<0.15,>=0.14.0
+Requires-Dist: pyside6<7,>=6.11.2
+Requires-Dist: pyyaml<7,>=6.0.3
+Requires-Dist: quantiphy<3,>=2.23
+Requires-Dist: scipy<2,>=1.18.1
+Requires-Dist: unyt<4,>=3.1.0
+Requires-Dist: xarray<2027,>=2026.9.0
+Description-Content-Type: text/markdown
+
+# _xNFT_: An Open Near-Field Antenna Measurement Software Suite
+
+<table>
+  <tr>
+    <td><a><img src="docs/images/xnft_logo.png" alt="xNFT Logo" ></a></td>
+    <td><a href="https://sites.google.com/site/mauroettorre/home"><img src="docs/images/lemma_logo_v2_green.png" alt="LEmmA Group Logo" ></a></td>
+    <td><a href="https://www.egr.msu.edu/emrg/"><img src="docs/images/emrg_logo.png" alt="Electromagnetics Research Group Wordmark"></a></td>
+  </tr>
+</table>
+
+| | |
+| ------ | ------ |
+| Testing | [![Pipeline Status](https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft/badges/main/pipeline.svg?ignore_skipped=true&job=test-job)](../../pipelines) ![Test Coverage](https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft/badges/main/coverage.svg) |
+| Package | [![Latest Release](/../../badges/release.svg)](/../../releases) ![python: 3.12 , 3.13 , 3.14](https://img.shields.io/badge/python-3.12\|3.13\|3.14-orange) ![status: beta](https://img.shields.io/badge/status-beta-blue) |
+| Meta | [![License: MIT](https://img.shields.io/badge/License-MIT-green)](LICENSE) |
+
+> [!WARNING] 
+> ⚠️ **_xNFT_ is in active development (Beta).**
+> User interfaces and APIs may continue to change.
+
+> [!NOTE]
+> The primary source for xNFT is the **[MSU GitLab repository](https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft)**.
+> 
+> Community contributions are welcomed via the **[GitHub Mirror](https://github.com/msu-lemma/xnft)**. Issues and pull requests may be submitted to this location for discussion.
+
+## What is _xNFT_?
+
+**_xNFT_** is a cross-platform, high-performance, general purpose antenna measurement and analysis software tool, primarily focusing on **near-to-far field transformations (NFTs)**, permissively distributed under the **MIT license**.  
+
+Check out our **[Video Demo](https://youtu.be/SiD9lgWeYf4?t=24)** to see some of _xNFT_'s features in action!
+
+![xnft Screenshot](docs/images/xnft_screenshot.png)
+> Screenshot of _xNFT_ running on macOS.  Measurements show an NSI-MI ANT-SGH-26.5-40 standard gain horn at 26.5 GHz collected using the LEmmA planar near-field scanner.
+
+## Table of Contents
+
+1. [Highlights](#highlights)
+2. [System Requirements](#system-requirements)
+3. [Installation](#installation)
+4. [Documentation](#documentation)
+5. [Known Issues](#known-issues)
+6. [Contributing](#contributing)
+7. [Citing _xNFT_](#citing-xnft)
+8. [License](#license)
+9. [Acknowledgements](#acknowledgements)
+
+## Highlights
+
+Some of the main features currently available in _xNFT_ are:
+
+- **Planar near-to-far field transforms (PNFT).** _xNFT_ uses the [FINUFFT](https://finufft.readthedocs.io/en/latest/) library to compute the PNFT, enabling fast and accurate transforms from uniform and nonuniform* sampled source grids directly into uniformly sampled spherical coordinates.  
+- **Probe Compensation.** Ideal open-ended waveguide measurement probe correction options are built into _xNFT_.
+- **Gain Calibration.** Gain calibration may be performed using the gain transfer method via a calibrated measurement antenna and gain reference table in `.csv` or `.ngt` format.
+- **Graphical user interface (GUI).** _xNFT_ provides a rich GUI (via [Qt/PySide6](https://doc.qt.io/qtforpython-6/)) designed to look like common professional engineering tools with interactive plotting (via [PyQtGraph](https://www.pyqtgraph.org)) and analysis tools.
+- **Data exporting.** Exporting options are availble in `.h5` and `.csv` formats for imported fields (data conversion) and processed report results.  Images may be exported using the underlying PyQtGraph framework (via right-click menu).
+- **Plugin framework.** _xNFT_ has an extensible plugin framework allowing users to create custom data loaders in separate python packages allowing users to separate internal tools from the general _xNFT_ framework. For more information see the [_xNFT_ Plugin Example repository](https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft-example).
+
+*Nonuniform source sampling has not yet been validated.
+
+### In Progress
+
+- Spherical near-to-far field transform (SNFT)
+- Expanded plugin package capabilities. E.g., custom _Analysis_ options and _Report_ options.
+
+## System Requirements
+
+_xNFT_ is designed to run on a wide range of operating systems and architectures.  A list of system configurations designed to be compatible is included below. Other configurations may work, but are not currently considered supported configurations.
+
+### _xNFT_ Design System Compatability Matrix
+
+| Operating System | Versions          | Architectures    |
+| ---------------- | ----------------- | ---------------- |
+| macOS            | >= 15.0 (Sequoia) | x86-64, arm-64   |
+| Linux            | ——                | x86-64, aarch64  |
+| Windows          | 10, 11            | x86-64, arm-64*  |
+
+*Emulated x86 via [Prism](https://learn.microsoft.com/en-us/windows/arm/apps-on-arm-x86-emulation)
+
+### Validated Configurations
+
+<details>
+<summary>(Click to view table)</summary>
+
+| Operating System | Versions          | Architecture               |
+| ---------------- | ----------------- | -------------------------- |
+| macOS            | 26 (Tahoe)        | arm-64                     |
+|                  | 27 (Golden Gate)  | arm-64                     |
+| Linux            | Alma 8.10, Alma 9.6, Alma 9.8    | x86-64                     |
+|                  | Ubuntu 26.04             | aarch64                    |
+| Windows          | 11                | x86-64                     |
+|                  | 11                | arm-64 (via [Prism](https://learn.microsoft.com/en-us/windows/arm/apps-on-arm-x86-emulation)) |
+| Windows (WSL2)   | 11 (Ubuntu 24.04) | x86-64                     |
+
+</details>
+
+## Installation
+
+To install _xNFT_ and download test data, see **[Installing _xNFT_](docs/installing.md)**.
+
+## Documentation
+
+Documentation can be found in the **[docs folder](docs)**.
+
+- **[Installation](docs/installing.md):** Instructions for installing and packaging _xNFT_, and downloading test data.
+- **[Getting Started](docs/getting_started.md)**: A quick-start guide including a written tutorial and usage video.
+- **[User Guide](docs/user_guide.md)**: Documentation of user interface and antenna analysis workflow.
+
+### Developer Documentation
+
+There is a minimal API documentation generated by Sphinx from the docstrings.  This is built by the CI task available at:
+
+- [**PDF Documentation**](https://gitlab.msu.edu/api/v4/projects/28094/jobs/artifacts/main/raw/docs/api/build/xnft-docs.pdf?job=docs-build)
+- [**HTML Documentation**](https://gitlab.msu.edu/api/v4/projects/28094/jobs/artifacts/main/raw/docs/api/build/xnft-docs.tar.gz?job=docs-build)
+
+<details>
+<summary>
+<h4>Local API Documentation Generation</h4> (Click to view)
+</summary>
+
+To build all docs locally (PDF and HTML), run:
+
+```shell
+pixi run -e docs build-docs
+```
+
+Just the HTML docs or just the PDF docs may be built by running
+
+```shell
+pixi run -e docs build-html-docs
+```
+
+or
+
+```shell
+pixi run -e docs build-pdf-docs
+```
+
+</details>
+
+## Known Issues
+
+A summary of the high-impact issues are included in the [Work Items](https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft/-/work_items/views/43).
+
+## Contributing
+
+Community contributions in the form of bug reports, feature requests, and pull requests are welcome!
+
+If you find a bug or would like to request a feature, please first check if a similar issue already exists in [Work Items](https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft/-/work_items) or the [GitHub Issues](https://github.com/msu-lemma/xnft/issues).  If not, please [open an issue on the GitHub project](https://github.com/msu-lemma/xnft/issues).
+
+Please refer to [CONTRIBUTING](CONTRIBUTING.md) for further guidance.
+
+## Citing _xNFT_
+
+If you use _xNFT_ in your work, please consider citing it. Citation metadata is available in the **[CFF reference file](CITATION.cff)**.
+
+- **When citing the use of the software package**, please specify the version used for reproduceability.  The preferred format is:
+
+  > J. M. Merlo and M. Ettorre. *xNFT - Antenna measurement software.* (v#.#.#). Michigan State University. [Online]. Available: https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft
+
+  <details>
+  <summary>BibTex Format (click to view)</summary>
+
+  🚧 TODO 🚧
+
+  ```text
+  @software{xnft,
+    author={Merlo, Jason M. and Ettorre, Mauro},
+    title={{xNFT} - {A}ntenna measurement software},
+    month={November},
+    year={2026},
+    version={v0.1.0}, 
+    keywords={Antenna measurements, near-field measurement, near-field transform, open-source software, probe compensation},
+    doi={},
+    publisher={Michigan State University},
+    url={https://www.gitlab.msu.edu/ece-lemma/public/xnft/xnft}}
+  ```
+
+  </details>
+
+  Please replace "(v#.#.#)" with the version of the software you used, e.g. "(v0.1.0)".
+
+- **When citing the software package implementation**, please cite our AMTA conference paper. The preferred format is:
+
+  > J. M. Merlo and M. Ettorre., "xNFT: An open near-field antenna measurement software suite," 2026 Antenna Measurement Techniques Association Symposium (AMTA), Austin, TX, USA, 2026.
+
+  <details>
+  <summary>BibTex Format (click to view)</summary>
+
+  ```text
+  @inproceedings{xnft2026amta,
+    author={Merlo, Jason M. and Ettorre, Mauro},
+    booktitle={2026 Antenna Measurement Techniques Association Symposium (AMTA)}, 
+    title={xNFT: An Open Near-Field Antenna Measurement Software Suite}, 
+    year={2026},
+    pages={1-6},
+    keywords={Antenna measurements, near-field measurement, near-field transform, open-source software, probe compensation},
+    doi={}}
+  ```
+
+  </details>
+
+## License
+
+Copyright ©️ 2026 Michigan State University. All rights reserved.
+
+The original source code for this project is distributed under the [MIT license](LICENSE).
+
+This project depends on third-party libraries which are distributed separately and remain subject to their respective licenses.  For a complete list of runtime dependencies, see the `workspace.dependencies` section of the [`pixi.toml`](pixi.toml#L13) file.
+
+## Acknowledgements
+
+This work was sponsored by the Air Force Research Laboratory (AFRL) under grant number FA87502510001. The views expressed are those of the authors and do not reflect the official policy or position of the Department of Defense or the U.S. Government.