empix 0.0.3__tar.gz → 0.0.5__tar.gz

empix-0.0.5/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: empix
+Version: 0.0.5
+Summary: Contains tools for analyzing electron microscopy data that are not available in ``hyperspy``.
+Author-email: Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>
+Project-URL: Homepage, https://mrfitzpa.github.io/empix
+Project-URL: Repository, https://github.com/mrfitzpa/empix
+Keywords: hyperspy,microscopy,cropping,downsampling,resampling,azimuthal integration,annular integration
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python
+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: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: czekitout
+Requires-Dist: fancytypes>=1.0.0
+Requires-Dist: hyperspy
+Requires-Dist: pyFAI
+Requires-Dist: numba
+Provides-Extra: tests
+Requires-Dist: pytest-cov; extra == "tests"
+Provides-Extra: examples
+Requires-Dist: jupyter; extra == "examples"
+Requires-Dist: ipympl; extra == "examples"
+Provides-Extra: docs
+Requires-Dist: sphinx<7; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: docutils; extra == "docs"
+Provides-Extra: all
+Requires-Dist: empix[docs,examples,tests]; extra == "all"
+Dynamic: license-file
+
+# Electron Microscopy Pix (EMPix)
+
+[![Test library](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml/badge.svg)](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml)
+[![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mrfitzpa/b7ef7892a2b5cf21ba4b6163c324afbe/raw/empix_coverage_badge.json)](https://github.com/mrfitzpa/empix/actions/workflows/measure_code_coverage.yml)
+[![Documentation](https://img.shields.io/badge/docs-read-brightgreen)](https://mrfitzpa.github.io/empix)
+[![PyPi Version](https://img.shields.io/pypi/v/empix.svg)](https://pypi.org/project/empix)
+[![Conda-Forge Version](https://img.shields.io/conda/vn/conda-forge/empix.svg)](https://anaconda.org/conda-forge/empix)
+[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+`empix` is a Python library that contains tools for analyzing electron
+microscopy data that are not available in
+[`hyperspy`](https://hyperspy.org/hyperspy-doc/current/index.html).
+
+Visit the [`empix` website](https://mrfitzpa.github.io/empix) for a web version
+of the installation instructions, the reference guide, and the examples archive.
+
+The source code can be found in the [`empix` GitHub
+repository](https://github.com/mrfitzpa/empix).
+
+
+
+## Table of contents
+
+- [Instructions for installing and uninstalling
+  `empix`](#instructions-for-installing-and-uninstalling-empix)
+  - [Installing `empix`](#installing-empix)
+    - [Installing `empix` using
+      `pip`](#installing-empix-using-pip)
+    - [Installing `empix` using
+      `conda`](#installing-empix-using-conda)
+  - [Uninstalling `empix`](#uninstalling-empix)
+- [Learning how to use `empix`](#learning-how-to-use-empix)
+
+
+
+## Instructions for installing and uninstalling `empix`
+
+
+
+### Installing `empix`
+
+For all installation scenarios, first open up the appropriate command line
+interface. On Unix-based systems, you could open e.g. a terminal. On Windows
+systems you could open e.g. an Anaconda Prompt as an administrator.
+
+
+
+#### Installing `empix` using `pip`
+
+Before installing `empix`, make sure that you have activated the (virtual)
+environment in which you intend to install said package. After which, simply
+change into the root of the repository, and run the following command:
+
+    pip install empix
+
+The above command will install the latest stable version of `empix`.
+
+To install the latest development version from the main branch of the [empix
+GitHub repository](https://github.com/mrfitzpa/empix), one must first clone the
+repository by running the following command:
+
+    git clone https://github.com/mrfitzpa/empix.git
+
+Next, change into the root of the cloned repository, and then run the following
+command:
+
+    pip install .
+
+Note that you must include the period as well. The above command executes a
+standard installation of `empix`.
+
+Optionally, for additional features in `empix`, one can install additional
+dependencies upon installing `empix`. To install a subset of additional
+dependencies (along with the standard installation), run the following command
+from the root of the repository:
+
+    pip install .[<selector>]
+
+where `<selector>` can be one of the following:
+
+* `tests`: to install the dependencies necessary for running unit tests;
+* `examples`: to install the dependencies necessary for executing files stored
+  in `<root>/examples`, where `<root>` is the root of the repository;
+* `docs`: to install the dependencies necessary for documentation generation;
+* `all`: to install all of the above optional dependencies.
+
+Alternatively, one can run:
+
+    pip install empix[<selector>]
+
+elsewhere in order to install the latest stable version of `empix`, along with
+the subset of additional dependencies specified by `<selector>`.
+
+
+
+#### Installing `empix` using `conda`
+
+To install `empix` using the `conda` package manager, run the following command:
+
+    conda install -c conda-forge empix
+
+The above command will install the latest stable version of `empix`.
+
+
+
+### Uninstalling `empix`
+
+If `empix` was installed using `pip`, then to uninstall, run the following
+command from the root of the repository:
+
+    pip uninstall empix
+
+If `empix` was installed using `conda`, then to uninstall, run the
+following command from the root of the repository:
+
+    conda remove empix
+
+
+
+## Learning how to use `empix`
+
+For those new to the `empix` library, it is recommended that they take a look at
+the [Examples](https://mrfitzpa.github.io/empix/examples.html) page, which
+contain code examples that show how one can use the `empix` library. While going
+through the examples, readers can consult the [empix reference
+guide](https://mrfitzpa.github.io/empix/_autosummary/empix.html) to understand
+what each line of code is doing.

empix-0.0.5/README.md

@@ -0,0 +1,127 @@
+# Electron Microscopy Pix (EMPix)
+
+[![Test library](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml/badge.svg)](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml)
+[![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mrfitzpa/b7ef7892a2b5cf21ba4b6163c324afbe/raw/empix_coverage_badge.json)](https://github.com/mrfitzpa/empix/actions/workflows/measure_code_coverage.yml)
+[![Documentation](https://img.shields.io/badge/docs-read-brightgreen)](https://mrfitzpa.github.io/empix)
+[![PyPi Version](https://img.shields.io/pypi/v/empix.svg)](https://pypi.org/project/empix)
+[![Conda-Forge Version](https://img.shields.io/conda/vn/conda-forge/empix.svg)](https://anaconda.org/conda-forge/empix)
+[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+`empix` is a Python library that contains tools for analyzing electron
+microscopy data that are not available in
+[`hyperspy`](https://hyperspy.org/hyperspy-doc/current/index.html).
+
+Visit the [`empix` website](https://mrfitzpa.github.io/empix) for a web version
+of the installation instructions, the reference guide, and the examples archive.
+
+The source code can be found in the [`empix` GitHub
+repository](https://github.com/mrfitzpa/empix).
+
+
+
+## Table of contents
+
+- [Instructions for installing and uninstalling
+  `empix`](#instructions-for-installing-and-uninstalling-empix)
+  - [Installing `empix`](#installing-empix)
+    - [Installing `empix` using
+      `pip`](#installing-empix-using-pip)
+    - [Installing `empix` using
+      `conda`](#installing-empix-using-conda)
+  - [Uninstalling `empix`](#uninstalling-empix)
+- [Learning how to use `empix`](#learning-how-to-use-empix)
+
+
+
+## Instructions for installing and uninstalling `empix`
+
+
+
+### Installing `empix`
+
+For all installation scenarios, first open up the appropriate command line
+interface. On Unix-based systems, you could open e.g. a terminal. On Windows
+systems you could open e.g. an Anaconda Prompt as an administrator.
+
+
+
+#### Installing `empix` using `pip`
+
+Before installing `empix`, make sure that you have activated the (virtual)
+environment in which you intend to install said package. After which, simply
+change into the root of the repository, and run the following command:
+
+    pip install empix
+
+The above command will install the latest stable version of `empix`.
+
+To install the latest development version from the main branch of the [empix
+GitHub repository](https://github.com/mrfitzpa/empix), one must first clone the
+repository by running the following command:
+
+    git clone https://github.com/mrfitzpa/empix.git
+
+Next, change into the root of the cloned repository, and then run the following
+command:
+
+    pip install .
+
+Note that you must include the period as well. The above command executes a
+standard installation of `empix`.
+
+Optionally, for additional features in `empix`, one can install additional
+dependencies upon installing `empix`. To install a subset of additional
+dependencies (along with the standard installation), run the following command
+from the root of the repository:
+
+    pip install .[<selector>]
+
+where `<selector>` can be one of the following:
+
+* `tests`: to install the dependencies necessary for running unit tests;
+* `examples`: to install the dependencies necessary for executing files stored
+  in `<root>/examples`, where `<root>` is the root of the repository;
+* `docs`: to install the dependencies necessary for documentation generation;
+* `all`: to install all of the above optional dependencies.
+
+Alternatively, one can run:
+
+    pip install empix[<selector>]
+
+elsewhere in order to install the latest stable version of `empix`, along with
+the subset of additional dependencies specified by `<selector>`.
+
+
+
+#### Installing `empix` using `conda`
+
+To install `empix` using the `conda` package manager, run the following command:
+
+    conda install -c conda-forge empix
+
+The above command will install the latest stable version of `empix`.
+
+
+
+### Uninstalling `empix`
+
+If `empix` was installed using `pip`, then to uninstall, run the following
+command from the root of the repository:
+
+    pip uninstall empix
+
+If `empix` was installed using `conda`, then to uninstall, run the
+following command from the root of the repository:
+
+    conda remove empix
+
+
+
+## Learning how to use `empix`
+
+For those new to the `empix` library, it is recommended that they take a look at
+the [Examples](https://mrfitzpa.github.io/empix/examples.html) page, which
+contain code examples that show how one can use the `empix` library. While going
+through the examples, readers can consult the [empix reference
+guide](https://mrfitzpa.github.io/empix/_autosummary/empix.html) to understand
+what each line of code is doing.

{empix-0.0.3 → empix-0.0.5}/docs/INSTALL.rst

@@ -1,28 +1,28 @@
 .. _installation_instructions_sec:
 
-Installation instructions
-=========================
-
-Installing empix
-----------------
+Instructions for installing and uninstalling ``empix``
+======================================================
 
 For all installation scenarios, first open up the appropriate command line
-interface. On Unix-based systems, you would open a terminal. On Windows systems
-you would open an Anaconda Prompt as an administrator.
+interface. On Unix-based systems, you could open e.g. a terminal. On Windows
+systems you could open e.g. an Anaconda Prompt as an administrator.
 
-Installing empix using pip
-~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The easiest way to install ``empix`` using ``pip`` is to run the following
-command::
+
+Installing ``empix`` using ``pip``
+----------------------------------
+
+Before installing ``empix``, make sure that you have activated the (virtual)
+environment in which you intend to install said package. After which, simply
+change into the root of the repository, and run the following command::
 
   pip install empix
 
 The above command will install the latest stable version of ``empix``.
 
-To install the latest development version from the main branch of the
-`empix GitHub repository <https://github.com/mrfitzpa/empix>`_,
-one must first clone the repository by running the following command::
+To install the latest development version from the main branch of the `empix
+GitHub repository <https://github.com/mrfitzpa/empix>`_, one must first clone
+the repository by running the following command::
 
   git clone https://github.com/mrfitzpa/empix.git
 
@@ -44,31 +44,41 @@ from the root of the repository::
 where ``<selector>`` can be one of the following:
 
 * ``tests``: to install the dependencies necessary for running unit tests;
-* ``examples``: to install the dependencies necessary for running the jupyter
-  notebooks stored in ``<root>/examples``, where ``<root>`` is the root of the
-  repository;
+* ``examples``: to install the dependencies necessary for executing files stored
+  in ``<root>/examples``, where ``<root>`` is the root of the repository;
 * ``docs``: to install the dependencies necessary for documentation generation;
 * ``all``: to install all of the above optional dependencies.
 
-Installing empix using conda
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Alternatively, one can run::
 
-To install ``empix`` using the ``conda`` package manager, run the following
-command::
+  pip install empix[<selector>]
+
+elsewhere in order to install the latest stable version of ``empix``, along with
+the subset of additional dependencies specified by ``<selector>``.
+
+
+
+Installing ``empix`` using ``conda``
+------------------------------------
+
+To install ``empix`` using the ``conda`` package manager, run the
+following command::
 
   conda install -c conda-forge empix
 
 The above command will install the latest stable version of ``empix``.
 
-Uninstalling empix
-------------------
 
-If ``empix`` was installed using ``pip``, then to uninstall, run the following
-command from the root of the repository::
+
+Uninstalling ``empix``
+----------------------
+
+If ``empix`` was installed using ``pip``, then to uninstall, run the
+following command from the root of the repository::
 
   pip uninstall empix
 
-If ``empix`` was installed using ``conda``, then to uninstall, run the following
-command from the root of the repository::
+If ``empix`` was installed using ``conda``, then to uninstall, run the
+following command from the root of the repository::
 
   conda remove empix

{empix-0.0.3 → empix-0.0.5}/docs/index.rst

@@ -1,19 +1,25 @@
-empix
-=====
+Electron Microscopy Pix (EMPix)
+===============================
 
 ``empix`` is a Python library that contains tools for analyzing electron
-microscopy data that are not available in hyperspy_.
+microscopy data that are not available in `hyperspy
+<https://hyperspy.org/hyperspy-doc/current/index.html>`_.
 
-.. _hyperspy: https://hyperspy.org/hyperspy-doc/current/index.html
+The source code can be found in the `empix GitHub repository
+<https://github.com/mrfitzpa/empix>`_.
 
-Setting up empix
-----------------
+
+
+Instructions for installing and uninstalling ``empix``
+------------------------------------------------------
 
 For instructions on installing the ``empix`` library, see the
 :ref:`installation_instructions_sec` page.
 
-Learning how to use empix
--------------------------
+
+     
+Learning how to use ``empix``
+-----------------------------
 
 For those new to the ``empix`` library, it is recommended that they take a look
 at the :ref:`examples_sec` page, which contain code examples that show how one
@@ -21,8 +27,11 @@ can use the ``empix`` library. While going through the examples, readers can
 consult the :ref:`reference_guide_sec` to understand what each line of code is
 doing.
 
+
+
 Contents
 --------
+
 .. toctree::
    :maxdepth: 6
    :numbered:
@@ -33,6 +42,8 @@ Contents
    examples
    license
 
+
+   
 Indices and tables
 ==================
 

empix-0.0.5/empix/version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.5'
+__version_tuple__ = version_tuple = (0, 0, 5)
+
+__commit_id__ = commit_id = 'g1e6933cb8'

empix-0.0.5/empix.egg-info/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: empix
+Version: 0.0.5
+Summary: Contains tools for analyzing electron microscopy data that are not available in ``hyperspy``.
+Author-email: Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>
+Project-URL: Homepage, https://mrfitzpa.github.io/empix
+Project-URL: Repository, https://github.com/mrfitzpa/empix
+Keywords: hyperspy,microscopy,cropping,downsampling,resampling,azimuthal integration,annular integration
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python
+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: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: czekitout
+Requires-Dist: fancytypes>=1.0.0
+Requires-Dist: hyperspy
+Requires-Dist: pyFAI
+Requires-Dist: numba
+Provides-Extra: tests
+Requires-Dist: pytest-cov; extra == "tests"
+Provides-Extra: examples
+Requires-Dist: jupyter; extra == "examples"
+Requires-Dist: ipympl; extra == "examples"
+Provides-Extra: docs
+Requires-Dist: sphinx<7; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: docutils; extra == "docs"
+Provides-Extra: all
+Requires-Dist: empix[docs,examples,tests]; extra == "all"
+Dynamic: license-file
+
+# Electron Microscopy Pix (EMPix)
+
+[![Test library](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml/badge.svg)](https://github.com/mrfitzpa/empix/actions/workflows/test_library.yml)
+[![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mrfitzpa/b7ef7892a2b5cf21ba4b6163c324afbe/raw/empix_coverage_badge.json)](https://github.com/mrfitzpa/empix/actions/workflows/measure_code_coverage.yml)
+[![Documentation](https://img.shields.io/badge/docs-read-brightgreen)](https://mrfitzpa.github.io/empix)
+[![PyPi Version](https://img.shields.io/pypi/v/empix.svg)](https://pypi.org/project/empix)
+[![Conda-Forge Version](https://img.shields.io/conda/vn/conda-forge/empix.svg)](https://anaconda.org/conda-forge/empix)
+[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+`empix` is a Python library that contains tools for analyzing electron
+microscopy data that are not available in
+[`hyperspy`](https://hyperspy.org/hyperspy-doc/current/index.html).
+
+Visit the [`empix` website](https://mrfitzpa.github.io/empix) for a web version
+of the installation instructions, the reference guide, and the examples archive.
+
+The source code can be found in the [`empix` GitHub
+repository](https://github.com/mrfitzpa/empix).
+
+
+
+## Table of contents
+
+- [Instructions for installing and uninstalling
+  `empix`](#instructions-for-installing-and-uninstalling-empix)
+  - [Installing `empix`](#installing-empix)
+    - [Installing `empix` using
+      `pip`](#installing-empix-using-pip)
+    - [Installing `empix` using
+      `conda`](#installing-empix-using-conda)
+  - [Uninstalling `empix`](#uninstalling-empix)
+- [Learning how to use `empix`](#learning-how-to-use-empix)
+
+
+
+## Instructions for installing and uninstalling `empix`
+
+
+
+### Installing `empix`
+
+For all installation scenarios, first open up the appropriate command line
+interface. On Unix-based systems, you could open e.g. a terminal. On Windows
+systems you could open e.g. an Anaconda Prompt as an administrator.
+
+
+
+#### Installing `empix` using `pip`
+
+Before installing `empix`, make sure that you have activated the (virtual)
+environment in which you intend to install said package. After which, simply
+change into the root of the repository, and run the following command:
+
+    pip install empix
+
+The above command will install the latest stable version of `empix`.
+
+To install the latest development version from the main branch of the [empix
+GitHub repository](https://github.com/mrfitzpa/empix), one must first clone the
+repository by running the following command:
+
+    git clone https://github.com/mrfitzpa/empix.git
+
+Next, change into the root of the cloned repository, and then run the following
+command:
+
+    pip install .
+
+Note that you must include the period as well. The above command executes a
+standard installation of `empix`.
+
+Optionally, for additional features in `empix`, one can install additional
+dependencies upon installing `empix`. To install a subset of additional
+dependencies (along with the standard installation), run the following command
+from the root of the repository:
+
+    pip install .[<selector>]
+
+where `<selector>` can be one of the following:
+
+* `tests`: to install the dependencies necessary for running unit tests;
+* `examples`: to install the dependencies necessary for executing files stored
+  in `<root>/examples`, where `<root>` is the root of the repository;
+* `docs`: to install the dependencies necessary for documentation generation;
+* `all`: to install all of the above optional dependencies.
+
+Alternatively, one can run:
+
+    pip install empix[<selector>]
+
+elsewhere in order to install the latest stable version of `empix`, along with
+the subset of additional dependencies specified by `<selector>`.
+
+
+
+#### Installing `empix` using `conda`
+
+To install `empix` using the `conda` package manager, run the following command:
+
+    conda install -c conda-forge empix
+
+The above command will install the latest stable version of `empix`.
+
+
+
+### Uninstalling `empix`
+
+If `empix` was installed using `pip`, then to uninstall, run the following
+command from the root of the repository:
+
+    pip uninstall empix
+
+If `empix` was installed using `conda`, then to uninstall, run the
+following command from the root of the repository:
+
+    conda remove empix
+
+
+
+## Learning how to use `empix`
+
+For those new to the `empix` library, it is recommended that they take a look at
+the [Examples](https://mrfitzpa.github.io/empix/examples.html) page, which
+contain code examples that show how one can use the `empix` library. While going
+through the examples, readers can consult the [empix reference
+guide](https://mrfitzpa.github.io/empix/_autosummary/empix.html) to understand
+what each line of code is doing.

{empix-0.0.3 → empix-0.0.5}/empix.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@
 LICENSE
 README.md
 pyproject.toml
+run_tests.sh
 setup.py
 tox.ini
 .github/workflows/measure_code_coverage.yml
@@ -31,4 +32,5 @@ empix.egg-info/dependency_links.txt
 empix.egg-info/requires.txt
 empix.egg-info/top_level.txt
 examples/basic_usage.ipynb
+examples/helpers_for_basic_usage.py
 tests/test_root.py

{empix-0.0.3 → empix-0.0.5}/empix.egg-info/requires.txt

@@ -1,7 +1,8 @@
 czekitout
 fancytypes>=1.0.0
-hyperspy[all]
+hyperspy
 pyFAI
+numba
 
 [all]
 empix[docs,examples,tests]