diff --git a/README.md b/README.md index c80f1c7acf..02cebc0ea0 100644 --- a/README.md +++ b/README.md @@ -145,9 +145,8 @@ BSD 3-clause. History and acknowledgement =========================== -pvlib python started out as a Python translation of the PVLIB MATLAB -toolbox (developed by the [PVPMC](https://pvpmc.sandia.gov/) at -Sandia National Laboratories) in 2013 and has grown substantially since then. +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. diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index d60d4fcaeb..bea339dde4 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -31,10 +31,6 @@ pvlib-python, git, or Python: * Improve the documentation and the unit tests. * Improve the IPython/Jupyter Notebook tutorials or write new ones that demonstrate how to use pvlib-python in your area of expertise. -* If you have MATLAB experience, you can help us keep pvlib-python - up to date with PVLIB_MATLAB or help us develop common unit tests. - For more, see `Issue #2 `_ - and `Issue #3 `_. * Tell your friends and colleagues about pvlib-python. * Add your project to our `Projects and publications that use pvlib-python wiki diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index d58543c630..2f2e2b0e72 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -34,11 +34,10 @@ ensure consistency throughout the library. History and acknowledgement =========================== -pvlib python started out as a Python translation of the PVLIB MATLAB -toolbox (developed by the `PVPMC `_ at -Sandia National Laboratories) in 2013 and has grown substantially since then. +pvlib python began in 2013 as a Python translation of the `PVLIB for Matlab `_ +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 institutions. +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 Google Summer of Code funding, university research projects, diff --git a/docs/sphinx/source/user_guide/comparison_pvlib_matlab.rst b/docs/sphinx/source/user_guide/comparison_pvlib_matlab.rst deleted file mode 100644 index 12a5a6afa5..0000000000 --- a/docs/sphinx/source/user_guide/comparison_pvlib_matlab.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. _comparison_pvlib_matlab: - -**************************** -Comparison with PVLIB MATLAB -**************************** - -pvlib was originally developed as a library for MATLAB at Sandia -National Lab, and Sandia remains the official maintainer of the MATLAB -library. Sandia supported the initial Python port and -then released further project maintenance and development to the -`pvlib-python maintainers `_. - -The pvlib-python maintainers collaborate with the PVLIB MATLAB -maintainers but operate independently. We'd all like to keep the core -functionality of the Python and MATLAB projects synchronized, but this -will require the efforts of the larger pvlib-python community, not just -the maintainers. Therefore, do not expect feature parity between the -libaries, only similarity. - -The `PV_LIB Matlab help pages `_ -are a good reference for this comparison. - -Missing functions -~~~~~~~~~~~~~~~~~ - -See pvlib-python GitHub `issue #2 -`_ for a list of -functions missing from the Python version of the library. - -Major differences -~~~~~~~~~~~~~~~~~ - -* pvlib-python uses git version control to track all changes - to the code. A summary of changes is included in the whatsnew file - for each release. PVLIB MATLAB documents changes in Changelog.docx -* pvlib-python has a comprehensive test suite, whereas PVLIB MATLAB does - not have a test suite at all. Specifically, pvlib-python - - * Uses TravisCI for automated testing on Linux. - * Uses Appveyor for automated testing on Windows. - * Uses Coveralls to measure test coverage. - -* Using readthedocs for automated documentation building and hosting. -* Removed ``pvl_`` from module/function names. -* Consolidated similar functions into topical modules. - For example, functions from ``pvl_clearsky_ineichen.m`` and - ``pvl_clearsky_haurwitz.m`` have been consolidated into ``clearsky.py``. -* PVLIB MATLAB uses ``location`` structs as the input to some functions. - pvlib-python just uses the lat, lon, etc. as inputs to the functions. - Furthermore, pvlib-python replaces the structs with classes, and these classes - have methods, such as :py:func:`~pvlib.location.Location.get_solarposition`, - that automatically reference the appropriate data. - See :ref:`modeling-paradigms` for more information. -* pvlib-python implements a handful of class designed to simplify the - PV modeling process. These include :py:class:`~pvlib.location.Location`, - :py:class:`~pvlib.pvsystem.PVSystem`, - and - :py:class:`~pvlib.modelchain.ModelChain`. - -Other differences -~~~~~~~~~~~~~~~~~ - -* Very few tests of input validitity exist in the Python code. - We believe that the vast majority of these tests were not necessary. - We also make use of Python's robust support for raising and catching - exceptions. -* Removed unnecessary and sometimes undesired behavior such as setting - maximum zenith=90 or airmass=0. Instead, we make extensive use of - ``nan`` values in returned arrays. -* Implemented the NREL solar position calculation algorithm. - Also added a PyEphem option to solar position calculations. -* Specify time zones using a string from the standard IANA Time Zone - Database naming conventions or using a pytz.timezone instead of an - integer GMT offset. -* ``clearsky.ineichen`` supports interpolating monthly - Linke Turbidities to daily resolution. -* Instead of requiring effective irradiance as an input, ``pvsystem.sapm`` - calculates and returns it based on input POA irradiance, AM, and AOI. -* pvlib-python does not come with as much example data. -* pvlib-python does not currently implement as many algorithms as - PVLIB MATLAB. - -Documentation -~~~~~~~~~~~~~ - -* Using Sphinx to build the documentation, - including dynamically created inline examples. -* Additional Jupyter tutorials in ``/docs/tutorials``. diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst index f3bd1776d1..416cc0b260 100644 --- a/docs/sphinx/source/user_guide/index.rst +++ b/docs/sphinx/source/user_guide/index.rst @@ -15,7 +15,6 @@ User Guide clearsky bifacial weather_data - comparison_pvlib_matlab variables_style_rules singlediode faq diff --git a/docs/sphinx/source/user_guide/package_overview.rst b/docs/sphinx/source/user_guide/package_overview.rst index 5bbbece5a5..ca47d28f86 100644 --- a/docs/sphinx/source/user_guide/package_overview.rst +++ b/docs/sphinx/source/user_guide/package_overview.rst @@ -47,8 +47,8 @@ instructions on how to contribute. We really appreciate it! Credits ------- -The pvlib-python community thanks Sandia National Lab -for developing PVLIB Matlab and for supporting +The pvlib-python community thanks Sandia National Laboratories +for developing PVLIB for Matlab and for supporting Rob Andrews of Calama Consulting to port the library to Python. Will Holmgren thanks the Department of Energy's Energy Efficiency and Renewable Energy Postdoctoral Fellowship Program diff --git a/docs/sphinx/source/whatsnew/v0.10.5.rst b/docs/sphinx/source/whatsnew/v0.10.5.rst index 150c59eb40..fe64879c8a 100644 --- a/docs/sphinx/source/whatsnew/v0.10.5.rst +++ b/docs/sphinx/source/whatsnew/v0.10.5.rst @@ -25,6 +25,7 @@ Documentation ~~~~~~~~~~~~~ * Fix variable name typo at ``docs\examples\system-models\plot_oedi_9068.py``, (:pull:`1996`) +* Remove "Comparison with PVLib for Matlab" page from the User Guide (:issue:`2010`, :pull:`2012`) Requirements @@ -33,3 +34,4 @@ Requirements Contributors ~~~~~~~~~~~~ +* Cliff Hansen (:ghuser:`cwhanse`)