array-split 0.5.2__tar.gz → 0.7.1__tar.gz

array_split-0.7.1/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: array_split
+Version: 0.7.1
+Summary: The array_split python package is an enhancement to existing numpy.ndarray functions (such as numpy.array_split) which sub-divide a multi-dimensional array into a number of multi-dimensional sub-arrays (slices)
+Author-email: Shane-J-Latham <array.split@gmail.com>, array-split <array.split@gmail.com>
+License: Copyright (C) 2017 The Australian National 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.
+        
+Project-URL: Homepage, https://github.com/array-split/array_split
+Project-URL: Documentation, https://array-split.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/array-split/array_split
+Project-URL: Issues, https://github.com/array-split/array_split/issues
+Keywords: multi-dimensional-array,array,sub-array,tile,tiling,splitting,split,partition,partitioning,scipy,numpy,ndarray,domain-decomposition,array-decomposition
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: numpy>=1.6
+Dynamic: license-file
+
+
+=============
+`array_split`
+=============
+
+.. Start of sphinx doc include.
+.. start long description.
+.. start badges.
+
+.. image:: https://img.shields.io/pypi/v/array_split.svg
+   :target: https://pypi.python.org/pypi/array_split/
+   :alt: array_split python package
+.. image:: https://github.com/array-split/array_split/actions/workflows/python-test.yml/badge.svg
+   :target: https://github.com/array-split/array_split/actions/workflows/python-test.yml
+   :alt: array_split python package
+.. image:: https://readthedocs.org/projects/array-split/badge/?version=stable
+   :target: http://array-split.readthedocs.io/en/stable
+   :alt: Documentation Status
+.. image:: https://coveralls.io/repos/github/array-split/array_split/badge.svg
+   :target: https://coveralls.io/github/array-split/array_split
+   :alt: Coveralls Status
+.. image:: https://img.shields.io/pypi/l/array_split.svg
+   :target: https://pypi.python.org/pypi/array_split/
+   :alt: MIT License
+.. image:: https://img.shields.io/pypi/pyversions/array_split.svg
+   :target: https://pypi.python.org/pypi/array_split/
+   :alt: array_split python package
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.889078.svg
+   :target: https://doi.org/10.5281/zenodo.889078
+.. image:: http://joss.theoj.org/papers/10.21105/joss.00373/status.svg
+   :target: http://joss.theoj.org/papers/4b59c7430176ef78c80c6a1100031eb6
+
+.. end badges.
+
+The `array_split <http://array-split.readthedocs.io/en/latest>`_ python package is
+an enhancement to existing
+`numpy.ndarray  <http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html>`_ functions,
+such as
+`numpy.array_split <http://docs.scipy.org/doc/numpy/reference/generated/numpy.array_split.html>`_,
+`skimage.util.view_as_blocks <http://scikit-image.org/docs/0.13.x/api/skimage.util.html#view-as-blocks>`_
+and
+`skimage.util.view_as_windows <http://scikit-image.org/docs/0.13.x/api/skimage.util.html#view-as-windows>`_,
+which sub-divide a multi-dimensional array into a number of multi-dimensional sub-arrays (slices).
+Example application areas include:
+
+**Parallel Processing**
+   A large (dense) array is partitioned into smaller sub-arrays which can be
+   processed concurrently by multiple processes
+   (`multiprocessing <https://docs.python.org/3/library/multiprocessing.html>`_
+   or `mpi4py <http://pythonhosted.org/mpi4py/>`_) or other memory-limited hardware
+   (e.g. GPGPU using `pyopencl <https://mathema.tician.de/software/pyopencl/>`_,
+   `pycuda <https://mathema.tician.de/software/pycuda/>`_, etc).
+   For GPGPU, it is necessary for sub-array not to exceed the GPU memory and
+   desirable for the sub-array shape to be a multiple of the *work-group*
+   (`OpenCL <https://en.wikipedia.org/wiki/OpenCL>`_)
+   or *thread-block* (`CUDA <https://en.wikipedia.org/wiki/CUDA>`_) size.
+
+**File I/O**
+   A large (dense) array is partitioned into smaller sub-arrays which can be
+   written to individual files
+   (as, for example, a
+   `HDF5 Virtual Dataset <https://support.hdfgroup.org/HDF5/docNewFeatures/NewFeaturesVirtualDatasetDocs.html>`_).
+   It is often desirable for the individual files not to exceed a specified number
+   of (Giga) bytes and, for `HDF5 <https://support.hdfgroup.org/HDF5/>`_, it is desirable
+   to have the individual file sub-array shape a multiple of
+   the `chunk shape <https://support.hdfgroup.org/HDF5/doc1.8/Advanced/Chunking/index.html>`_.
+   Similarly, `out of core <https://en.wikipedia.org/wiki/Out-of-core_algorithm>`_
+   algorithms for large dense arrays often involve processing the entire data-set as
+   a series of *in-core* sub-arrays. Again, it is desirable for the individual sub-array shape
+   to be a multiple of the
+   `chunk shape <https://support.hdfgroup.org/HDF5/doc1.8/Advanced/Chunking/index.html>`_.  
+
+
+The `array_split <http://array-split.readthedocs.io/en/latest>`_ package provides the
+means to partition an array (or array shape) using any of the following criteria:
+
+- Per-axis indices indicating the *cut* positions.
+- Per-axis number of sub-arrays.
+- Total number of sub-arrays (with optional per-axis *number of sections* constraints).
+- Specific sub-array shape.
+- Specification of *halo* (*ghost*) elements for sub-arrays.
+- Arbitrary *start index* for the shape to be partitioned.
+- Maximum number of bytes for a sub-array with constraints:
+
+   - sub-arrays are an even multiple of a specified sub-tile shape
+   - upper limit on the per-axis sub-array shape
+
+
+Quick Start Example
+===================
+
+
+   >>> from array_split import array_split, shape_split
+   >>> import numpy as np
+   >>>
+   >>> ary = np.arange(0, 4*9)
+   >>> 
+   >>> array_split(ary, 4) # 1D split into 4 sections (like numpy.array_split)
+   [array([0, 1, 2, 3, 4, 5, 6, 7, 8]),
+    array([ 9, 10, 11, 12, 13, 14, 15, 16, 17]),
+    array([18, 19, 20, 21, 22, 23, 24, 25, 26]),
+    array([27, 28, 29, 30, 31, 32, 33, 34, 35])]
+   >>> 
+   >>> shape_split(ary.shape, 4) # 1D split into 4 parts, returns slice objects 
+   array([(slice(0, 9, None),), (slice(9, 18, None),), (slice(18, 27, None),), (slice(27, 36, None),)], 
+         dtype=[('0', 'O')])
+   >>> 
+   >>> ary = ary.reshape(4, 9) # Make ary 2D
+   >>> split = shape_split(ary.shape, axis=(2, 3)) # 2D split into 2*3=6 sections
+   >>> split.shape
+   (2, 3)
+   >>> split
+   array([[(slice(0, 2, None), slice(0, 3, None)),
+           (slice(0, 2, None), slice(3, 6, None)),
+           (slice(0, 2, None), slice(6, 9, None))],
+          [(slice(2, 4, None), slice(0, 3, None)),
+           (slice(2, 4, None), slice(3, 6, None)),
+           (slice(2, 4, None), slice(6, 9, None))]], 
+         dtype=[('0', 'O'), ('1', 'O')])
+   >>> sub_arys = [ary[tup] for tup in split.flatten()] # Create sub-array views from slice tuples.
+   >>> sub_arys
+   [array([[ 0,  1,  2], [ 9, 10, 11]]),
+    array([[ 3,  4,  5], [12, 13, 14]]),
+    array([[ 6,  7,  8], [15, 16, 17]]),
+    array([[18, 19, 20], [27, 28, 29]]),
+    array([[21, 22, 23], [30, 31, 32]]),
+    array([[24, 25, 26], [33, 34, 35]])]
+
+
+Latest sphinx documentation (including more examples)
+at http://array-split.readthedocs.io/en/latest/.
+
+.. end long description.
+
+Installation
+============
+
+Using ``pip`` (root access required):
+
+   ``pip install array_split``
+   
+or local user install (no root access required):
+   
+   ``pip install --user array_split``
+
+or local user install from latest github source:
+
+   ``pip install --user git+git://github.com/array-split/array_split.git#egg=array_split``
+
+
+Requirements
+============
+
+Requires `numpy <http://docs.scipy.org/doc/numpy/>`_ version `>= 1.6`,
+python-2 version `>= 2.6` or python-3 version `>= 3.2`.
+
+Testing
+=======
+
+Run tests (unit-tests and doctest module docstring tests) using::
+
+   python -m array_split.tests
+
+or, from the source tree, run::
+
+   python setup.py test
+
+
+Travis CI at:
+
+   https://travis-ci.org/array-split/array_split/
+
+and AppVeyor at:
+
+   https://ci.appveyor.com/project/array-split/array-split
+
+Documentation
+=============
+
+Latest sphinx generated documentation is at:
+
+    http://array-split.readthedocs.io/en/latest
+
+and at github *gh-pages*:
+
+    https://array-split.github.io/array_split/
+
+Sphinx documentation can be built from the source::
+
+   python setup.py build_sphinx
+
+with the HTML generated in ``docs/_build/html``.
+
+
+Latest source code
+==================
+
+Source at github:
+
+   https://github.com/array-split/array_split
+
+
+Bug Reports
+===========
+
+To search for bugs or report them, please use the bug tracker at:
+
+   https://github.com/array-split/array_split/issues
+
+
+Contributing
+============
+
+Check out the `CONTRIBUTING doc <https://github.com/array-split/array_split/blob/dev/CONTRIBUTING.rst>`_.
+
+
+License information
+===================
+
+See the file `LICENSE.txt <https://github.com/array-split/array_split/blob/dev/LICENSE.txt>`_
+for terms & conditions, for usage and a DISCLAIMER OF ALL WARRANTIES.

