From b963c2038b2a1ea42be402160de2293097157bc1 Mon Sep 17 00:00:00 2001 From: jason-writer <338988799+jason-writer@users.noreply.github.com> Date: Thu, 8 Oct 2026 12:57:47 +0530 Subject: [PATCH] docs: standardize naming, voice, and styling consistency in README --- README.md | 59 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 38d6e3ad2e..b9f5525b10 100644 --- a/README.md +++ b/README.md @@ -58,22 +58,22 @@ -pvlib python is a community developed toolbox that provides a set of +pvlib-python is a community-developed toolbox that provides a set of functions and classes for simulating the performance of photovoltaic -energy systems and accomplishing related tasks. The core mission of pvlib python is to provide open, +energy systems and accomplishing related tasks. The core mission of pvlib-python is to provide open, reliable, interoperable, and benchmark implementations of PV system models. Documentation ============= -Full documentation can be found at [readthedocs](http://pvlib-python.readthedocs.io/en/stable/), -including an [FAQ](https://pvlib-python.readthedocs.io/en/stable/user_guide/extras/faq.html) page. +View the full documentation on [Read the Docs](http://pvlib-python.readthedocs.io/en/stable/), +which includes an [FAQ](https://pvlib-python.readthedocs.io/en/stable/user_guide/extras/faq.html) page. Installation ============ -pvlib-python releases may be installed using the ``pip`` and ``conda`` tools. +Install pvlib-python releases using the `pip` and `conda` tools. ```bash pip install pvlib conda install -c conda-forge pvlib @@ -92,49 +92,49 @@ The long-term success of pvlib-python requires substantial community support. Citing ====== -Many of the contributors to pvlib python work in institutions where +Many of the contributors to pvlib-python work in institutions where citation metrics are used in performance or career evaluations. If you -use pvlib python in a published work, please cite: +use pvlib-python in a published work, please cite: -**Recommended citation for the pvlib python project** +**Recommended citation for the pvlib-python project** Anderson, K., Hansen, C., Holmgren, W., Jensen, A., Mikofski, M., and Driesse, A. - "pvlib python: 2023 project update." - Journal of Open Source Software, 8(92), 5994, (2023). + "pvlib-python: 2023 project update." + Journal of Open Source Software, 8(92), 5994 (2023). https://doi.org/10.21105/joss.05994 -**Recommended citation for pvlib iotools** +**Recommended citation for pvlib-iotools** Jensen, A., Anderson, K., Holmgren, W., Mikofski, M., Hansen, C., Boeman, L., Loonen, R. - "pvlib iotools —- Open-source Python functions for seamless access to solar irradiance data." + "pvlib-iotools —- Open-source Python functions for seamless access to solar irradiance data." Solar Energy, 266, 112092, (2023). https://doi.org/10.1016/j.solener.2023.112092 -**Historical citation for pvlib python** +**Historical citation for pvlib-python** Holmgren, W., Hansen, C., and Mikofski, M. - "pvlib python: a python package for modeling solar energy systems." - Journal of Open Source Software, 3(29), 884, (2018). + "pvlib-python: a Python package for modeling solar energy systems." + Journal of Open Source Software, 3(29), 884 (2018). https://doi.org/10.21105/joss.00884 -If you use pvlib-python in a commercial or publicly-available application, please -consider displaying one of the "powered by pvlib" logos: +If you use pvlib-python in a commercial or publicly available application, please +consider displaying one of the "powered by Pvlib" logos: Getting support =============== -pvlib usage questions can be asked on -[Stack Overflow](http://stackoverflow.com) and tagged with +Ask pvlib usage questions on +[Stack Overflow](http://stackoverflow.com) and use the [pvlib](http://stackoverflow.com/questions/tagged/pvlib) tag. -The [pvlib-python google group](https://groups.google.com/forum/#!forum/pvlib-python) -is used for discussing various topics of interest to the pvlib-python -community. We also make new version announcements on the google group. +Join the [pvlib-python Google Group](https://groups.google.com/forum/#!forum/pvlib-python) +to discuss various topics of interest to the +community and to receive new version announcements. -If you suspect that you may have discovered a bug or if you'd like to +If you think you found a bug, or if you want to change something about pvlib, then please make an issue on our [GitHub issues page](https://github.com/pvlib/pvlib-python/issues). @@ -149,19 +149,18 @@ BSD 3-clause. History and acknowledgement =========================== -pvlib python began in 2013 as a Python translation of the [PVLIB for Matlab](https://github.com/sandialabs/MATLAB_PV_LIB) -toolbox developed by Sandia National Laboratories. pvlib python has grown substantially since then. -Today it contains code contributions from over a hundred individuals worldwide -and is maintained by a core group of PV modelers from a variety of institutions. +pvlib-python began in 2013 as a Python translation of the [PVLIB for Matlab](https://github.com/sandialabs/MATLAB_PV_LIB) +toolbox developed by Sandia National Laboratories. pvlib-python has grown substantially since then. +Today it contains code contributions from over a hundred individuals worldwide and is maintained by a core group of PV modelers from a variety of institutions. -pvlib has been supported directly and indirectly by DOE, NumFOCUS, and +`pvlib` has been supported directly and indirectly by DOE, NumFOCUS, and Google Summer of Code funding, university research projects, -companies that allow their employees to contribute, and from personal time. +company employee contributions, and personal time. NumFOCUS ======== -pvlib python is a [NumFOCUS Affiliated Project](https://numfocus.org/sponsored-projects/affiliated-projects) +pvlib-python is a [NumFOCUS Affiliated Project](https://numfocus.org/sponsored-projects/affiliated-projects) [![NumFocus Affliated Projects](https://i0.wp.com/numfocus.org/wp-content/uploads/2019/06/AffiliatedProject.png)](https://numfocus.org/sponsored-projects/affiliated-projects)