8000 Change Variables and Symbols page into a Glossary of terms by RDaxini · Pull Request #2234 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]

Skip to content

Change Variables and Symbols page into a Glossary of terms #2234

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

Merged
merged 30 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
3ccef46
initial test
RDaxini Sep 29, 2024
a7ba8ea
Update irradiance.py
RDaxini Sep 29, 2024
678d7e4
update list of terms
RDaxini Oct 9, 2024
ef311d0
update dni description in irradiance.py
RDaxini Oct 9, 2024
2360025
minor edits, aoi definition
RDaxini Oct 9, 2024
a68d27e
Update glossary.rst
RDaxini Oct 9, 2024
9b6f7b0
Update glossary.rst
RDaxini Oct 9, 2024
4b90bd4
remove in-text dni term glossary link
RDaxini Oct 9, 2024
80175c3
delete one surface_tilt definition
RDaxini Oct 9, 2024
8000 34d87c4
review: dni definition
RDaxini Oct 9, 2024
ffa60c6
remove old files, add general text to glossary
RDaxini Oct 10, 2024
5297a08
remove first bullet, add colon, on SoDa line
RDaxini Oct 10, 2024
8e578e5
Update glossary.rst
RDaxini Oct 10, 2024
fc4d2e7
conciseness (suggestion)
RDaxini Oct 10, 2024
816f43d
updated aoi definition #2247
RDaxini Oct 19, 2024
7d6a0ac
update references old variables style rules page
RDaxini Oct 19, 2024
3c6ef52
Merge remote-tracking branch 'upstream/main' into glossary
RDaxini Oct 19, 2024
7329393
remove old page link from v0.3.0 whatsnew
RDaxini Oct 19, 2024
70957f0
Update index.rst
RDaxini Oct 19, 2024
65de172
Update v0.11.2.rst
RDaxini Oct 19, 2024
21d6115
Update docs/sphinx/source/user_guide/glossary.rst
RDaxini Oct 19, 2024
34c155a
Merge remote-tracking branch 'upstream/main' into glossary
RDaxini Oct 20, 2024
ff9383a
Update docs/sphinx/source/contributing/style_guide.rst
RDaxini Oct 21, 2024
d5dca77
add underscore
RDaxini Oct 30, 2024
eae6e48
changed reference label
RDaxini Oct 30, 2024
3491f26
update labels
RDaxini Oct 30, 2024
637d250
name: nomenclature, update labels
RDaxini Oct 30, 2024
dc001fa
update whatsnew wording
RDaxini Oct 30, 2024
72f2f96
update file name
RDaxini Oct 30, 2024
3ec3cb3
Merge branch 'main' into glossary
RDaxini Oct 31, 2024
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
Prev Previous commit
Next Next commit
name: nomenclature, update labels
  • Loading branch information
RDaxini committed Oct 30, 2024
commit 637d250ff85bcace8f89f1f8e54f8fdb88b7a80a
2 changes: 1 addition & 1 deletion docs/sphinx/source/contributing/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pvlib python generally follows the `PEP 8 -- Style Guide for Python Code
is 79 characters.

pvlib python uses a mix of full and abbreviated variable names. See
:ref:`pvlib-glossary`.
:ref:`nomenclature`.
Prefer full names for new contributions. This is especially important
for the API. Abbreviations can be used within a function to improve the
readability of formulae.
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pvlib python
that-use-pvlib-python>`_ page for inspiration and listing of your
application.

There is a :ref:`variable naming convention <pvlib-glossary>` to
There is a :ref:`variable naming convention <nomenclature>` to
ensure consistency throughout the library.


Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/source/user_guide/glossary.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _pvlib-glossary:
.. _nomenclature:

Glossary
========
Nomenclature
============

There is a convention on consistent variable names throughout the library:

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ User Guide
bifacial
weather_data
singlediode
pvlib-glossary
nomenclature
faq
2 changes: 1 addition & 1 deletion docs/sphinx/source/user_guide/weather_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ a :py:class:`pandas.DataFrame` of the actual dataset, plus a metadata
dictionary. Most :py:mod:`pvlib.iotools` functions also have
a ``map_variables`` parameter to automatically translate
the column names used in the data file (which vary widely from dataset to dataset)
into standard pvlib names (see :ref:`pvlib-glossary`).
into standard pvlib names (see :ref:`nomenclature`).

Typical usage looks something like this:

Expand Down
2 changes: 1 addition & 1 deletion pvlib/iotools/midc.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ def read_midc(filename, variable_map={}, raw_data=False, **kwargs):

See the MIDC_VARIABLE_MAP for collection of mappings by site.
For a full list of pvlib variable names see the
:ref:`pvlib-glossary`.
:ref:`nomenclature`.

Be sure to check the units for the variables you will use on the
`MIDC site <https://midcdmz.nrel.gov/>`_.
Expand Down
0