{array_split-0.5.2 → array_split-0.7.1}/README.rst

@@ -10,12 +10,9 @@
 .. image:: https://img.shields.io/pypi/v/array_split.svg
    :target: https://pypi.python.org/pypi/array_split/
    :alt: array_split python package
-.. image:: https://travis-ci.org/array-split/array_split.svg?branch=dev
-   :target: https://travis-ci.org/array-split/array_split
-   :alt: TravisCI Status
-.. image:: https://ci.appveyor.com/api/projects/status/oprsw5rfr07m77o0?svg=true
-   :target: https://ci.appveyor.com/project/array-split/array-split
-   :alt: AppVeyor Status
+.. image:: https://github.com/array-split/array_split/actions/workflows/python-test.yml/badge.svg
+   :target: https://github.com/array-split/array_split/actions/workflows/python-test.yml
+   :alt: array_split python package
 .. image:: https://readthedocs.org/projects/array-split/badge/?version=stable
    :target: http://array-split.readthedocs.io/en/stable
    :alt: Documentation Status
@@ -28,6 +25,10 @@
 .. image:: https://img.shields.io/pypi/pyversions/array_split.svg
    :target: https://pypi.python.org/pypi/array_split/
    :alt: array_split python package
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.889078.svg
+   :target: https://doi.org/10.5281/zenodo.889078
+.. image:: http://joss.theoj.org/papers/10.21105/joss.00373/status.svg
+   :target: http://joss.theoj.org/papers/4b59c7430176ef78c80c6a1100031eb6
 
 .. end badges.
 

