Add roadmap page to User's Guide sphinx docs by kandersolar · Pull Request #1893 · pvlib/pvlib-python

kandersolar · 2023-10-19T16:32:05Z

Closes #xxxx
I am familiar with the contributing guidelines
Tests added
Updates entries in docs/sphinx/source/reference for API changes.
Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for all changes. Includes link to the GitHub Issue with :issue:`num` or this Pull Request with :pull:`num`. Includes contributor name and/or GitHub username (link with :ghuser:`user`).
New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
Pull request is nearly complete and ready for detailed review.
Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

I think it would be beneficial to keep a roadmap document in a more public-facing spot. Our sphinx docs get way more traffic than github does, so I think housing it on RTD will get it in front of a lot more users. My hope is that this will help keep the roadmap in front of mind, plus maybe attract new contributors. I also like the idea of having a clear process for proposing and accepting edits to the roadmap... just make a PR with the changes.

I took some editorial liberties when assembling this roadmap based on the previous ones. Feedback from anyone reading this is desired.

mikofski · 2023-10-19T18:28:05Z

Thanks @kandersolar maybe we can take a step further and put some release dates and a few loose goals and priorities for next few releases?

jsstein

Great job Kevin, Just a few minor suggestions for addition.

jsstein · 2023-10-19T18:29:56Z

docs/sphinx/source/user_guide/roadmap.rst

+* Improved inverter performance models (power factor, off-MPP operation,
+  thermal derating, MPPT voltage range)
+* DC-DC optimizer performance models
+* Transformer models


Suggested change

* Transformer models

