From 097aef8668dcd31bbdf55a8c4029cdef1466e6e6 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Fri, 12 Apr 2024 21:59:18 +0200 Subject: [PATCH 1/5] Remove link to outdate tutorials --- docs/sphinx/source/user_guide/package_overview.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/sphinx/source/user_guide/package_overview.rst b/docs/sphinx/source/user_guide/package_overview.rst index 5bbbece5a5..dbcdc6a3b5 100644 --- a/docs/sphinx/source/user_guide/package_overview.rst +++ b/docs/sphinx/source/user_guide/package_overview.rst @@ -12,8 +12,7 @@ interoperable, and benchmark implementations of PV system models. There are at least as many opinions about how to model PV systems as there are modelers of PV systems, so pvlib-python provides several modeling paradigms: functions, the Location/PVSystem classes, and the -ModelChain class. Read more about this in the :ref:`introtutorial` -section. +ModelChain class. User extensions From b57497e523994ea68999f37455e818d762a33a36 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Fri, 12 Apr 2024 22:06:22 +0200 Subject: [PATCH 2/5] Update link to min version requirements --- docs/sphinx/source/user_guide/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/user_guide/installation.rst b/docs/sphinx/source/user_guide/installation.rst index 219a4b3bf5..4c84005e7d 100644 --- a/docs/sphinx/source/user_guide/installation.rst +++ b/docs/sphinx/source/user_guide/installation.rst @@ -220,7 +220,7 @@ pvlib-python is compatible with Python 3. pvlib-python requires Pandas, Numpy, and SciPy. The minimum version requirements are specified in -`setup.py `_. +`pyproject.toml `_. They are typically releases from several years ago. A handful of pvlib-python features require additional packages that must From da0ecb73a0dfc2bb00e18ae16b0dad57f4024b68 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Sat, 13 Apr 2024 10:36:05 +0200 Subject: [PATCH 3/5] Remove correct tutorial link --- docs/sphinx/source/user_guide/installation.rst | 9 ++------- docs/sphinx/source/user_guide/package_overview.rst | 3 ++- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/sphinx/source/user_guide/installation.rst b/docs/sphinx/source/user_guide/installation.rst index 4c84005e7d..aa766bf47e 100644 --- a/docs/sphinx/source/user_guide/installation.rst +++ b/docs/sphinx/source/user_guide/installation.rst @@ -83,15 +83,10 @@ for a password then you're probably trying to install pvlib into your system's Python distribution. This is usually a bad idea and you should follow the :ref:`nopython` instructions before installing pvlib. -You may still want to download the Python source code so that you can -easily get all of the Jupyter Notebook tutorials. Either clone the `git +You may still want to download the Python source code. Either clone the `git repository `_ or go to the `Releases page `_ to -download the zip file of the most recent release. You can also use the -nbviewer website to choose a tutorial to experiment with. Go to our -`nbviewer tutorial page -`_. +download the zip file of the most recent release. .. _editablelibrary: diff --git a/docs/sphinx/source/user_guide/package_overview.rst b/docs/sphinx/source/user_guide/package_overview.rst index dbcdc6a3b5..5bbbece5a5 100644 --- a/docs/sphinx/source/user_guide/package_overview.rst +++ b/docs/sphinx/source/user_guide/package_overview.rst @@ -12,7 +12,8 @@ interoperable, and benchmark implementations of PV system models. There are at least as many opinions about how to model PV systems as there are modelers of PV systems, so pvlib-python provides several modeling paradigms: functions, the Location/PVSystem classes, and the -ModelChain class. +ModelChain class. Read more about this in the :ref:`introtutorial` +section. User extensions From f1dfc822bc70363a8557022d8a9196640e949b33 Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Tue, 16 Apr 2024 16:46:34 +0200 Subject: [PATCH 4/5] Remove more references to notebooks --- docs/sphinx/source/contributing.rst | 2 +- docs/sphinx/source/index.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/sphinx/source/contributing.rst b/docs/sphinx/source/contributing.rst index d60d4fcaeb..bbd7b8e474 100644 --- a/docs/sphinx/source/contributing.rst +++ b/docs/sphinx/source/contributing.rst @@ -29,7 +29,7 @@ pvlib-python, git, or Python: `easy `_, or `help wanted `_. * Improve the documentation and the unit tests. -* Improve the IPython/Jupyter Notebook tutorials or write new ones that +* Improve the Example Gallery or add new examples 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. diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index e91387c788..5eee184185 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -10,14 +10,14 @@ 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. -The source code for pvlib python is hosted on `github +The source code for pvlib python is hosted on `GitHub `_. Please see the :ref:`installation` page for installation help. For examples of how to use pvlib python, please see -:ref:`package_overview` and our `Jupyter Notebook tutorials -`_. The documentation assumes general familiarity with +:ref:`package_overview` and the `Example Gallery +`_. +The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages. From 06712a8607090d300ccd427760fac2078949a04b Mon Sep 17 00:00:00 2001 From: "Adam R. Jensen" <39184289+AdamRJensen@users.noreply.github.com> Date: Tue, 16 Apr 2024 19:17:37 +0200 Subject: [PATCH 5/5] Update docs/sphinx/source/index.rst Co-authored-by: Kevin Anderson --- docs/sphinx/source/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 5eee184185..622b266dbe 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -15,8 +15,7 @@ The source code for pvlib python is hosted on `GitHub Please see the :ref:`installation` page for installation help. For examples of how to use pvlib python, please see -:ref:`package_overview` and the `Example Gallery -`_. +:ref:`package_overview` and the :ref:`example_gallery`. The documentation assumes general familiarity with Python, NumPy, and Pandas. Google searches will yield many excellent tutorials for these packages.