Finalize documentation for 0.1.0 (#17)

Improve consistency and formatting of docs.

Author: adriesse

README.md

@@ -1,6 +1,6 @@
 # PV Performance Labs Tools for Python
 
-Useful tools for photovoltaics and beyond!
+*Useful tools for photovoltaics and beyond!*
 
 <p align="left">
   <table>
@@ -36,11 +36,13 @@ Useful tools for photovoltaics and beyond!
   </table>
 </p>
 
-Latest news
------------
-2024-02-13: More proof that these tools are useful!  The module efficiency functions were put to good use in [this new study by Lelia Deville and her colleagues][101]:
+This package, **pvpltools**, makes available a collection of useful
+software components and functions created by Anton Driesse of PV Performance Labs.
+Many were developed in the context of consulting or research projects,
+sometimes as a necessity, and sometimes just to make life easier.
 
-[101]: https://doi.org/10.1002/pip.3763
+The aim of this package is to make life easier for people facing similar needs
+and thereby, in a small way, support the accelerated deployment of photovoltaic power systems.
 
 
 Copyright
@@ -58,46 +60,47 @@ GPL-3.0, but feel free to let me know if that causes any problems!
 Citing
 ------
 
-When referring to this software in either academic or commercial context,
+When referring to this software in an academic or commercial context,
 please use a citation similar to the following:
 
-- A. Driesse,
-"PV Performance Labs Tools for Python", (2020), GitHub repository,  https://github.com/pvplabs/pvpltools
+  A. Driesse,
+  "PV Performance Labs Tools for Python", (2025), GitHub repository,
+  https://github.com/pvplabs/pvpltools
 
 When referring to specific functions, docs strings or algorithms,
 please add specifics to the citation.
-
-The following report introduces the new ADR PV module efficiency model
-and compares it to the IEC 61853 efficiency matrix interpolation/extrapolation method as well as several other published models:
-
-- Driesse, Anton, & Stein, Joshua.
-  "From IEC 61853 power measurements to PV system simulations."
-  SAND2020-3877, Sandia National Laboratories, Albuquerque, NM, 2020. [doi:10.2172/1615179.][102]
-
-[102]: https://pvpmc.sandia.gov/download/7737/
-
-Additional publications related to the contents of pvpltools
-will be listed here as they become available.
+Docstrings also contain references to relevant publications.
 
 
 Acknowledgements
 ----------------
 
-The contents of this repository have been developed
-before, during or after various projects; as a product or byproduct;
-with funding in whole, in part, or not at all.
+Parts of this repository have been developed
+in the context of consulting or research projects,
+sometimes as a necessity, and sometimes just to make life easier.
+
+The development of this package has not been funded directly,
+but I nevertheless want to acknowledge research project funding
+and/or encouragement to publish open source code
+from the following organizations:
+
+ - Sandia National Laboratories
+ - United States Department of Energy
+ - Fraunhofer Institute for Solar Energy
+ - German Aerospace Center
+ - German Ministry for Economic Affairs and Climate Action
 
-I would like to acknowledge Sandia National Labs and the US DOE for
-substantial project funding as well encouragement to publish open source code.
 
 I also acknowledge and thank all the contributors to pvlib-python,
-parts of which I use very frequently in the context of my work.
+parts of which I use frequently in the context of my work.
 
 
 Getting help
 ------------
 
-The doc strings within the code are currently the primary source of documentation.
+The first place to look is https://pvpltools.readthedocs.io/en/latest/.
+If it's not adequately explained there, have a look at
+the source code--if you're a user, you must be a programmer!
+Still confused? Send me an email.
 
-Feel free to contact me with questions or suggestions though.
 For commercial use, extended support and related services are available.

README_PYPI.md

@@ -2,21 +2,17 @@
 
 *Useful tools for photovoltaics and beyond!*
 
-This package, ``pvpltools``, makes available a collection of useful
+This package, **pvpltools**, makes available a collection of useful
 software components and functions created by Anton Driesse of PV Performance Labs.
 Many were developed in the context of consulting or research projects,
 sometimes as a necessity, and sometimes just to make life easier.
 
 The aim of this package is to make life easier for people facing similar needs
 and thereby, in a small way, support the accelerated deployment of photovoltaic power systems.
 
-The current version of this package is found in the GitHub repository
-`pvplabs/pvpltools <https://github.com/pvplabs/pvpltools>`_ .
-Prior to 2024, the code was made available in
-`adriesse/pvpltools-python <https://github.com/adriesse/pvpltools-python>`_ .
+The current version of this package is found at https://github.com/pvplabs/pvpltools.
+Prior to 2024, the code was made available at https://github.com/adriesse/pvpltools-python.
 This older repository will remain in place, but will not be updated.
 
-``pvpltools`` is compatible with and complementary to
-`pvlib python <https://pvlib-python.readthedocs.io>`_.
-
-
+**pvpltools** is compatible with and complementary to
+**pvlib python** (https://pvlib-python.readthedocs.io).

docs/api_reference/iec61853.rst

@@ -10,16 +10,24 @@ described in standard IEC 61853.
 
 The four main calculation steps are:
 
-1. Calculate the angle-of-incidence correction using the functions:
-    - martin_ruiz()
-    - martin_ruiz_diffuse()
-2. Evaluate the spectral factor using the functions:
-    - convert_to_banded()
-    - calc_spectral_factor()
-3. Estimate the operating temperature using the function:
-    - faiman()
-4. Determine the module efficiency using the class:
-    - BilinearInterpolator()
+#. Calculate the angle-of-incidence correction using the functions:
+
+   * martin_ruiz()
+   * martin_ruiz_diffuse()
+
+#. Evaluate the spectral factor using the functions:
+
+   * convert_to_banded()
+   * calc_spectral_factor()
+
+#. Estimate the operating temperature using the function:
+
+   * faiman()
+
+#. Determine the module efficiency using the class:
+
+   * BilinearInterpolator()
+
 
 .. autosummary::
    :toctree: generated/

docs/index.rst

@@ -3,7 +3,7 @@ PV Performance Labs Tools for Python
 
 *Useful tools for photovoltaics and beyond!*
 
-This package, ``pvpltools``, makes available a collection of useful
+This package, **pvpltools**, makes available a collection of useful
 software components and functions created by Anton Driesse of PV Performance Labs.
 Many were developed in the context of consulting or research projects,
 sometimes out of necessity, and sometimes just to make life easier.
@@ -17,7 +17,7 @@ Prior to 2024, the code was made available in
 `adriesse/pvpltools-python <https://github.com/adriesse/pvpltools-python>`_ .
 This older repository will remain in place, but will not be updated.
 
-``pvpltools`` is compatible with and complementary to
+**pvpltools** is compatible with and complementary to
 `pvlib python <https://pvlib-python.readthedocs.io>`_.
 
 

docs/user_guide/installation.rst

@@ -1,13 +1,18 @@
 Installation
 ============
+**pvpltools** needs some commonly used packages like NumPy, SciPy and pandas.
+Some functions also depend on pvlib or ruamel.yaml and
+the examples use Matplotlib and OpenPyXL (indirectly).
 
-``pvpltools`` needs some commonly used packages like ``numpy``, ``scipy`` and ``pandas``.
-Some functions also depend on ``pvlib`` or ``ruamel.yaml``.
-The examples use ``matplotlib`` and ``openpyxl`` (indirectly).
 
-
-To install ``pvpltools`` from PyPI, run:
+To install **pvpltools** from PyPI, run:
 
 .. code-block:: bash
 
     pip install pvpltools
+
+To update an existing installation, run:
+
+.. code-block:: bash
+
+    pip install -U pvpltools

docs/whatsnews/0.1.0a.rst

@@ -1,4 +1,4 @@
-v0.1.0a1 - v0.1.0a3
+v0.1.0a1 - v0.1.0a5
 -------------------
 
 - First alpha releases of the package through PyPI.