phasorpy 0.1__cp311-cp311-macosx_11_0_arm64.whl

phasorpy/utils.py

@@ -0,0 +1,68 @@
+"""Utility functions.
+
+The ``phasorpy.utils`` module provides auxiliary and convenience functions
+that do not naturally fit into other modules.
+
+"""
+
+from __future__ import annotations
+
+__all__ = ['number_threads']
+
+import os
+
+
+def number_threads(
+    num_threads: int | None = None,
+    max_threads: int | None = None,
+    /,
+) -> int:
+    """Return number of threads for parallel computations on CPU cores.
+
+    This function is used to parse ``num_threads`` parameters.
+
+    Parameters
+    ----------
+    num_threads : int, optional
+        Number of threads to use for parallel computations on CPU cores.
+        If None (default), return 1, disabling multi-threading.
+        If greater than zero, return value up to `max_threads` if set.
+        If zero, return the value of the ``PHASORPY_NUM_THREADS`` environment
+        variable if set, else half the CPU cores up to `max_threads` or 32.
+    max_threads : int, optional
+        Maximum number of threads to return.
+
+    Examples
+    --------
+    >>> number_threads()
+    1
+    >>> number_threads(0)  # doctest: +SKIP
+    8
+
+    """
+    if num_threads is None or num_threads < 0:
+        # disable multi-threading by default
+        return 1
+    if num_threads == 0:
+        # return default number of threads
+        if max_threads is None:
+            max_threads = 32
+        else:
+            max_threads = max(max_threads, 1)
+        if 'PHASORPY_NUM_THREADS' in os.environ:
+            return min(
+                max_threads, max(1, int(os.environ['PHASORPY_NUM_THREADS']))
+            )
+        cpu_count: int | None
+        if hasattr(os, 'sched_getaffinity'):
+            cpu_count = len(os.sched_getaffinity(0))
+        else:
+            # sched_getaffinity not available on Windows
+            cpu_count = os.cpu_count()
+        if cpu_count is None:
+            return 1
+        return min(max_threads, max(1, cpu_count // 2))
+    # return num_threads up to max_threads
+    if max_threads is None:
+        return num_threads
+    return min(num_threads, max(max_threads, 1))

phasorpy/version.py

@@ -0,0 +1,71 @@
+"""Version information."""
+
+from __future__ import annotations
+
+__version__ = '0.1'
+
+
+def versions(
+    *, sep: str = '\n', dash: str = '-', verbose: bool = False
+) -> str:
+    """Return versions of installed packages that phasorpy depends on.
+
+    Parameters
+    ----------
+    sep : str, optional
+        Separator between version items. The default is a newline character.
+    dash : str, optional
+        Separator between module name and version.
+    verbose : bool, optional
+        Include paths to Python interpreter and modules.
+
+    Example
+    -------
+    >>> print(versions())
+    Python-3...
+    phasorpy-0...
+    numpy-...
+    ...
+
+    """
+    import os
+    import sys
+
+    if verbose:
+        version_strings = [f'Python{dash}{sys.version}  ({sys.executable})']
+    else:
+        version_strings = [f'Python{dash}{sys.version.split()[0]}']
+
+    for module in (
+        'phasorpy',
+        'numpy',
+        'tifffile',
+        'imagecodecs',
+        'lfdfiles',
+        'sdtfile',
+        'ptufile',
+        'matplotlib',
+        'scipy',
+        'skimage',
+        'sklearn',
+        'pandas',
+        'xarray',
+        'click',
+        'pooch',
+    ):
+        try:
+            __import__(module)
+        except ModuleNotFoundError:
+            version_strings.append(f'{module.lower()}{dash}n/a')
+            continue
+        lib = sys.modules[module]
+        ver = f"{module.lower()}{dash}{getattr(lib, '__version__', 'unknown')}"
+        if verbose:
+            try:
+                path = getattr(lib, '__file__')
+            except NameError:
+                pass
+            else:
+                ver += f'  ({os.path.dirname(path)})'
+        version_strings.append(ver)
+    return sep.join(version_strings)

phasorpy-0.1.dist-info/LICENSE.txt

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

phasorpy-0.1.dist-info/METADATA

@@ -0,0 +1,78 @@
+Metadata-Version: 2.1
+Name: phasorpy
+Version: 0.1
+Summary: Analysis of fluorescence lifetime and hyperspectral images using the phasor approach
+Author: PhasorPy Contributors
+License: MIT
+Project-URL: Homepage, https://www.phasorpy.org
+Project-URL: Documentation, https://www.phasorpy.org/docs/stable/
+Project-URL: Download, https://pypi.org/project/phasorpy/#files
+Project-URL: Source code, https://github.com/phasorpy/phasorpy
+Project-URL: Issue tracker, https://github.com/phasorpy/phasorpy/issues
+Project-URL: Release notes, https://www.phasorpy.org/docs/stable/release
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy >=1.24.0
+Requires-Dist: matplotlib >=3.7.0
+Requires-Dist: scipy >=1.11.0
+Requires-Dist: click
+Requires-Dist: pooch
+Requires-Dist: tqdm
+Requires-Dist: xarray >=2023.4.0
+Requires-Dist: tifffile >=2024.8.30
+Provides-Extra: all
+Requires-Dist: lfdfiles >=2024.5.24 ; extra == 'all'
+Requires-Dist: sdtfile >=2024.5.24 ; extra == 'all'
+Requires-Dist: ptufile >=2024.9.14 ; extra == 'all'
+Provides-Extra: docs
+Requires-Dist: sphinx ; extra == 'docs'
+Requires-Dist: sphinx-issues ; extra == 'docs'
+Requires-Dist: sphinx-gallery ; extra == 'docs'
+Requires-Dist: sphinx-copybutton ; extra == 'docs'
+Requires-Dist: sphinx-click ; extra == 'docs'
+Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
+Requires-Dist: numpydoc ; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: pytest-cov ; extra == 'test'
+Requires-Dist: pytest-runner ; extra == 'test'
+Requires-Dist: pytest-doctestplus ; extra == 'test'
+Requires-Dist: coverage ; extra == 'test'
+
+# PhasorPy
+
+PhasorPy is an open-source Python library for the analysis of fluorescence
+lifetime and hyperspectral images using the phasor approach.
+
+- [Homepage](https://www.phasorpy.org)
+- [Documentation](https://www.phasorpy.org/docs/stable/)
+- [Source code](https://github.com/phasorpy/phasorpy)
+- [Download releases](https://pypi.org/project/phasorpy/#files)
+- [Data files](https://zenodo.org/communities/phasorpy/)
+- [Issues and questions](https://github.com/phasorpy/phasorpy/issues)
+
+PhasorPy is a community-maintained project.
+[Contributions](https://www.phasorpy.org/docs/stable/contributing/)
+in the form of bug reports, bug fixes, feature implementations, documentation,
+datasets, and enhancement proposals are welcome.
+
+This software project is supported in part by the
+[Essential Open Source Software for Science (EOSS)](https://chanzuckerberg.com/eoss/)
+program at
+[Chan Zuckerberg Initiative](https://chanzuckerberg.com/).
+
+[![CZI's Essential Open Source Software for Science](https://chanzuckerberg.github.io/open-science/badges/CZI-EOSS.svg)](https://czi.co/EOSS)

phasorpy-0.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+phasorpy-0.1.dist-info/RECORD,,
+phasorpy-0.1.dist-info/WHEEL,sha256=PF0Mgwtv_oDs_mWYUtLpGhYaIa8jOhCqBxSqdxy2gqE,109
+phasorpy-0.1.dist-info/entry_points.txt,sha256=VRhsl3qGiIKwtMraKapmduchTMbdReUi1AoVTe9f3ss,47
+phasorpy-0.1.dist-info/top_level.txt,sha256=4Y0uYzya5R2loleAxZ6s2n53_FysUbgFTfFaU0i9rbo,9
+phasorpy-0.1.dist-info/LICENSE.txt,sha256=t94yqgj_PhdZMknTjvDb8jQK3_Yg_GE8Pzg5VOikVRE,1083
+phasorpy-0.1.dist-info/METADATA,sha256=o-X-ohzk7SBnDtA13WrgLKDCTQnzbQcdvZPCh7UfskI,3401
+phasorpy/_phasorpy.cpython-311-darwin.so,sha256=RGiLsvck5g6XRsW3ImyaNjNCrtE2PC8ffYbHat-dXmE,471436
+phasorpy/conftest.py,sha256=2oXUB0Al5GG3N4I4EB7O1Ymfy61Kv7hkDYf12rcH2Ic,913
+phasorpy/plot.py,sha256=JgbzBVHF9rOiDqMvtuaL8EWpf30_8MUc0UmkmBXU-sQ,67736
+phasorpy/color.py,sha256=PAcxkRExdI_Ohnfg3WhxV4wZ22MnusqY6VzH4XXvJFM,16732
+phasorpy/version.py,sha256=HlF1ckrSwZIV1DYoDabppm8QB-537ULjCowC_r3mWHw,1729
+phasorpy/_typing.py,sha256=bEh59izC7V94Zo5Dua0_LKGhJwet_at7PFTVWlV4HpY,1247
+phasorpy/_phasorpy.pyx,sha256=rnYgO6P857ZXZEGhE9oiDLD_yQKZwo3yDRcEM1CMdr0,48981
+phasorpy/cursors.py,sha256=v-lJ_cTD8NtEdvs_BJgXnI7Ewb0xuBPFcJArmNQGWwQ,15044
+phasorpy/io.py,sha256=w04DWnEktOTqMOpseA8LC4cFhhKdlC2nXyeb0fogHLI,52579
+phasorpy/datasets.py,sha256=q4fEGPSC5dy_74Kfv_UuKqlSMl3H25DQ4rJyNZ4oTuQ,14460
+phasorpy/phasor.py,sha256=xCpIl9l5maIM5iRw8gYOGmOQUnwOUe422ItHC3C5qMw,99084
+phasorpy/__init__.py,sha256=EIhsWWFnJdAnohtH60ZWyaSQowdCh_N_6ZWJ4wnzjxY,244
+phasorpy/cli.py,sha256=L1UmH2QR3L4F_ZknGc4xOZrDpqc0ofbYM8VHj0YDqzE,1890
+phasorpy/utils.py,sha256=PMYOQA7Hk6KtOngfIuU3kXh1dO7ACKZZcf0PU1rEZMU,2046
+phasorpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+phasorpy/components.py,sha256=hrin5zoWJUKtEms4vgAlAjbYU1Yj8mZmmJwCsQkmcOg,10102
+phasorpy/__main__.py,sha256=vkjfLooAnV7rSJwF_PEIM329cJI1Oh-Y5SYjFpqmuF4,142
+phasorpy/_utils.py,sha256=pKhf3sz3IUVyHwFU_5GnegvnQxQAwaMhsgD2RtQT6Ys,12122

phasorpy-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.1.0)
+Root-Is-Purelib: false
+Tag: cp311-cp311-macosx_11_0_arm64
+

phasorpy-0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+phasorpy = phasorpy.cli:main

phasorpy-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+phasorpy