Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Opportunities to improve the online documentation #143

Open
kandersolar opened this issue Apr 27, 2022 · 1 comment
Open

Opportunities to improve the online documentation #143

kandersolar opened this issue Apr 27, 2022 · 1 comment

Comments

@kandersolar
Copy link
Contributor

Here's are two things that would be nice to have in the docs, derived largely or entirely from conversation with @spaneja:

Relevant class methods don't have their own docs page

For example: PVEngine has its own page (link), but its fit() method does not, making it hard to know what parameters the method takes (without referring to the tutorials, anyway). I think it should be straightforward to get this working just with sphinx configuration changes.

Irradiance component names and meanings are not documented

It's possible to extract not only total incident and absorbed irradiance but also various sub-components. The docs have an example of this:

"# Get the calculated outputs from the pv array\n",
"center_row_front_incident_irradiance = pvarray.ts_pvrows[1].front.get_param_weighted('qinc')\n",
"left_row_back_reflected_incident_irradiance = pvarray.ts_pvrows[0].back.get_param_weighted('reflection')\n",
"right_row_back_isotropic_incident_irradiance = pvarray.ts_pvrows[2].back.get_param_weighted('isotropic')\n",

It would be nice for the available component names (e.g. reflection) to be listed somewhere, along with specific descriptions of what each name refers to (e.g. does reflection include ground-reflected irradiance, or just row-row reflections?).

@anomam
Copy link
Contributor

anomam commented Oct 1, 2022

yes the documentation is lacking in a lot of ways, sorry... I didn't have much time and help back then.
I see a lot of areas that can be improved even in the code, for instance these values 'reflection', 'isotropic', ... should clearly be enums...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants