fiesta-pkg 1.0.2__tar.gz

fiesta_pkg-1.0.2/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: fiesta-pkg
+Version: 1.0.2
+Summary: FIESTA is a python library for general interpolation of field values from uniform and non-uniform input points in 2D and 3D.
+Author-email: Krishna Naidoo <krishna.naidoo.11@ucl.ac.uk>
+Maintainer-email: Krishna Naidoo <krishna.naidoo.11@ucl.ac.uk>
+License: MIT
+Project-URL: Homepage, https://github.com/knaidoo29/FIESTA
+Project-URL: Repository, https://github.com/knaidoo29/FIESTA
+Project-URL: Documentation, https://fiesta-docs.readthedocs.io/en/latest/
+Project-URL: Bug Tracker, https://github.com/knaidoo29/FIESTA/issues
+Project-URL: Changelog, https://github.com/knaidoo29/FIESTA/blob/main/CHANGELOG.md
+Keywords: astronomy,interpolation,mathematics,simulations
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+Requires-Dist: numba
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: shift-fft
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: jupyter; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+
+![biglogo](
+https://raw.githubusercontent.com/knaidoo29/FIESTA/main/docs/source/_static/FiEsta_logo_large_github.jpg)
+
+# FIESTA: Field Interpolation and Estimation using Spatial Techniques and Algorithms
+
+<p align="center">
+    <a href="https://github.com/knaidoo29/FIESTA/actions/workflows/tests.yml">
+    <img src="https://github.com/knaidoo29/FIESTA/actions/workflows/tests.yml/badge.svg" alt="Python Tests">
+    </a>
+    <a href="https://codecov.io/gh/knaidoo29/FIESTA" > 
+    <img src="https://codecov.io/gh/knaidoo29/FIESTA/branch/main/graph/badge.svg?token=RFSEAKTTKG"/> 
+    </a>
+    <a href="https://img.shields.io/badge/Python-3.9%20|%203.10%20|%203.11%20|%203.12-blue">
+    <img src="https://img.shields.io/badge/Python-3.9%20|%203.10%20|%203.11%20|%203.12-blue" alt="Python Version Support">
+    </a>
+    <a href="https://img.shields.io/github/v/release/knaidoo29/FIESTA">  
+    <img src="https://img.shields.io/github/v/release/knaidoo29/FIESTA" alt="Version">
+    </a>
+    <a href="https://pypi.org/project/fiesta-pkg/">
+    <img src="https://img.shields.io/pypi/v/fiesta-pkg.svg" alt="PyPI version">
+    </a>
+    <a href="https://fiesta-docs.readthedocs.io/">
+    <img src="https://readthedocs.org/projects/fiesta-docs/badge/?version=latest" alt="Documentation Status">
+    </a>
+    <a href="https://github.com/knaidoo29/FIESTA">
+    <img src="https://img.shields.io/badge/GitHub-repo-blue?logo=github" alt="GitHub repository">
+    </a>
+    <a href="https://img.shields.io/github/stars/knaidoo29/fiesta">
+    <img src="https://img.shields.io/github/stars/knaidoo29/fiesta" alt="github: stars">
+    </a>
+    <a href="https://img.shields.io/github/stars/knaidoo29/fiesta">
+    <img src="https://img.shields.io/github/forks/knaidoo29/fiesta" alt="github: forks">
+    </a>
+    <a href="https://opensource.org/licenses/MIT">
+    <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT">
+    </a>
+    <a href="https://github.com/psf/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
+    </a>
+    <!-- <a href="https://doi.org/10.5281/zenodo.17093446">
+    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.17093446.svg" alt="zenodo: DOI">
+    </a> -->
+</p>
+
+## Introduction
+
+``FIESTA`` is a python library for general interpolation from uniform and non-uniform input points. The library is written in python with numba acceleration for speed. The library has the *optional* capability to be used on large data-sets by distributing jobs across multiple processes via ``MPI``. This relies on the ``mpi4py`` library and the ``MPI`` object from the ``shift-fft`` package (see [here](https://shift.readthedocs.io/en/latest/mpiutils.html)) which is passed as an additional object into ``MPI`` related functions.
+
+
+## Dependencies
+
+* [numba](https://numba.pydata.org/)
+* [numpy](http://www.numpy.org/)
+* [scipy](http://scipy.org/)
+* [shift-fft](https://shift.readthedocs.io/en/latest/index.html)
+* [mpi4py](https://mpi4py.readthedocs.io/en/stable/) [Optional: enables MPI distributed processes]
+
+## Installation
+
+FIESTA can be installed via ``pip``:
+
+```
+  pip install fiesta-pkg
+```
+
+or by cloning the repository:
+
+```
+    git clone https://github.com/knaidoo29/fiesta.git
+    cd FIESTA
+    pip install .
+```
+
+Once this is done you should be able to call `fiesta` from python:
+
+```
+    import fiesta
+```
+
+To use the ``MPI`` functionality please take a look at the documentation in FIESTA which instructs users how to use the ``shift-fft`` ``MPI`` object and how to run these distributed jobs successfully without errors or MPI related hanging.
+
+## Documentation
+
+In depth documentation and tutorials are provided [here](https://fiesta-docs.readthedocs.io/).
+
+## Citation
+
+If you use **FIESTA** in your work, please cite:
+
+<!-- [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17093446.svg)](https://doi.org/10.5281/zenodo.17093446)
+
+```bibtex
+  @software{naidoo_shift_2025,
+    author       = {Naidoo, Krishna},
+    title        = {SHIFT: a scalable MPI library for computing fast Fourier transforms in python},
+    year         = 2025,
+    publisher    = {Zenodo},
+    doi          = {10.5281/zenodo.17093446},
+    url          = {https://doi.org/10.5281/zenodo.17093446}}
+``` -->
+
+## Support
+
+If you have any issues with the code or want to suggest ways to improve it please open a new issue ([here](https://github.com/knaidoo29/FIESTA/issues)) or (if you don't have a github account) email _krishna.naidoo.11@ucl.ac.uk_.

fiesta_pkg-1.0.2/README.md

@@ -0,0 +1,104 @@
+![biglogo](
+https://raw.githubusercontent.com/knaidoo29/FIESTA/main/docs/source/_static/FiEsta_logo_large_github.jpg)
+
+# FIESTA: Field Interpolation and Estimation using Spatial Techniques and Algorithms
+
+<p align="center">
+    <a href="https://github.com/knaidoo29/FIESTA/actions/workflows/tests.yml">
+    <img src="https://github.com/knaidoo29/FIESTA/actions/workflows/tests.yml/badge.svg" alt="Python Tests">
+    </a>
+    <a href="https://codecov.io/gh/knaidoo29/FIESTA" > 
+    <img src="https://codecov.io/gh/knaidoo29/FIESTA/branch/main/graph/badge.svg?token=RFSEAKTTKG"/> 
+    </a>
+    <a href="https://img.shields.io/badge/Python-3.9%20|%203.10%20|%203.11%20|%203.12-blue">
+    <img src="https://img.shields.io/badge/Python-3.9%20|%203.10%20|%203.11%20|%203.12-blue" alt="Python Version Support">
+    </a>
+    <a href="https://img.shields.io/github/v/release/knaidoo29/FIESTA">  
+    <img src="https://img.shields.io/github/v/release/knaidoo29/FIESTA" alt="Version">
+    </a>
+    <a href="https://pypi.org/project/fiesta-pkg/">
+    <img src="https://img.shields.io/pypi/v/fiesta-pkg.svg" alt="PyPI version">
+    </a>
+    <a href="https://fiesta-docs.readthedocs.io/">
+    <img src="https://readthedocs.org/projects/fiesta-docs/badge/?version=latest" alt="Documentation Status">
+    </a>
+    <a href="https://github.com/knaidoo29/FIESTA">
+    <img src="https://img.shields.io/badge/GitHub-repo-blue?logo=github" alt="GitHub repository">
+    </a>
+    <a href="https://img.shields.io/github/stars/knaidoo29/fiesta">
+    <img src="https://img.shields.io/github/stars/knaidoo29/fiesta" alt="github: stars">
+    </a>
+    <a href="https://img.shields.io/github/stars/knaidoo29/fiesta">
+    <img src="https://img.shields.io/github/forks/knaidoo29/fiesta" alt="github: forks">
+    </a>
+    <a href="https://opensource.org/licenses/MIT">
+    <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT">
+    </a>
+    <a href="https://github.com/psf/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
+    </a>
+    <!-- <a href="https://doi.org/10.5281/zenodo.17093446">
+    <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.17093446.svg" alt="zenodo: DOI">
+    </a> -->
+</p>
+
+## Introduction
+
+``FIESTA`` is a python library for general interpolation from uniform and non-uniform input points. The library is written in python with numba acceleration for speed. The library has the *optional* capability to be used on large data-sets by distributing jobs across multiple processes via ``MPI``. This relies on the ``mpi4py`` library and the ``MPI`` object from the ``shift-fft`` package (see [here](https://shift.readthedocs.io/en/latest/mpiutils.html)) which is passed as an additional object into ``MPI`` related functions.
+
+
+## Dependencies
+
+* [numba](https://numba.pydata.org/)
+* [numpy](http://www.numpy.org/)
+* [scipy](http://scipy.org/)
+* [shift-fft](https://shift.readthedocs.io/en/latest/index.html)
+* [mpi4py](https://mpi4py.readthedocs.io/en/stable/) [Optional: enables MPI distributed processes]
+
+## Installation
+
+FIESTA can be installed via ``pip``:
+
+```
+  pip install fiesta-pkg
+```
+
+or by cloning the repository:
+
+```
+    git clone https://github.com/knaidoo29/fiesta.git
+    cd FIESTA
+    pip install .
+```
+
+Once this is done you should be able to call `fiesta` from python:
+
+```
+    import fiesta
+```
+
+To use the ``MPI`` functionality please take a look at the documentation in FIESTA which instructs users how to use the ``shift-fft`` ``MPI`` object and how to run these distributed jobs successfully without errors or MPI related hanging.
+
+## Documentation
+
+In depth documentation and tutorials are provided [here](https://fiesta-docs.readthedocs.io/).
+
+## Citation
+
+If you use **FIESTA** in your work, please cite:
+
+<!-- [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17093446.svg)](https://doi.org/10.5281/zenodo.17093446)
+
+```bibtex
+  @software{naidoo_shift_2025,
+    author       = {Naidoo, Krishna},
+    title        = {SHIFT: a scalable MPI library for computing fast Fourier transforms in python},
+    year         = 2025,
+    publisher    = {Zenodo},
+    doi          = {10.5281/zenodo.17093446},
+    url          = {https://doi.org/10.5281/zenodo.17093446}}
+``` -->
+
+## Support
+
+If you have any issues with the code or want to suggest ways to improve it please open a new issue ([here](https://github.com/knaidoo29/FIESTA/issues)) or (if you don't have a github account) email _krishna.naidoo.11@ucl.ac.uk_.

fiesta_pkg-1.0.2/VERSION

@@ -0,0 +1 @@
+1.0.2

fiesta_pkg-1.0.2/docs/source/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
+
+import vinfo
+
+# -- Project information
+
+project = "FIESTA"
+copyright = "2021-2026, Krishna Naidoo"
+author = "Krishna Naidoo"
+
+version = vinfo.vstr
+
+# -- General configuration
+
+extensions = [
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.mathjax",
+    "sphinx_simplepdf",
+]
+
+source_suffix = [".rst", ".md"]
+
+# Napoleon settings
+napoleon_numpy_docstring = True
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+}
+intersphinx_disabled_domains = ["std"]
+
+templates_path = ["_templates"]
+
+
+# -- Options for HTML output
+
+# html_theme = 'sphinx_rtd_theme'
+html_theme = "furo"
+
+html_static_path = ["_static"]
+html_theme_options = {
+    "light_logo": "FiEsta_logo_small_white.jpg",
+    "dark_logo": "FiEsta_logo_small_black.jpg",
+}
+
+# -- Options for EPUB output
+epub_show_urls = "footnote"

fiesta_pkg-1.0.2/fiesta/__init__.py

@@ -0,0 +1,12 @@
+from . import boundary
+from . import coords
+from . import dtfe
+from . import maths
+from . import p2g
+from . import interp
+from . import kdtree
+from . import randoms
+from . import sph
+from . import src
+from . import utils
+from . import gridsph

fiesta_pkg-1.0.2/fiesta/boundary/__init__.py

@@ -0,0 +1,18 @@
+from .periodic import buffer_periodic
+from .periodic import subbox_buffer_periodic
+from .periodic import buffer_periodic_2D
+from .periodic import subbox_buffer_periodic_2D
+from .periodic import buffer_periodic_3D
+from .periodic import subbox_buffer_periodic_3D
+
+from .randoms import buffer_random_2D
+from .randoms import buffer_random_3D
+
+from .mpi_periodic import mpi_buffer_internal_2D
+from .mpi_periodic import mpi_buffer_internal_3D
+from .mpi_periodic import mpi_buffer_periodic_2D
+from .mpi_periodic import mpi_buffer_periodic_3D
+
+from .mpi_randoms import mpi_buffer_random_2D
+from .mpi_randoms import mpi_buffer_random_3D
+from .mpi_randoms import mpi_buffer_random_utils

fiesta_pkg-1.0.2/fiesta/boundary/mpi_periodic.py

@@ -0,0 +1,216 @@
+import numpy as np
+
+from . import periodic
+
+from typing import Union, List
+
+
+def mpi_buffer_internal_2D(
+    data: np.ndarray,
+    boxsize: float,
+    buffer_length: float,
+    MPI: object,
+    origin: float = 0.0,
+) -> np.ndarray:
+    """
+    Internal buffer particles between partitions are moved up and down.
+
+    Parameters
+    ----------
+    data : array
+        Where columns 0 and 1 correspond to the x and y coordinates.
+    xboxsize : float
+        Boxsize along x-axis.
+    buffer_length : float
+        Length of the buffer region.
+    MPI : class object
+        MPIutils MPI class object.
+    origin : float, optional
+        Origin point.
+
+    Returns
+    -------
+    datap : array
+        Periodic data values.
+    """
+    if np.isscalar(origin):
+        xorigin = origin
+    else:
+        xorigin = origin[0]
+    if np.isscalar(boxsize):
+        xboxsize = boxsize
+    else:
+        xboxsize = boxsize[0]
+    cond = np.where(data[:, 0] <= xorigin + buffer_length)[0]
+    data_send_down = MPI.send_down(data[cond])
+    cond = np.where(data[:, 0] >= xorigin + xboxsize - buffer_length)[0]
+    data_send_up = MPI.send_up(data[cond])
+    if MPI.rank == 0:
+        # data_send_up[:,0] -= xboxsize
+        datap = np.vstack([data, data_send_down])
+    elif MPI.rank == MPI.size - 1:
+        # data_send_down[:,0] += xboxsize
+        datap = np.vstack([data, data_send_up])
+    else:
+        datap = np.vstack([data, data_send_down, data_send_up])
+    return datap
+
+
+def mpi_buffer_periodic_2D(
+    data: np.ndarray,
+    boxsize: Union[float, List[float]],
+    buffer_length: float,
+    MPI: object,
+    origin: Union[float, List[float]] = 0.0,
+    include_internal: bool = True,
+) -> np.ndarray:
+    """
+    Generates random buffer particles around a 2D box.
+
+    Parameters
+    ----------
+    data : array
+        Where columns 0 and 1 are x and y.
+    boxsize : float or list
+        Boxsize.
+    buffer_length : float
+        Length of the buffer region.
+    MPI : class object
+        MPIutils MPI class object.
+    origin : float or list, optional
+        Origin point.
+    include_internal : bool, optional
+        Whether to include internal buffer particles.
+
+    Returns
+    -------
+    datap : array
+        Periodic data values.
+    """
+    if np.isscalar(origin):
+        xorigin, yorigin = origin, origin
+    else:
+        xorigin, yorigin = origin[0], origin[1]
+    if np.isscalar(boxsize):
+        xboxsize, yboxsize = boxsize, boxsize
+    else:
+        xboxsize, yboxsize = boxsize[0], boxsize[1]
+    datap = periodic.buffer_periodic(data, 1, yboxsize, buffer_length, origin=yorigin)
+    cond = np.where(datap[:, 0] <= xorigin + buffer_length)[0]
+    data_send_down = MPI.send_down(datap[cond])
+    cond = np.where(datap[:, 0] >= xorigin + xboxsize - buffer_length)[0]
+    data_send_up = MPI.send_up(datap[cond])
+    if MPI.rank == 0:
+        data_send_up[:, 0] -= xboxsize
+    elif MPI.rank == MPI.size - 1:
+        data_send_down[:, 0] += xboxsize
+    datap = np.vstack([datap, data_send_down, data_send_up])
+    if include_internal:
+        datap = mpi_buffer_internal_2D(datap, boxsize, buffer_length, MPI, origin)
+    return datap
+
+
+def mpi_buffer_internal_3D(
+    data: np.ndarray,
+    boxsize: float,
+    buffer_length: float,
+    MPI: object,
+    origin: float = 0.0,
+) -> np.ndarray:
+    """
+    Internal buffer particles between partitions are moved up and down.
+
+    Parameters
+    ----------
+    data : array
+        Where columns 0, 1 and 2 correspond to the x, y and z coordinates.
+    xboxsize : float
+        Boxsize along x-axis.
+    buffer_length : float
+        Length of the buffer region.
+    MPI : class object
+        MPIutils MPI class object.
+    origin : float, optional
+        Origin point.
+
+    Returns
+    -------
+    datap : array
+        Periodic data values.
+    """
+    if np.isscalar(origin):
+        xorigin = origin
+    else:
+        xorigin = origin[0]
+    if np.isscalar(boxsize):
+        xboxsize = boxsize
+    else:
+        xboxsize = boxsize[0]
+    cond = np.where(data[:, 0] <= xorigin + buffer_length)[0]
+    data_send_down = MPI.send_down(data[cond])
+    cond = np.where(data[:, 0] >= xorigin + xboxsize - buffer_length)[0]
+    data_send_up = MPI.send_up(data[cond])
+    if MPI.rank == 0:
+        # data_send_up[:,0] -= xboxsize
+        datap = np.vstack([data, data_send_down])
+    elif MPI.rank == MPI.size - 1:
+        # data_send_down[:,0] += xboxsize
+        datap = np.vstack([data, data_send_up])
+    else:
+        datap = np.vstack([data, data_send_down, data_send_up])
+    return datap
+
+
+def mpi_buffer_periodic_3D(
+    data: np.ndarray,
+    boxsize: Union[float, List[float]],
+    buffer_length: float,
+    MPI: object,
+    origin: Union[float, List[float]] = 0.0,
+    include_internal: bool = True,
+) -> np.ndarray:
+    """
+    Generates random buffer particles around a 3D box.
+
+    Parameters
+    ----------
+    data : array
+        Where columns 0, 1 and 2 correspond to the x, y and z coordinates.
+    xboxsize : float or list
+        Boxsize along x-axis.
+    buffer_length : float
+        Length of the buffer region.
+    MPI : class object
+        MPIutils MPI class object.
+    origin : float or list, optional
+        Origin point.
+    include_internal : bool, optional
+        Whether to include internal buffer particles.
+
+    Returns
+    -------
+    datap : array
+        Periodic data values.
+    """
+    if np.isscalar(origin):
+        xorigin, yorigin, zorigin = origin, origin, origin
+    else:
+        xorigin, yorigin, zorigin = origin[0], origin[1], origin[2]
+    if np.isscalar(boxsize):
+        xboxsize, yboxsize, zboxsize = boxsize, boxsize, boxsize
+    else:
+        xboxsize, yboxsize, zboxsize = boxsize[0], boxsize[1], boxsize[2]
+    datap = periodic.buffer_periodic(data, 1, yboxsize, buffer_length, origin=yorigin)
+    datap = periodic.buffer_periodic(datap, 2, zboxsize, buffer_length, origin=zorigin)
+    cond = np.where(datap[:, 0] <= xorigin + buffer_length)[0]
+    data_send_down = MPI.send_down(datap[cond])
+    cond = np.where(datap[:, 0] >= xorigin + xboxsize - buffer_length)[0]
+    data_send_up = MPI.send_up(datap[cond])
+    if MPI.rank == 0:
+        data_send_up[:, 0] -= xboxsize
+    elif MPI.rank == MPI.size - 1:
+        data_send_down[:, 0] += xboxsize
+    datap = np.vstack([datap, data_send_down, data_send_up])
+    if include_internal:
+        datap = mpi_buffer_internal_3D(datap, boxsize, buffer_length, MPI, origin)
+    return datap