DOC: Expand documentation on the reasons for the existence of envector.

CHANGELOG.rst

@@ -24,10 +24,12 @@ Matt Hogan (4)
     * Added local testing support using nox.
     * Remove numpydoc from the documentation requirements as it is not used.
 
-Version 0.3.1, September 10, 2024
+Version 0.3.1, September 11, 2024
 =================================
-Matt Hogan (4)
-    * Embraced 3.9+ support with more descriptive static typing
-    * Expanded or added docstrings
+Matt Hogan (6)
+    * Embraced 3.9+ support with more descriptive static typing.
+    * Expanded or added docstrings.
     * Fixed some pytest failures associated with matplotlib opening multiple figures simultaneously.
-    * Added missing figures to the documentation
+    * Added missing figures to the documentation.
+    * Updated the noxfile to support multiple virtual environment backends.
+    * Expand documentation on the reasons for the existence of envector.

README.rst

@@ -7,7 +7,7 @@ envector
 
 
 The envector library is a suite of tools written in Python to solve geographical position calculations. This is
-an open-source fork of the original nvector_ Python package based on the MATLAB nvector toolbox_.
+an open-source fork of the original nvector_ Python package based on the MATLAB nvector `MATLAB n-vector toolbox`_.
 
 Currently the following operations are implemented:
 
@@ -39,20 +39,27 @@ If you are coming from the nvector_ package, these Q-and-A can quickly explain t
     * If your Python software worked with nvector_, then there is a good chance envector_ will also work. The caveats
       are that this package abandons Python2 and extends to Python3.9+ support.
 
-2. *Why did you fork nvector*?
+2. *Why did you call this package "envector"*?
+
+    * The name honors the original nvector_ Python package and the progenitor `MATLAB n-vector toolbox`_. There are
+      adaptations in other languages as noted in the `nvector downloads`_ page.
+    * The names nvector_ and envector_ are homophones (pronounced the same), so the name invokes the original n-vector
+      origin.
+
+3. *Why did you fork nvector*?
 
     * Primarily because the nvector_ Python package is broken with NumPy version 2.
     * There is no indication that the situation will change.
 
-3. *What changes are there with from nvector*?
+4. *What changes are there with from nvector*?
 
     * Any place there is a `import nvector` or `from nvector` statement, replace it with `import envector` or
       `from envector`, respectively.
     * The envector_ package is a Python3-only package as it embraces type-hints in most cases.
     * Documentation is expanded in some cases.
     * The docstrings have been refactored to utilize the Napoleon docstring style.
 
-4. *When is the appropriate to switch to envector*?
+5. *When is the appropriate to switch to envector*?
 
     * If your Python software must support NumPy version 2,
     * If your Python software also stops supporting Python versions after its end-of-life cycle.
@@ -619,7 +626,8 @@ to do the calculations.
 
 .. _nvector: https://github.com/pbrod/nvector
 .. _envector: https://github.com/mhogan-nwra/envector
-.. _toolbox: http://www.navlab.net/nvector/#download>
+.. _nvector downloads: https://www.ffi.no/en/research/n-vector/n-vector-downloads
+.. _MATLAB n-vector toolbox: https://github.com/FFI-no/n-vector
 .. |pkg_img| image:: https://badge.fury.io/py/envector.svg
    :target: https://pypi.python.org/pypi/envector/
 .. |docs_img| image:: https://readthedocs.org/projects/pip/badge/?version=stable

docs/index.rst

@@ -26,20 +26,27 @@ If you are coming from the nvector_ package, these Q-and-A can quickly explain t
     * If your Python software worked with nvector_, then there is a good chance envector_ will also work. The caveats
       are that this package abandons Python2 and extends to Python3.9+ support.
 
-2. *Why did you fork nvector*?
+2. *Why did you call this package "envector"*?
+
+    * The name honors the original nvector_ Python package and the progenitor `MATLAB n-vector toolbox`_. There are
+      adaptations in other languages as noted in the `nvector downloads`_ page.
+    * The names nvector_ and envector_ are homophones (pronounced the same), so the name invokes the original n-vector
+      origin.
+
+3. *Why did you fork nvector*?
 
     * Primarily because the nvector_ Python package is broken with NumPy version 2.
     * There is no indication that the situation will change.
 
-3. *What changes are there with from nvector*?
+4. *What changes are there with from nvector*?
 
     * Any place there is a `import nvector` or `from nvector` statement, replace it with `import envector` or
       `from envector`, respectively.
     * The envector_ package is a Python3-only package as it embraces type-hints in most cases.
     * Documentation is expanded in some cases.
     * The docstrings have been refactored to utilize the Napoleon docstring style.
 
-4. *When is the appropriate to switch to envector*?
+5. *When is the appropriate to switch to envector*?
 
     * If your Python software must support NumPy version 2,
     * If your Python software also stops supporting Python versions after its end-of-life cycle.
@@ -80,4 +87,5 @@ If you are coming from the nvector_ package, these Q-and-A can quickly explain t
 
 .. _envector: https://github.com/mhogan-nwra/envector
 .. _nvector: https://github.com/pbrod/nvector
-.. _toolbox: http://www.navlab.net/nvector/#download>
+.. _nvector downloads: https://www.ffi.no/en/research/n-vector/n-vector-downloads
+.. _MATLAB n-vector toolbox: https://github.com/FFI-no/n-vector