Add Logo

.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
 

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
   <https://github.com/hyperspy/hyperspy>`_ 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 <https://github.com/hyperspy/exspy>`_.
+  `eXSpy repository <https://github.com/hyperspy/exspy>`_.

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 <https://github.com/hyperspy/exspy/pulls>`_. 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
   <https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_
@@ -54,7 +54,7 @@ The exSpy documentation consists of three elements:
   <https://www.sphinx-doc.org>`_ and hosted on `Read the Docs
   <https://exspy.readthedocs.io>`_. The source is part of the `GitHub repository
   <https://github.com/hyperspy/exspy/tree/main/doc>`_.
-- Jupyter notebooks in the `exSpy demos repository
+- Jupyter notebooks in the `eXSpy demos repository
   <https://github.com/hyperspy/exspy-demos>`_ 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 <https://www.python.org/dev/peps/pep-0008/>`_
+eXSpy follows `Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_
 with `The Black Code style
 <https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html>`_.
 
@@ -81,17 +81,17 @@ them:
 Writing tests
 =============
 
-All functionality in exSpy is tested via the `pytest <https://docs.pytest.org>`_
+All functionality in eXSpy is tested via the `pytest <https://docs.pytest.org>`_
 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
 <https://hyperspy.org/hyperspy-doc/current/dev_guide/testing.html>`_ for further
 information on tests.
 
 Releasing a new version
 =======================
 
-exSpy versioning follows `semantic versioning <https://semver.org/spec/v2.0.0.html>`_
+eXSpy versioning follows `semantic versioning <https://semver.org/spec/v2.0.0.html>`_
 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:
 

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).