{array_split-0.5.2 → array_split-0.7.1}/array_split/__init__.py

@@ -60,15 +60,18 @@ Attributes
 
 
 """
-from __future__ import absolute_import
-from .license import license as _license, copyright as _copyright, version as _version
-from . import split  # noqa: E402,F401
-from .split import array_split, shape_split, ShapeSplitter  # noqa: E402,F401
+
+from . import (
+    _version,
+    split,
+)
+from .license import copyright as _copyright, license as _license
+from .split import ShapeSplitter, array_split, shape_split  # noqa: F401
 
 __author__ = "Shane J. Latham"
 __license__ = _license()
 __copyright__ = _copyright()
-__version__ = _version()
+__version__ = _version.get_versions()['version']
 
 
 #: See :data:`array_split.split.ARRAY_BOUNDS`

array_split-0.7.1/array_split/_version.py

@@ -0,0 +1,21 @@
+
+# This file was generated by 'versioneer.py' (0.29) from
+# revision-control system data, or from the parent directory name of an
+# unpacked source archive. Distribution tarballs contain a pre-generated copy
+# of this file.
+
+import json
+
+version_json = '''
+{
+ "date": "2026-10-10T18:49:13+1100",
+ "dirty": false,
+ "error": null,
+ "full-revisionid": "c83a57c07a2873a72c451ec55c9088f6938cbe87",
+ "version": "0.7.1"
+}
+'''  # END VERSION_JSON
+
+
+def get_versions():
+    return json.loads(version_json)

{array_split-0.5.2 → array_split-0.7.1}/array_split/license.py

@@ -2,19 +2,20 @@
 To be replaced.
 """
 # pylint: disable=redefined-builtin
-from __future__ import absolute_import
-import pkg_resources as _pkg_resources
+from importlib.resources import files
 
