fftvis 0.0.1__tar.gz

fftvis-0.0.1/.coveragerc

@@ -0,0 +1,6 @@
+[run]
+include = fftvis/*
+branch = True
+
+[report]
+omit = */tests/*

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

@@ -0,0 +1,54 @@
+name: Run Tests
+
+on:
+  pull_request:
+    branches: [ main ]
+  push:
+    branches: [ main ]
+
+jobs:
+  tests:
+    env:
+      ENV_NAME: tests
+      PYTHON: ${{ matrix.python-version }}
+      OS: ${{ matrix.os }}
+      LOG_LEVEL: ${{ (matrix.os == 'macos-latest' && 'WARNING') || 'INFO' }} # Suppress logging on macOS
+
+    name: Tests
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.9, "3.10", "3.11", "3.12"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@main
+        with:
+          fetch-depth: 1
+      - uses: mpi4py/setup-mpi@v1
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: |
+          pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Run Tests
+        run: |
+          python -m pytest --cov=fftvis --cov-config=./.coveragerc --cov-report xml:./coverage.xml --durations=15
+
+      - name: Upload coverage report
+        if: matrix.os == 'ubuntu-latest' && success()
+        uses: codecov/codecov-action@v3.1.3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: true

fftvis-0.0.1/.gitignore

@@ -0,0 +1,161 @@
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+.vscode

fftvis-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tyler Cox
+
+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.

fftvis-0.0.1/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.1
+Name: fftvis
+Version: 0.0.1
+Summary: A package for simulating visibilities using FFTs
+Home-page: https://github.com/tyler-a-cox/fftvis
+Author: Tyler Cox
+Author-email: tyler.a.cox@berkeley.edu
+License: MIT
+Platform: any
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: matvis
+Requires-Dist: finufft
+Requires-Dist: pyuvdata
+Provides-Extra: dev
+Requires-Dist: mpi4py; extra == "dev"
+Requires-Dist: pyuvsim[sim]; extra == "dev"
+Requires-Dist: pyradiosky; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: hera_sim; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+
+# fftvis: A Non-Uniform Fast Fourier Transform-based Visibility Simulator
+
+![Tests](https://github.com/tyler-a-cox/fftvis/actions/workflows/ci.yml/badge.svg)
+![codecov](https://codecov.io/gh/tyler-a-cox/fftvis/branch/main/graph/badge.svg)
+![Black Formatting](https://img.shields.io/badge/code%20style-black-000000.svg)
+
+`fftvis` is a fast Python package designed for simulating interferometric visibilities using the Non-Uniform Fast Fourier Transform (NUFFT). It provides a convenient and efficient way to generate simulated visibilities.
+
+## Features
+
+- Utilizes the Flatiron Institute NUFFT (finufft) [algorithm](https://arxiv.org/abs/1808.06736) for fast visibility simulations that agree with similar methods ([`matvis`](https://github.com/HERA-team/matvis)) to nearly machine precision.
+- Designed to be a near drop-in replacement to `matvis` with a ~10x improvement in runtime
+
+## Limitations
+- Currently no support for per-antenna beams
+- Currently no support for polarized sky emission 
+- Currently no GPU support
+- Diffuse sky models must be pixelized
+
+## Installation
+
+You can install `fftvis` via pip:
+
+```bash
+git clone https://github.com/tyler-a-cox/fftvis
+cd fftvis
+pip install .
+```
+
+## Contributing
+Contributions to `fftvis` are welcome! If you find any issues, have feature requests, or want to contribute improvements, please open an issue or submit a pull request on the GitHub repository: `fftvis` on GitHub
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgments
+This package relies on the `finufft` implementation provided by [finufft](https://github.com/flatironinstitute/finufft) library. Special thanks to the contributors and maintainers of open-source libraries used in this project.

fftvis-0.0.1/README.md

@@ -0,0 +1,38 @@
+# fftvis: A Non-Uniform Fast Fourier Transform-based Visibility Simulator
+
+![Tests](https://github.com/tyler-a-cox/fftvis/actions/workflows/ci.yml/badge.svg)
+![codecov](https://codecov.io/gh/tyler-a-cox/fftvis/branch/main/graph/badge.svg)
+![Black Formatting](https://img.shields.io/badge/code%20style-black-000000.svg)
+
+`fftvis` is a fast Python package designed for simulating interferometric visibilities using the Non-Uniform Fast Fourier Transform (NUFFT). It provides a convenient and efficient way to generate simulated visibilities.
+
+## Features
+
+- Utilizes the Flatiron Institute NUFFT (finufft) [algorithm](https://arxiv.org/abs/1808.06736) for fast visibility simulations that agree with similar methods ([`matvis`](https://github.com/HERA-team/matvis)) to nearly machine precision.
+- Designed to be a near drop-in replacement to `matvis` with a ~10x improvement in runtime
+
+## Limitations
+- Currently no support for per-antenna beams
+- Currently no support for polarized sky emission 
+- Currently no GPU support
+- Diffuse sky models must be pixelized
+
+## Installation
+
+You can install `fftvis` via pip:
+
+```bash
+git clone https://github.com/tyler-a-cox/fftvis
+cd fftvis
+pip install .
+```
+
+## Contributing
+Contributions to `fftvis` are welcome! If you find any issues, have feature requests, or want to contribute improvements, please open an issue or submit a pull request on the GitHub repository: `fftvis` on GitHub
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgments
+This package relies on the `finufft` implementation provided by [finufft](https://github.com/flatironinstitute/finufft) library. Special thanks to the contributors and maintainers of open-source libraries used in this project.

fftvis-0.0.1/ci/fftvis_tests.yml

@@ -0,0 +1,23 @@
+name: tests
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - pip
+  - astropy
+  - numpy
+  - pytest
+  - scipy
+  - pyyaml
+  - pycodestyle
+  - psutil
+  - astropy-healpix
+  - future
+  - pytest-cov
+  - finufft
+  - matvis
+  - mpi4py
+  - pyuvdata
+  - pip:
+    - pyuvsim[sim]
+    - pyradiosky

fftvis-0.0.1/fftvis/__init__.py

@@ -0,0 +1 @@
+from . import beams, utils, simulate

fftvis-0.0.1/fftvis/beams.py

@@ -0,0 +1,75 @@
+import numpy as np
+from pyuvdata import UVBeam
+
+
+def _evaluate_beam(
+    A_s: np.ndarray,
+    beam: UVBeam,
+    az: np.ndarray,
+    za: np.ndarray,
+    polarized: bool,
+    freq: float,
+    check: bool = False,
+    spline_opts: dict = None,
+):
+    """Evaluate the beam on the CPU. Simplified version of the `_evaluate_beam_cpu` function
+    in matvis.
+
+    This function will either interpolate the beam to the given coordinates tx, ty,
+    or evaluate the beam there if it is an analytic beam.
+
+    Parameters
+    ----------
+    A_s
+        Array of shape (nax, nfeed, nsrcs_up) that will be filled with beam
+        values.
+    beam
+        UVBeam object to evaluate.
+    tx, ty
+        Coordinates to evaluate the beam at, in sin-projection.
+    polarized
+        Whether to use beam polarization.
+    freq
+        Frequency to interpolate beam to.
+    check
+        Whether to check that the beam has no inf/nan values. Set to False if you are
+        sure that the beam is valid, as it will be faster.
+    spline_opts
+        Extra options to pass to the RectBivariateSpline class when interpolating.
+    """
+    # Primary beam pattern using direct interpolation of UVBeam object
+    kw = (
+        {
+            "reuse_spline": True,
+            "check_azza_domain": False,
+            "spline_opts": spline_opts,
+        }
+        if isinstance(beam, UVBeam)
+        else {}
+    )
+    if isinstance(beam, UVBeam) and not beam.future_array_shapes:
+        beam.use_future_array_shapes()
+
+    interp_beam = beam.interp(
+        az_array=az,
+        za_array=za,
+        freq_array=np.atleast_1d(freq),
+        **kw,
+    )[0]
+
+    if polarized:
+        interp_beam = interp_beam[:, :, 0, :]
+    else:
+        # Here we have already asserted that the beam is a power beam and
+        # has only one polarization, so we just evaluate that one.
+        interp_beam = np.sqrt(interp_beam[0, 0, 0, :])
+
+    A_s[:, :] = interp_beam
+
+    # Check for invalid beam values
+    if check:
+        sm = np.sum(A_s)
+        if np.isinf(sm) or np.isnan(sm):
+            raise ValueError("Beam interpolation resulted in an invalid value")
+
+    return A_s