diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 949c35204..4e5ba6268 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -19,7 +19,7 @@ Minimum working example of code A clear and concise description of what you expected to happen. #### Python environement: - - exSpy version: 0.x.x + - eXSpy version: 0.x.x - HyperSpy version: 1.x.x - Python version: 3.x diff --git a/CHANGES.rst b/CHANGES.rst index c1e15bba0..46e383cd4 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -39,8 +39,8 @@ Maintenance Initiation (2023-10-28) ======================= -- exSpy was split out of the `HyperSpy repository +- eXSpy was split out of the `HyperSpy repository `_ on Oct. 28, 2023. The X-ray energy dispersive spectroscopy (EDS) and energy electron loss spectroscopy (EELS) functionalities so far developed in HyperSpy were moved to the - `exSpy repository `_. + `eXSpy repository `_. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index faa461d2e..75a7e0bdd 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -3,7 +3,7 @@ Contributing ************ -exSpy is meant to be a community maintained project. We welcome contributions +eXSpy is meant to be a community maintained project. We welcome contributions in the form of bug reports, documentation, code, feature requests, and more. In the following we refer to some resources to help you make useful contributions. @@ -20,7 +20,7 @@ useful: Pull Requests ============= -If you want to contribute to the exSpy source code, you can send us a +If you want to contribute to the eXSpy source code, you can send us a `pull request `_. Small bug fixes or corrections to the user guide are typically a good starting point. But don't hesitate also for significant code contributions - if needed, we'll help you @@ -44,7 +44,7 @@ other member of the development team before being merged. Documentation ============= -The exSpy documentation consists of three elements: +The eXSpy documentation consists of three elements: - Docstrings following the `numpy standard `_ @@ -54,7 +54,7 @@ The exSpy documentation consists of three elements: `_ and hosted on `Read the Docs `_. The source is part of the `GitHub repository `_. -- Jupyter notebooks in the `exSpy demos repository +- Jupyter notebooks in the `eXSpy demos repository `_ on GitHub that provide tutorials and example workflows. @@ -64,7 +64,7 @@ functionality. You can contribute through pull requests to the respective reposi Code style ========== -exSpy follows `Style Guide for Python Code `_ +eXSpy follows `Style Guide for Python Code `_ with `The Black Code style `_. @@ -81,9 +81,9 @@ them: Writing tests ============= -All functionality in exSpy is tested via the `pytest `_ +All functionality in eXSpy is tested via the `pytest `_ framework. The tests reside in the ``test`` directory. Tests are short methods that call -functions in exSpy and compare resulting output values with known answers. +functions in eXSpy and compare resulting output values with known answers. Please refer to the `HyperSpy development guide `_ for further information on tests. @@ -91,7 +91,7 @@ information on tests. Releasing a new version ======================= -exSpy versioning follows `semantic versioning `_ +eXSpy versioning follows `semantic versioning `_ and the version number is therefore a three-part number: MAJOR.MINOR.PATCH. Each number will change depending on the type of changes according to the following: diff --git a/README.md b/README.md index c24ecc4e2..ab2375190 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,16 @@ [![codecov](https://codecov.io/gh/hyperspy/exspy/graph/badge.svg?token=X7T3LE121Q)](https://codecov.io/gh/hyperspy/exspy) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -**exSpy** is a Python package extending the functionality for multi-dimensional +**eXSpy** is a Python package extending the functionality for multi-dimensional data analysis provided by the [HyperSpy](https://hyperspy.org) library. It is aimed at helping with the analysis of X-rays Energy Dispersive Spectroscopy (EDS) and Electron Energy Loss Spectroscopy (EELS). -Go to the documentation for instructions on how to install exSpy and start an +Go to the documentation for instructions on how to install eXSpy and start an analysis: [Read the docs](https://exspy.readthedocs.io). Everyone is welcome to contribute. Please read our [contributing guidelines](https://github.com/hyperspy/exspy/blob/main/CONTRIBUTING.rst) and get started! -Development of exSpy is documented in the +Development of eXSpy is documented in the [changelog](https://github.com/hyperspy/exspy/blob/main/CHANGES.rst). diff --git a/doc/_static/exspy-banner-dark.png b/doc/_static/exspy-banner-dark.png new file mode 100644 index 000000000..26485a3a9 Binary files /dev/null and b/doc/_static/exspy-banner-dark.png differ diff --git a/doc/_static/exspy-banner-dark.svg b/doc/_static/exspy-banner-dark.svg new file mode 100644 index 000000000..ede290d00 --- /dev/null +++ b/doc/_static/exspy-banner-dark.svg @@ -0,0 +1,125 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/_static/exspy-banner-light.png b/doc/_static/exspy-banner-light.png new file mode 100644 index 000000000..6bc1aa9b6 Binary files /dev/null and b/doc/_static/exspy-banner-light.png differ diff --git a/doc/_static/exspy-banner-light.svg b/doc/_static/exspy-banner-light.svg new file mode 100644 index 000000000..6d31658c8 --- /dev/null +++ b/doc/_static/exspy-banner-light.svg @@ -0,0 +1,122 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/_static/exspy-logo-dark.png b/doc/_static/exspy-logo-dark.png new file mode 100644 index 000000000..cabcfbbef Binary files /dev/null and b/doc/_static/exspy-logo-dark.png differ diff --git a/doc/_static/exspy-logo-dark.svg b/doc/_static/exspy-logo-dark.svg new file mode 100644 index 000000000..8427337d4 --- /dev/null +++ b/doc/_static/exspy-logo-dark.svg @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + diff --git a/doc/_static/exspy-logo-light.png b/doc/_static/exspy-logo-light.png new file mode 100644 index 000000000..777ad70cd Binary files /dev/null and b/doc/_static/exspy-logo-light.png differ diff --git a/doc/_static/exspy-logo-light.svg b/doc/_static/exspy-logo-light.svg new file mode 100644 index 000000000..7fd4a78cf --- /dev/null +++ b/doc/_static/exspy-logo-light.svg @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + diff --git a/doc/_static/exspy.ico b/doc/_static/exspy.ico new file mode 100644 index 000000000..acc4ce4e9 Binary files /dev/null and b/doc/_static/exspy.ico differ diff --git a/doc/_static/hyperspy.ico b/doc/_static/hyperspy.ico deleted file mode 100644 index 6da884b1b..000000000 Binary files a/doc/_static/hyperspy.ico and /dev/null differ diff --git a/doc/_static/hyperspy_logo.png b/doc/_static/hyperspy_logo.png deleted file mode 100644 index 48659a0d3..000000000 Binary files a/doc/_static/hyperspy_logo.png and /dev/null differ diff --git a/doc/citing.rst b/doc/citing.rst index abb8985c7..f351798f0 100644 --- a/doc/citing.rst +++ b/doc/citing.rst @@ -1,10 +1,10 @@ -Citing exSpy +Citing eXSpy ************ -**exSpy** is maintained by the exSpy community +**eXSpy** is maintained by the eXSpy community `_. -If exSpy has been significant to a project that leads to an academic +If eXSpy has been significant to a project that leads to an academic publication, please acknowledge that fact by citing it. The DOI in the badge below is the `Concept DOI `_ -- it can be used to cite the project without referring to a specific diff --git a/doc/conf.py b/doc/conf.py index 7f459f6fa..f6a6f2428 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -26,9 +26,9 @@ # -- Project information ----------------------------------------------------- -project = "exSpy" -copyright = "2023, exSpy Developers" -author = "exSpy Developers" +project = "eXSpy" +copyright = "2023, eSpy Developers" +author = "eXSpy Developers" # -- General configuration --------------------------------------------------- @@ -105,20 +105,18 @@ }, ], "logo": { - "text": "exSpy", + "alt_text": "eXSpy", + "image_light": "_static/exspy-banner-light.svg", + "image_dark": "_static/exspy-banner-dark.svg", }, "header_links_before_dropdown": 6, "navigation_with_keys": False, } -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = "_static/hyperspy_logo.png" - # -- Options for sphinx_favicon extension ----------------------------------- favicons = [ - "hyperspy.ico", + "exspy.ico", ] # Check links to API when building documentation diff --git a/doc/intro.rst b/doc/intro.rst index 2ef27a63f..1e8a9bce7 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -1,6 +1,6 @@ -Welcome to exSpy's documentation! -*********************************** -**exSpy** is a Python package extending the functionality for multi-dimensional +Welcome to the documentation of eXSpy! +************************************** +**eXSpy** is a Python package extending the functionality for multi-dimensional data analysis provided by the `HyperSpy `_ library. It is aimed at helping with the analysis of X-rays Energy Dispersive Spectroscopy (EDS) and Electron Energy Loss Spectroscopy (EELS). @@ -27,8 +27,8 @@ Learning resources :octicon:`rocket;2em;sd-text-info` Getting Started ^^^ - New to exSpy or the HyperSpy ecosystem? The getting started guide provides an - introduction on basic usage of exSpy and how to install it. + New to eXSpy or the HyperSpy ecosystem? The getting started guide provides an + introduction on basic usage of eXSpy and how to install it. .. grid-item-card:: :link: user_guide/index @@ -37,7 +37,7 @@ Learning resources :octicon:`book;2em;sd-text-info` User Guide ^^^ - The user guide provides in-depth information on key concepts of exSpy + The user guide provides in-depth information on key concepts of eXSpy and how to use it along with background information and explanations. .. grid-item-card:: @@ -48,7 +48,7 @@ Learning resources ^^^ Documentation of the metadata specification and of the Application Progamming Interface (API), - which describe how exSpy functions work and which parameters can be used. + which describe how eXSpy functions work and which parameters can be used. .. grid-item-card:: :link: auto_examples/index @@ -58,7 +58,7 @@ Learning resources ^^^ Gallery of short examples illustrating simple tasks that - can be performed with exSpy and HyperSpy. + can be performed with eXSpy and HyperSpy. .. grid-item-card:: :link: https://github.com/hyperspy/exspy-demos @@ -67,7 +67,7 @@ Learning resources ^^^ Tutorials in form of Jupyter Notebooks to learn how to process - multi-dimensional electron/X-ray spectroscopy data using exSpy. + multi-dimensional electron/X-ray spectroscopy data using eXSpy. .. grid-item-card:: :link: contributing @@ -76,17 +76,17 @@ Learning resources :octicon:`people;2em;sd-text-info` Contributing ^^^ - exSpy and the whole HyperSpy ecosystem are a community project + eXSpy and the whole HyperSpy ecosystem are a community project maintained for and by its users. There are many ways you can help! -Citing exSpy +Citing eXSpy ============ -If exSpy has been significant to a project that leads to an academic +If eXSpy has been significant to a project that leads to an academic publication, please acknowledge that fact by citing it. The DOI in the badge below is the `Concept DOI `_ of -exSpy. It can be used to cite the project without referring to a specific -version. If you are citing exSpy because you have used it to process data, +eXSpy. It can be used to cite the project without referring to a specific +version. If you are citing eXSpy because you have used it to process data, please use the DOI of the specific version that you have employed. You can find it by clicking on the DOI badge below. @@ -98,8 +98,8 @@ Citation in the scientific literature Given the increasing number of articles that cite HyperSpy and its extension packages, we do not maintain a list of -articles citing exSpy or HyperSpy. For an up to date list search for -exSpy/HyperSpy in a scientific database e.g. `Google Scholar +articles citing eXSpy or HyperSpy. For an up to date list search for +exspy/HyperSpy in a scientific database e.g. `Google Scholar `_. .. Warning:: @@ -110,13 +110,13 @@ exSpy/HyperSpy in a scientific database e.g. `Google Scholar License ======= -**exSpy** is free software: you can redistribute it and/or modify +**eXSpy** is free software: you can redistribute it and/or modify it under the terms of the `GNU General Public License (GPL) `_ as published by the Free Software Foundation, either version 3 of the license, or (at your option) any later version. -**exSpy** is distributed in the hope that it will be useful, +**eXSpy** is distributed in the hope that it will be useful, but **without any warranty**; without even the implied warranty of **merchantability** or **fitness for a particular purpose**. See the `GNU General Public License `_ diff --git a/doc/user_guide/install.rst b/doc/user_guide/install.rst index bd595ae8c..dfe4dc6a0 100644 --- a/doc/user_guide/install.rst +++ b/doc/user_guide/install.rst @@ -2,23 +2,23 @@ .. _install-label: .. warning:: - These installation instructions are pending the release of the first version of exSpy. + These installation instructions are pending the release of the first version of eXSpy. In the meantime, you will need to install the development version, see instructions below. Installation ************ -To install exSpy, you have the following options (independent of the operating system you use): +To install eXSpy, you have the following options (independent of the operating system you use): -1. exSpy is included in the `HyperSpy Bundle `_, +1. eXSpy is included in the `HyperSpy Bundle `_, a standalone program that includes a python distribution and all relevant libraries (recommended if you do not use *python* for anything else). 2. :ref:`conda` (recommended if you are also working with other *python* packages). 3. :ref:`pip`. 4. Installing the development version from `GitHub `_. Refer to the appropriate section in the :external+hyperspy:ref:`HyperSpy user guide - ` (replacing ``hyperspy`` by ``exSpy``). + ` (replacing ``hyperspy`` by ``exspy``). .. _conda: @@ -26,15 +26,15 @@ To install exSpy, you have the following options (independent of the operating s Installation using conda ======================== -Follow these 3 steps to install exSpy using **conda** and start using it. +Follow these 3 steps to install eXSpy using **conda** and start using it. 1. Creating a conda environment ------------------------------- -exSpy requires Python 3 and ``conda`` -- we suggest using the Python 3 version +eXSpy requires Python 3 and ``conda`` -- we suggest using the Python 3 version of `Miniforge `_. -We recommend creating a new environment for the exSpy package (or installing +We recommend creating a new environment for the eXSpy package (or installing it in the :external+hyperspy:ref:`HyperSpy ` environment, if you have one already). To create a new environment: @@ -49,7 +49,7 @@ environment, if you have one already). To create a new environment: 2. Installing the package in the new environment ------------------------------------------------ -Now activate the exSpy environment and install the package from ``conda-forge``: +Now activate the eXSpy environment and install the package from ``conda-forge``: .. code-block:: bash @@ -69,9 +69,9 @@ Installation is completed! To start using it, check the next section. 3. Getting Started ------------------ -To get started using exSpy, especially if you are unfamiliar with Python, we +To get started using eXSpy, especially if you are unfamiliar with Python, we recommend using `Jupyter notebooks `_. Having installed -exSpy as above, a Jupyter notebook can be installed and opened using the following commands +eXSpy as above, a Jupyter notebook can be installed and opened using the following commands entered into an anaconda prompt (from scratch): .. code-block:: bash @@ -86,7 +86,7 @@ entered into an anaconda prompt (from scratch): Installation using pip ====================== -Alternatively, you can also find exSpy in the `Python Package Index (PyPI) `_ +Alternatively, you can also find eXSpy in the `Python Package Index (PyPI) `_ and install it using (requires ``pip``): .. code-block:: bash @@ -113,5 +113,5 @@ Using **pip**: .. Note:: - If you want to be notified about new releases, please *Watch (Releases only)* the `exSpy repository + If you want to be notified about new releases, please *Watch (Releases only)* the `eXSpy repository on GitHub `_ (requires a GitHub account). diff --git a/doc/user_guide/metadata_structure.rst b/doc/user_guide/metadata_structure.rst index f82115a38..cdbaa1a7d 100644 --- a/doc/user_guide/metadata_structure.rst +++ b/doc/user_guide/metadata_structure.rst @@ -1,9 +1,9 @@ .. _metadata_structure: -exSpy Metadata Structure +eXSpy Metadata Structure ************************ -**exSpy** extends the :external+hyperspy:ref:`HyperSpy metadata structure +**eXSpy** extends the :external+hyperspy:ref:`HyperSpy metadata structure ` with conventions for metadata specific to its signal types. Refer to the :external+hyperspy:ref:`HyperSpy metadata documentation ` @@ -125,7 +125,7 @@ Signal signal_type type: string - String that describes the type of signal. Currently, the only exSpy + String that describes the type of signal. Currently, the only eXSpy specific signal class is ``EELS``, ``EDS``, ``EDS_SEM`` or ``EDS_TEM``. See also :external+hyperspy:ref:`HyperSpy-Metadata-Sample `. diff --git a/exspy/__init__.py b/exspy/__init__.py index f3cf1bb7c..121b0ee7e 100644 --- a/exspy/__init__.py +++ b/exspy/__init__.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from importlib.metadata import version from pathlib import Path diff --git a/exspy/_defaults_parser.py b/exspy/_defaults_parser.py index 41b2a7b22..07f0db3d0 100644 --- a/exspy/_defaults_parser.py +++ b/exspy/_defaults_parser.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import configparser import logging diff --git a/exspy/components/eels_arctan.py b/exspy/components/eels_arctan.py index 333d4edea..99b190f5a 100644 --- a/exspy/components/eels_arctan.py +++ b/exspy/components/eels_arctan.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from hyperspy._components.expression import Expression diff --git a/exspy/components/eels_cl_edge.py b/exspy/components/eels_cl_edge.py index 2d82b788d..0e414776f 100644 --- a/exspy/components/eels_cl_edge.py +++ b/exspy/components/eels_cl_edge.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import functools @@ -78,11 +78,11 @@ class EELSCLEdge(Component): https://zenodo.org/record/6599071 while information on the GOSH format are available at: https://gitlab.com/gguzzina/gosh . - exSpy also supports Peter Rez's Hartree Slater cross sections + eXSpy also supports Peter Rez's Hartree Slater cross sections parametrised as distributed by Gatan in their Digital Micrograph (DM) - software. If Digital Micrograph is installed in the system exSpy in the - standard location exSpy should find the path to the HS GOS folder. - Otherwise, the location of the folder can be defined in exSpy + software. If Digital Micrograph is installed in the system eXSpy in the + standard location eXSpy should find the path to the HS GOS folder. + Otherwise, the location of the folder can be defined in eXSpy preferences, which can be done through ~:func:`~.api.preferences.gui` or the :attr:`~api.preferences.EELS.eels_gos_files_path` variable. diff --git a/exspy/components/eels_double_power_law.py b/exspy/components/eels_double_power_law.py index 9d44ca7b7..dd8cb5336 100644 --- a/exspy/components/eels_double_power_law.py +++ b/exspy/components/eels_double_power_law.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/components/eels_vignetting.py b/exspy/components/eels_vignetting.py index b5b7c9cd3..84fb4de0c 100644 --- a/exspy/components/eels_vignetting.py +++ b/exspy/components/eels_vignetting.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/components/pes_core_line_shape.py b/exspy/components/pes_core_line_shape.py index 4f4b62e18..51add6825 100644 --- a/exspy/components/pes_core_line_shape.py +++ b/exspy/components/pes_core_line_shape.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import math diff --git a/exspy/components/pes_see.py b/exspy/components/pes_see.py index 3e65f48db..68445ad55 100644 --- a/exspy/components/pes_see.py +++ b/exspy/components/pes_see.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/components/pes_voigt.py b/exspy/components/pes_voigt.py index de17fe2e2..073e3a148 100644 --- a/exspy/components/pes_voigt.py +++ b/exspy/components/pes_voigt.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import math diff --git a/exspy/components/volume_plasmon_drude.py b/exspy/components/volume_plasmon_drude.py index 9d3b60def..751459f82 100644 --- a/exspy/components/volume_plasmon_drude.py +++ b/exspy/components/volume_plasmon_drude.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/conftest.py b/exspy/conftest.py index 12e1ae351..175717ab6 100644 --- a/exspy/conftest.py +++ b/exspy/conftest.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . try: # Set traits toolkit to work in a headless system diff --git a/exspy/data/__init__.py b/exspy/data/__init__.py index da919842d..5e1ee1089 100644 --- a/exspy/data/__init__.py +++ b/exspy/data/__init__.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import functools from pathlib import Path diff --git a/exspy/docstrings/model.py b/exspy/docstrings/model.py index 2a90ae712..847adbe34 100644 --- a/exspy/docstrings/model.py +++ b/exspy/docstrings/model.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . """Common docstring snippets for model. diff --git a/exspy/misc/eds/eds.py b/exspy/misc/eds/eds.py index cf4db0b11..5b0e0e764 100644 --- a/exspy/misc/eds/eds.py +++ b/exspy/misc/eds/eds.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from exspy.misc.eds.utils import ( diff --git a/exspy/misc/eds/utils.py b/exspy/misc/eds/utils.py index 559ea7818..2d023f417 100644 --- a/exspy/misc/eds/utils.py +++ b/exspy/misc/eds/utils.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/misc/eels/base_gos.py b/exspy/misc/eels/base_gos.py index 1c6471b1b..49f045d00 100644 --- a/exspy/misc/eels/base_gos.py +++ b/exspy/misc/eels/base_gos.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import math diff --git a/exspy/misc/eels/eelsdb.py b/exspy/misc/eels/eelsdb.py index e4c003efb..ce0cb92e5 100644 --- a/exspy/misc/eels/eelsdb.py +++ b/exspy/misc/eels/eelsdb.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . """This module provides tools to interact with The EELS Database.""" @@ -255,7 +255,7 @@ def eelsdb( if "message" in jsons: # Invalid query, EELSdb raises error. raise IOError( - "Please report the following error to the exSpy developers: " + "Please report the following error to the eXSpy developers: " f"{jsons['message']}." ) diff --git a/exspy/misc/eels/effective_angle.py b/exspy/misc/eels/effective_angle.py index 94fcde51d..dabbf1944 100644 --- a/exspy/misc/eels/effective_angle.py +++ b/exspy/misc/eels/effective_angle.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import math diff --git a/exspy/misc/eels/electron_inelastic_mean_free_path.py b/exspy/misc/eels/electron_inelastic_mean_free_path.py index 003e65a1c..d9fa9b231 100644 --- a/exspy/misc/eels/electron_inelastic_mean_free_path.py +++ b/exspy/misc/eels/electron_inelastic_mean_free_path.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/misc/eels/gosh_gos.py b/exspy/misc/eels/gosh_gos.py index dd0a12380..122d2e794 100644 --- a/exspy/misc/eels/gosh_gos.py +++ b/exspy/misc/eels/gosh_gos.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import logging diff --git a/exspy/misc/eels/hartree_slater_gos.py b/exspy/misc/eels/hartree_slater_gos.py index bfed4be03..c622416fe 100644 --- a/exspy/misc/eels/hartree_slater_gos.py +++ b/exspy/misc/eels/hartree_slater_gos.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import logging from pathlib import Path diff --git a/exspy/misc/eels/hydrogenic_gos.py b/exspy/misc/eels/hydrogenic_gos.py index 3ea56ca7d..1980eea87 100644 --- a/exspy/misc/eels/hydrogenic_gos.py +++ b/exspy/misc/eels/hydrogenic_gos.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import math import logging diff --git a/exspy/misc/eels/tools.py b/exspy/misc/eels/tools.py index e7ec11b88..d487b7bee 100644 --- a/exspy/misc/eels/tools.py +++ b/exspy/misc/eels/tools.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import math import numbers @@ -207,7 +207,7 @@ def estimate_variance_parameters( noisy_signal.metadata.set_item( "Signal.Noise_properties.Variance_linear_model." + "parameters_estimation_method", - "exSpy", + "eXSpy", ) if return_results is True: diff --git a/exspy/misc/elements.py b/exspy/misc/elements.py index 81a46be28..a8f3cd153 100644 --- a/exspy/misc/elements.py +++ b/exspy/misc/elements.py @@ -4338,7 +4338,7 @@ elements_db = DictionaryTreeBrowser(elements) -# read dictionary of atomic numbers from exSpy, and add the elements that +# read dictionary of atomic numbers from eXSpy, and add the elements that # do not currently exist in the database (in case anyone is doing EDS on # Ununpentium...) atomic_number2name = dict((p.General_properties.Z, e) diff --git a/exspy/misc/material.py b/exspy/misc/material.py index de068afee..071b458a7 100644 --- a/exspy/misc/material.py +++ b/exspy/misc/material.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from collections.abc import Iterable import numpy as np diff --git a/exspy/models/edsmodel.py b/exspy/models/edsmodel.py index e2657ba7e..f2c08ff28 100644 --- a/exspy/models/edsmodel.py +++ b/exspy/models/edsmodel.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from __future__ import division diff --git a/exspy/models/edssemmodel.py b/exspy/models/edssemmodel.py index 3d720bb50..f05a7ec24 100644 --- a/exspy/models/edssemmodel.py +++ b/exspy/models/edssemmodel.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from exspy.models.edsmodel import EDSModel diff --git a/exspy/models/edstemmodel.py b/exspy/models/edstemmodel.py index 1e07c2a79..d64b69e63 100644 --- a/exspy/models/edstemmodel.py +++ b/exspy/models/edstemmodel.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from exspy.models.edsmodel import EDSModel diff --git a/exspy/models/eelsmodel.py b/exspy/models/eelsmodel.py index 2b413ace6..b6b6a8d8d 100644 --- a/exspy/models/eelsmodel.py +++ b/exspy/models/eelsmodel.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import copy import logging diff --git a/exspy/signals/__init__.py b/exspy/signals/__init__.py index cf60e926f..6b0d65889 100644 --- a/exspy/signals/__init__.py +++ b/exspy/signals/__init__.py @@ -1,5 +1,5 @@ """ -Modules containing the exSpy signals and their lazy counterparts. +Modules containing the eXSpy signals and their lazy counterparts. EELSSpectrum For electron energy-loss data with ``signal_dimension`` equal one, i.e. diff --git a/exspy/signals/dielectric_function.py b/exspy/signals/dielectric_function.py index b6bdf2699..eb05c45ad 100644 --- a/exspy/signals/dielectric_function.py +++ b/exspy/signals/dielectric_function.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np from scipy import constants diff --git a/exspy/signals/eds.py b/exspy/signals/eds.py index da088ef6f..f890be523 100644 --- a/exspy/signals/eds.py +++ b/exspy/signals/eds.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import itertools import logging diff --git a/exspy/signals/eds_sem.py b/exspy/signals/eds_sem.py index 59714d284..15d7e85c8 100644 --- a/exspy/signals/eds_sem.py +++ b/exspy/signals/eds_sem.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import logging diff --git a/exspy/signals/eds_tem.py b/exspy/signals/eds_tem.py index e5639469b..dd2acaa80 100755 --- a/exspy/signals/eds_tem.py +++ b/exspy/signals/eds_tem.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import warnings diff --git a/exspy/signals/eels.py b/exspy/signals/eels.py index 036cce7c9..c70dbdd72 100644 --- a/exspy/signals/eels.py +++ b/exspy/signals/eels.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numbers import logging diff --git a/exspy/tests/components/test_EELSarctan.py b/exspy/tests/components/test_EELSarctan.py index 55d7d20b2..86f7b9bde 100644 --- a/exspy/tests/components/test_EELSarctan.py +++ b/exspy/tests/components/test_EELSarctan.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/tests/components/test_ceels_cl_edge.py b/exspy/tests/components/test_ceels_cl_edge.py index 5dbb1aec5..dccad8723 100644 --- a/exspy/tests/components/test_ceels_cl_edge.py +++ b/exspy/tests/components/test_ceels_cl_edge.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . def test_eels_cl_edge(): diff --git a/exspy/tests/components/test_double_power_law.py b/exspy/tests/components/test_double_power_law.py index bde908c3d..58c4b0b4d 100644 --- a/exspy/tests/components/test_double_power_law.py +++ b/exspy/tests/components/test_double_power_law.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import pytest diff --git a/exspy/tests/components/test_pes_core_line_shape.py b/exspy/tests/components/test_pes_core_line_shape.py index 914f1d3c8..1facb84e4 100644 --- a/exspy/tests/components/test_pes_core_line_shape.py +++ b/exspy/tests/components/test_pes_core_line_shape.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import pytest diff --git a/exspy/tests/components/test_pes_see.py b/exspy/tests/components/test_pes_see.py index b3506bb1f..4f4363a49 100644 --- a/exspy/tests/components/test_pes_see.py +++ b/exspy/tests/components/test_pes_see.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/tests/components/test_pes_voigt.py b/exspy/tests/components/test_pes_voigt.py index de3025182..d77a45d55 100644 --- a/exspy/tests/components/test_pes_voigt.py +++ b/exspy/tests/components/test_pes_voigt.py @@ -1,21 +1,21 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import itertools diff --git a/exspy/tests/components/test_volume_plasmon_drude.py b/exspy/tests/components/test_volume_plasmon_drude.py index 506bdb747..87abf3a24 100644 --- a/exspy/tests/components/test_volume_plasmon_drude.py +++ b/exspy/tests/components/test_volume_plasmon_drude.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/tests/data/test_data.py b/exspy/tests/data/test_data.py index b5e690a02..724bf9fbc 100644 --- a/exspy/tests/data/test_data.py +++ b/exspy/tests/data/test_data.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import pytest diff --git a/exspy/tests/data/test_eelsdb.py b/exspy/tests/data/test_eelsdb.py index f8d1f5040..6cdc43eb7 100644 --- a/exspy/tests/data/test_eelsdb.py +++ b/exspy/tests/data/test_eelsdb.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import warnings diff --git a/exspy/tests/drawing/test_plot_model.py b/exspy/tests/drawing/test_plot_model.py index b76a463f4..4b1a8d500 100644 --- a/exspy/tests/drawing/test_plot_model.py +++ b/exspy/tests/drawing/test_plot_model.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The HyperSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of HyperSpy. +# This file is part of eXSpy. # -# HyperSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# HyperSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with HyperSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import pytest diff --git a/exspy/tests/misc/test_eds.py b/exspy/tests/misc/test_eds.py index 51a170b4d..db250c903 100644 --- a/exspy/tests/misc/test_eds.py +++ b/exspy/tests/misc/test_eds.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/tests/misc/test_eds_utils.py b/exspy/tests/misc/test_eds_utils.py index 02eec2ff9..08888807c 100644 --- a/exspy/tests/misc/test_eds_utils.py +++ b/exspy/tests/misc/test_eds_utils.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import pytest diff --git a/exspy/tests/misc/test_eels.py b/exspy/tests/misc/test_eels.py index 7aebc2d00..fc202b2f4 100644 --- a/exspy/tests/misc/test_eels.py +++ b/exspy/tests/misc/test_eels.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import pytest diff --git a/exspy/tests/misc/test_gos.py b/exspy/tests/misc/test_gos.py index 3e53fcdf3..dccb8bc0c 100644 --- a/exspy/tests/misc/test_gos.py +++ b/exspy/tests/misc/test_gos.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from pathlib import Path diff --git a/exspy/tests/misc/test_material.py b/exspy/tests/misc/test_material.py index d9d1b7173..7b5a2927e 100644 --- a/exspy/tests/misc/test_material.py +++ b/exspy/tests/misc/test_material.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import pytest diff --git a/exspy/tests/models/test_edsmodel.py b/exspy/tests/models/test_edsmodel.py index ea711246d..7df158fe3 100644 --- a/exspy/tests/models/test_edsmodel.py +++ b/exspy/tests/models/test_edsmodel.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import pytest diff --git a/exspy/tests/models/test_eelsmodel.py b/exspy/tests/models/test_eelsmodel.py index 8ebbb2681..008baed93 100644 --- a/exspy/tests/models/test_eelsmodel.py +++ b/exspy/tests/models/test_eelsmodel.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import contextlib import io diff --git a/exspy/tests/models/test_linear_model.py b/exspy/tests/models/test_linear_model.py index e7e75f14c..2382ee60e 100644 --- a/exspy/tests/models/test_linear_model.py +++ b/exspy/tests/models/test_linear_model.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import pytest diff --git a/exspy/tests/signals/test_binned.py b/exspy/tests/signals/test_binned.py index 6d597c8b5..7eacbdec5 100644 --- a/exspy/tests/signals/test_binned.py +++ b/exspy/tests/signals/test_binned.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np import hyperspy.api as hs diff --git a/exspy/tests/signals/test_edges_range.py b/exspy/tests/signals/test_edges_range.py index 6c89032f1..2e0d3a57b 100644 --- a/exspy/tests/signals/test_edges_range.py +++ b/exspy/tests/signals/test_edges_range.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . from copy import deepcopy import numpy as np diff --git a/exspy/tests/signals/test_eds_sem.py b/exspy/tests/signals/test_eds_sem.py index c177c72e8..1e280d3d2 100644 --- a/exspy/tests/signals/test_eds_sem.py +++ b/exspy/tests/signals/test_eds_sem.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import pytest diff --git a/exspy/tests/signals/test_eds_tem.py b/exspy/tests/signals/test_eds_tem.py index 50f92348f..cb37bd5d1 100644 --- a/exspy/tests/signals/test_eds_tem.py +++ b/exspy/tests/signals/test_eds_tem.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import warnings diff --git a/exspy/tests/signals/test_eels.py b/exspy/tests/signals/test_eels.py index 98f54c709..de3c7be01 100644 --- a/exspy/tests/signals/test_eels.py +++ b/exspy/tests/signals/test_eels.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/tests/signals/test_kramers_kronig_transform.py b/exspy/tests/signals/test_kramers_kronig_transform.py index 07c13523e..43223278d 100644 --- a/exspy/tests/signals/test_kramers_kronig_transform.py +++ b/exspy/tests/signals/test_kramers_kronig_transform.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import numpy as np diff --git a/exspy/tests/test_non-uniform_not-implemented.py b/exspy/tests/test_non-uniform_not-implemented.py index e6b7f6a22..cc067fee9 100644 --- a/exspy/tests/test_non-uniform_not-implemented.py +++ b/exspy/tests/test_non-uniform_not-implemented.py @@ -1,20 +1,20 @@ # -*- coding: utf-8 -*- -# Copyright 2007-2023 The exSpy developers +# Copyright 2007-2024 The eXSpy developers # -# This file is part of exSpy. +# This file is part of eXSpy. # -# exSpy is free software: you can redistribute it and/or modify +# eXSpy is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # -# exSpy is distributed in the hope that it will be useful, +# eXSpy is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License -# along with exSpy. If not, see . +# along with eXSpy. If not, see . import pytest diff --git a/releasing_guide.md b/releasing_guide.md index 2524ea949..5eb46383f 100644 --- a/releasing_guide.md +++ b/releasing_guide.md @@ -1,6 +1,6 @@ -# Releasing a new exSpy version +# Releasing a new eXSpy version -To publish a new exSpy release do the following steps: +To publish a new eXSpy release do the following steps: ## Preparation @@ -14,10 +14,10 @@ To publish a new exSpy release do the following steps: ## Tag and Release -- Create a tag e.g. `git tag -a v0.1.1 -m "exSpy version 0.1.1"` +- Create a tag e.g. `git tag -a v0.1.1 -m "eXSpy version 0.1.1"` - Push tag to user fork for a test run `git push origin v0.1.1`. Will run the release workflow without uploading to PyPi -- Push tag to exSpy repository to trigger release `git push upstream v0.1.1` +- Push tag to eXSpy repository to trigger release `git push upstream v0.1.1` (this triggers the GitHub action to create the sdist and wheel and upload to PyPi automatically). :warning: this is a point of no return :warning: diff --git a/upcoming_changes/22.doc.rst b/upcoming_changes/22.doc.rst new file mode 100644 index 000000000..f96c0720a --- /dev/null +++ b/upcoming_changes/22.doc.rst @@ -0,0 +1 @@ +Add eXSpy logo and adapt spelling to capital X diff --git a/upcoming_changes/README.rst b/upcoming_changes/README.rst new file mode 100644 index 000000000..18adee129 --- /dev/null +++ b/upcoming_changes/README.rst @@ -0,0 +1,36 @@ +This directory contains "news fragments" which are short files that contain a small **ReST**-formatted +text that will be added to the next ``CHANGELOG``. + +The ``CHANGELOG`` will be read by **users**, so this description should be aimed to eXSpy users +instead of describing internal changes which are only relevant to the developers. + +Each file should be named like ``..rst``, where +```` is an issue number, and ```` is one of: + +* ``new``: new user facing features, like new command-line options and new behavior. +* ``bugfix``: fixes a bug. +* ``doc``: documentation improvement, like rewording an entire session or adding missing docs. +* ``deprecation``: feature deprecation. +* ``enhancements``: improvement of existing functionality, usually without requiring user intervention. +* ``api``: a change which may break an existing script, such as feature removal or behavior change. +* ``maintenance``: a change related to the test suite, packaging, etc. + +So for example ``1412.new.rst`` or ``2773.bugfix.rst``. + +If your PR fixes an issue, use the number of the issue here. If there is no issue, +then after you submit the PR and get the PR number you can add a +changelog using that instead. + +If you are not sure what issue type to use, don't hesitate to ask in your PR. + +``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries +other than ``new`` it is usually better to stick to a single paragraph to keep it concise. For ``new``, +it is recommended to add a hyperlink to the user guide. + +To make a draft of the changelog, run from the command line: + + .. code-block:: bash + + $ towncrier build --draft + +See https://github.com/twisted/towncrier for more details.