-__copyright__ = _pkg_resources.resource_string("array_split", "copyright.txt").decode()
+from . import _version
+
+__copyright__ = files("array_split").joinpath("copyright.txt").read_bytes().decode()
 __license__ = (
     __copyright__
     +
     "\n\n"
     +
-    _pkg_resources.resource_string("array_split", "license.txt").decode()
+    files("array_split").joinpath("license.txt").read_bytes().decode()
 )
 __author__ = "Shane J. Latham"
-__version__ = _pkg_resources.resource_string("array_split", "version.txt").decode().strip()
+__version__ = _version.get_versions()['version']
 
 
 def version():
@@ -77,6 +78,6 @@ Functions
    copyright - Returns :mod:`array_split` copyright string.
    version - Returns :mod:`array_split` version string.
 
-""" % (license(), copyright())
+""" % (license(), copyright())  # noqa: UP031
 
 __all__ = [s for s in dir() if not s.startswith('_')]

{array_split-0.5.2 → array_split-0.7.1}/array_split/logging.py

@@ -26,12 +26,11 @@ Classes and Functions
 # pylint: disable=wildcard-import
 # pylint: disable=invalid-name
 
-from __future__ import absolute_import
-
-import sys
 import logging as _builtin_logging
-from logging import *  # noqa: F401,F403
-from .license import license as _license, copyright as _copyright, version as _version
+import sys
+from logging import *
+
+from .license import copyright as _copyright, license as _license, version as _version
 
 __author__ = "Shane J. Latham"
 __license__ = _license()
@@ -39,66 +38,7 @@ __copyright__ = _copyright()
 __version__ = _version()
 
 
-class _Python2SplitStreamHandler(_builtin_logging.Handler):
-
-    """
-    A python :obj:`logging.handlers` :samp:`Handler` class for
-    splitting logging messages to different streams depending on
-    the logging-level.
-    """
-
-    def __init__(self, outstr=sys.stdout, errstr=sys.stderr, splitlevel=_builtin_logging.WARNING):
-        """
-        Initialise with a pair of streams and a threshold level which determines
-        the stream where the messages are writting.
-
-        :type outstr: file-like
-        :param outstr: Logging messages are written to this stream if
-           the message level is less than :samp:`self.splitLevel`.
-        :type errstr: stream
-        :param errstr: Logging messages are written to this stream if
-           the message level is greater-than-or-equal-to :samp:`self.splitLevel`.
-        :type splitlevel: int
-        :param splitlevel: Logging level threshold determining split streams for log messages.
-        """
-        self.outStream = outstr
-        self.errStream = errstr
-        self.splitLevel = splitlevel
-        _builtin_logging.Handler.__init__(self)
-
-    def emit(self, record):
-        """
-        Mostly copy-paste from :obj:`logging.StreamHandler`.
-        """
-        try:
-            msg = self.format(record)
-            if record.levelno < self.splitLevel:
-                stream = self.outStream
-            else:
-                stream = self.errStream
-            fs = "%s\n"
-
-            try:
-                if (isinstance(msg, unicode) and  # noqa: F405
-                        getattr(stream, 'encoding', None)):
-                    ufs = fs.decode(stream.encoding)
-                    try:
-                        stream.write(ufs % msg)
-                    except UnicodeEncodeError:
-                        stream.write((ufs % msg).encode(stream.encoding))
-                else:
-                    stream.write(fs % msg)
-            except UnicodeError:
-                stream.write(fs % msg.encode("UTF-8"))
-
-            stream.flush()
-        except (KeyboardInterrupt, SystemExit):
-            raise
-        except:
-            self.handleError(record)
-
-
-class _Python3SplitStreamHandler(_builtin_logging.Handler):
+class SplitStreamHandler(_builtin_logging.Handler):
 
     """
     A python :obj:`logging.handlers` :samp:`Handler` class for
@@ -162,28 +102,10 @@ class _Python3SplitStreamHandler(_builtin_logging.Handler):
             self.flush()
         except (KeyboardInterrupt, SystemExit):  # pragma: no cover
             raise
-        except:
+        except Exception:  # noqa: BLE001
             self.handleError(record)
 
 
-if sys.version_info[0] <= 2:
-    class SplitStreamHandler(_Python2SplitStreamHandler):
-
-        """
-        To be replaced.
-        """
-
-        __doc__ = _Python2SplitStreamHandler.__doc__
-else:
-    class SplitStreamHandler(_Python3SplitStreamHandler):
-
-        """
-        To be replaced.
-        """
-
-        __doc__ = _Python3SplitStreamHandler.__doc__
-
-
 def get_formatter(prefix_string="ARRSPLT| "):
     """
     Returns :obj:`logging.Formatter` object which produces messages