Skip to content

Restructure documentation, port tutorials #121

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.

Sign up for GitHub

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

Closed
wants to merge 8 commits into from
Closed

Restructure documentation, port tutorials #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
660b244
ToC for port of tuts to rst
Feb 2, 2016
a5250f9
ToC for port of tuts to rst edits
Feb 2, 2016
8531abe
typo
Feb 2, 2016
c45625e
new toc for discussion
Feb 10, 2016
7bfde5b
restructure api reference
Feb 10, 2016
79d9395
Merge remote-tracking branch 'refs/remotes/pvlib/master' into pvsyste…
Aug 17, 2016
76516bf
added new documents for updated structure
Sep 21, 2016
42d5c91
inital conversion of loss modeling part
Nov 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,8 @@ coverage.xml
#Ignore some notebooks
*.ipynb
!docs/tutorials/*.ipynb

#Ignore during development:
pvlib_ToC_structure.txt
make.bat
*.png
49 changes: 49 additions & 0 deletions docs/sphinx/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,65 @@ Contents

package_overview
whatsnew
usage
installation
contributing
timetimezones
solarposition
transposition
clearsky
io
system
forecasts
statistics
plotting
reporting
modules
classes
comparison_pvlib_matlab
variables_style_rules


Contents (potential new ToC)
============================

* What’s New
* Overview: Why pvlib?
* Introduction
* Modeling paradigms
* User extensions
* What it is not
* Comparison with PVLIB_MATLAB
* Installation
* Examples
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove the top level "Examples".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was mimicked after
http://xarray.pydata.org/en/stable/index.html
http://xarray.pydata.org/en/stable/examples.html

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. I don't have a strong preference here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to keep the top level.
This helps to reduce maxdepth to 1 once there are many sub-pages.

* Using the principal components
* atmosphere.py tutorial
* solarposition.py tutorial
* irradiance.py tutorial
* Specific datasets
* TMY tutorial
* TMY data and diffuse irradiance model
* TMY to Power Tutorial
* System Modelling
* pvsystem tutorial
* Tracking
* Modeling multiple systems with system losses
* Validations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand the "Validations" title. Are you planning to compare to real data? That sounds like a good idea, but the subheadings are not specific to data validation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be "Validations & Comparisons"

In the "SAPM" notebook, the different models are compared (= validated against each other).
This a strength of pvlib as compared to other tools albeit SAM & PVSyst can also do this...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, no, I would not use "validation" unless there was data.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So it will be "Validations & Comparisons"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I suggest removing the section entirely and putting the subitems under system modeling. If you really want the section then call it something like "SAPM and Single Diode Comparison"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

* SAPM – Some simulations using the Sandia Array Performance Model.
* IV curves – Make some IV curves based on this data
* API reference with principal components
* Modules
* Classes
* Support and Development
* Getting support
* How do I contribute?
* Frequently Asked Questions
* Citing and References
* Citing pvlib
* References used for the code
* Publications and projects using pvlib
* Credits


Indices and tables
==================
Expand Down
21 changes: 21 additions & 0 deletions docs/sphinx/source/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _io:

*************************************************
Import of Data & Export to other Industry Formats
*************************************************

Solar Data
======================


Web Information
=======================


Locations
--------------


PVSyst
======================

10 changes: 10 additions & 0 deletions docs/sphinx/source/multi_array_losses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _single_array:

*********************************************
Multiple Array PV System or Multiple Systems
*********************************************

Insert here:

http://nbviewer.jupyter.org/github/jforbess/pvlib-python/blob/Issue84/docs/tutorials/system_loss_modeling.ipynb

6 changes: 6 additions & 0 deletions docs/sphinx/source/plotting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _plotting:

*************************************************
Plotting of Solar Data and Simulation Results
*************************************************

6 changes: 6 additions & 0 deletions docs/sphinx/source/reporting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _reporting:

*********************
Reporting of Results
*********************

Loading