* Transformer models (e.g., efficiency models such as described here: [https://www.linquip.com/blog/efficiency-of-transformer/#:~:text=Similar%20to%20an%20electrical%20device,efficiency%20%3D%20output%2Finput).](url))

jsstein · 2023-10-19T18:32:05Z

docs/sphinx/source/user_guide/roadmap.rst

+* Improved inverter performance models (power factor, off-MPP operation,
+  thermal derating, MPPT voltage range)


Suggested change

* Improved inverter performance models (power factor, off-MPP operation,

thermal derating, MPPT voltage range)

* Improved inverter performance models (power factor, off-MPP operation,

thermal derating, MPPT voltage range) and impacts of off-MPP operation on module temperature.

jsstein · 2023-10-19T18:33:16Z

docs/sphinx/source/user_guide/roadmap.rst

+* Transformer models
+* Electrical mismatch functionality
+* Improved snow loss models, in particular for bifacial and tracked systems
+* Shade models: row-to-row, external (e.g. trees), horizon


Suggested change

* Shade models: row-to-row, external (e.g. trees), horizon

* Shade models: row-to-row, external (e.g. trees), horizon, including 3D terrain effects

jsstein · 2023-10-19T18:34:13Z

docs/sphinx/source/user_guide/roadmap.rst

+* Degradation: we can at least provide the trivial linear model, and
+  add more sophisticated predictive models as they become available.
+* More sophisticated single-axis tracker models, e.g. split-boost backtracking,
+  rotation discretization, stow


Suggested change

rotation discretization, stow

rotation discretization, stow (based on wind speed?)

I think stow should be just a boolean series, then the user can set the criteria themselves, e.g.,

..., stow=df['wind_speed']>25, ...

jsstein · 2023-10-19T18:41:19Z

docs/sphinx/source/user_guide/roadmap.rst

+Additionally, it would be nice to have a project website (pvlib.org?)
+with scope going beyond code documentation.


How would this be different from the GitHub and ReadtheDocs site?

I would be nice to have a website that unites all the pvlib community and projects (pvlib-python, pvanalytics, etc.)

And giving people the website https://pvlib-python.readthedocs.io is kinda rough... pvlib.org would be an important step for pvlib in my opinion

mtheristis

Here are some suggestions coming from the PVPMC.

mtheristis · 2023-10-19T20:56:39Z

docs/sphinx/source/user_guide/roadmap.rst

+* Electrical mismatch functionality
+* Improved snow loss models, in particular for bifacial and tracked systems
+* Shade models: row-to-row, external (e.g. trees), horizon
+* Degradation: we can at least provide the trivial linear model, and


Linear or exponential.

mtheristis · 2023-10-19T20:58:35Z

docs/sphinx/source/user_guide/roadmap.rst

+  available in pvlib.  Irradiance nonuniformity, varied terrain and albedo,
+  racking shade, and other effects are not accounted for in the current models.
+* Updated parameter libraries, e.g. the CEC PV Module database
+


What about parameter translation? CEC -> X model?

mtheristis · 2023-10-19T21:05:38Z

docs/sphinx/source/user_guide/roadmap.rst

+* Transformer models
+* Electrical mismatch functionality
+* Improved snow loss models, in particular for bifacial and tracked systems
+* Shade models: row-to-row, external (e.g. trees), horizon


Inter-row shading for specific technologies, e.g. CdTe, half-cut etc.?

mtheristis · 2023-10-19T21:12:24Z

docs/sphinx/source/user_guide/roadmap.rst

+  available in pvlib.  Irradiance nonuniformity, varied terrain and albedo,
+  racking shade, and other effects are not accounted for in the current models.
+* Updated parameter libraries, e.g. the CEC PV Module database
+


Modeling tandem configurations?

adriesse · 2023-10-20T12:34:21Z

Two thoughts:

if this is a wish list, why call it a roadmap instead of a wish list?
couldn't many of these wishes be turned into issues in which the wishes are also more fully described? Oh yes, you mentioned visibility...maybe we can have links to issues where the wishes are more fully described?

adriesse · 2023-10-25T17:41:06Z

docs/sphinx/source/user_guide/roadmap.rst

@@ -0,0 +1,153 @@
+.. _roadmap:
+
+pvlib Roadmap


Suggested change

pvlib Roadmap

pvlib wish list

adriesse · 2023-10-25T17:44:01Z

docs/sphinx/source/user_guide/roadmap.rst

+  <https://github.com/pvlib/pvlib-python/wiki/2019-pvlib-python-Development-Roadmap>`_
+
+
+Core modeling capabilities


Suggested change

Core modeling capabilities

Core simulation capabilities

adriesse · 2023-10-25T17:44:29Z

docs/sphinx/source/user_guide/roadmap.rst

+provide a reference implementation.
+
+
+Auxiliary modeling capabilities


Suggested change

Auxiliary modeling capabilities

Broader modeling capabilities

adriesse · 2023-10-25T17:50:45Z

docs/sphinx/source/user_guide/roadmap.rst

+is of significant value.  However, making progress here is also somewhat
+constrained by the small number of existing published methods that can be
+implemented.
+


Suggested change

See :issue:`1877`.

RDaxini

Not sure I am too late on this one but I like the idea of development roadmap and I see this hasn't been merged yet so I figured I'd share a few small thoughts

RDaxini · 2024-09-11T09:38:32Z

docs/sphinx/source/user_guide/roadmap.rst

+  thermal derating, MPPT voltage range)
+* DC-DC optimizer performance models
+* Transformer models
+* Electrical mismatch functionality


Since (one type of) shading is listed as a separate point, perhaps it's worth clarifying this with an example or two? Sounds vague by itself

eg. (just a suggestion/idea)

Suggested change

* Electrical mismatch functionality

* Electrical mismatch functionality (e.g. bypass diode protection)

RDaxini · 2024-09-11T09:42:50Z

docs/sphinx/source/user_guide/roadmap.rst

+* DC-DC optimizer performance models
+* Transformer models
+* Electrical mismatch functionality
+* Improved snow loss models, in particular for bifacial and tracked systems


IIRC from the May 2023 PVPMC, one of the Sandia presentations talked about multijunction/tandem modelling goals for PVPMC as a whole(?)
Also, on the subject of irradiance, the spectral effect on the calculation effective POA irradiance was highlighted in the github wiki 2023 user meeting notes. I think this area still needs work, especially if/when multijunction modelling functionality is added

Suggested change

* Improved snow loss models, in particular for bifacial and tracked systems

* Improved snow loss models, in particular for bifacial and tracked systems

* Multijunction device modelling

kandersolar added 3 commits October 19, 2023 12:31

draft roadmap page

b2b2caf

list roadmap page in user guide index

4e3dae4

whatsnew

e931565

kandersolar added the documentation label Oct 19, 2023

kandersolar added this to the v0.10.3 milestone Oct 19, 2023

kandersolar added 2 commits October 19, 2023 12:39

formatting fix

0819efe

Add some more detail

7863d7a

jsstein reviewed Oct 19, 2023

View reviewed changes

mtheristis reviewed Oct 19, 2023

View reviewed changes

adriesse reviewed Oct 25, 2023

View reviewed changes

cwhanse mentioned this pull request Dec 8, 2023

v0.10.3 release plan #1928

Closed

15 tasks

kandersolar modified the milestones: v0.10.3, v0.10.4 Dec 20, 2023

kandersolar mentioned this pull request Mar 12, 2024

v0.10.4 release planning #1992

Closed

kandersolar modified the milestones: v0.10.4, v0.10.5 Mar 18, 2024

kandersolar modified the milestones: v0.10.5, 0.11.0 May 3, 2024

kandersolar modified the milestones: 0.11.0, v0.11.1 Jun 14, 2024

kandersolar modified the milestones: v0.11.1, Someday Aug 30, 2024

RDaxini reviewed Sep 11, 2024

View reviewed changes

	* Transformer models
	* Transformer models (e.g., efficiency models such as described here: [https://www.linquip.com/blog/efficiency-of-transformer/#:~:text=Similar%20to%20an%20electrical%20device,efficiency%20%3D%20output%2Finput).](url))

		* Improved inverter performance models (power factor, off-MPP operation,
		thermal derating, MPPT voltage range)

	* Shade models: row-to-row, external (e.g. trees), horizon
	* Shade models: row-to-row, external (e.g. trees), horizon, including 3D terrain effects

	rotation discretization, stow
	rotation discretization, stow (based on wind speed?)

		Additionally, it would be nice to have a project website (pvlib.org?)
		with scope going beyond code documentation.

		<https://github.com/pvlib/pvlib-python/wiki/2019-pvlib-python-Development-Roadmap>`_


		Core modeling capabilities

		provide a reference implementation.


		Auxiliary modeling capabilities

	Auxiliary modeling capabilities
	Broader modeling capabilities

	* Electrical mismatch functionality
	* Electrical mismatch functionality (e.g. bypass diode protection)

	* Improved snow loss models, in particular for bifacial and tracked systems
	* Improved snow loss models, in particular for bifacial and tracked systems
	* Multijunction device modelling

Conversation

kandersolar commented Oct 19, 2023

Uh oh!

mikofski commented Oct 19, 2023

Uh oh!

jsstein left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtheristis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adriesse commented Oct 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RDaxini left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

adriesse commented Oct 20, 2023 •

edited

Loading