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.

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

Jump to bottom

centrally defined abbreviations for units with special formatting #2209

Closed
wants to merge 17 commits into from
Closed

centrally defined abbreviations for units with special formatting #2209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
a348889
Update conf.py
RDaxini Sep 11, 2024
12de6c6
Update irradiance.py
RDaxini Sep 11, 2024
28330c6
test latex and custom role units
RDaxini Sep 11, 2024
eb4eaed
Update conf.py
RDaxini Sep 11, 2024
b8e8ccd
add various attempts
RDaxini Sep 11, 2024
cf07ae2
remove latex commands
RDaxini Sep 11, 2024
0948b02
Update conf.py
RDaxini Sep 12, 2024
2115fee
trying rst_prolog
RDaxini Sep 13, 2024
e986e21
Merge remote-tracking branch 'upstream/main' into scientific_units_test
RDaxini Sep 16, 2024
0041d7e
Update conf.py
RDaxini Sep 16, 2024
dc68738
example application
RDaxini Sep 16, 2024
831c04c
example usage
RDaxini Sep 16, 2024
2cee380
example usage
RDaxini Sep 16, 2024
b2c54ad
Merge remote-tracking branch 'upstream/main' into scientific_units_test
RDaxini Sep 18, 2024
35f958e
Update conf.py
RDaxini Sep 18, 2024
1ea53c0
Merge remote-tracking branch 'upstream/main' into scientific_units_test
RDaxini Sep 18, 2024
abdee2c
Update conf.py
RDaxini Sep 18, 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
10 changes: 10 additions & 0 deletions docs/sphinx/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,3 +494,13 @@ def make_github_url(file_name):
'make_github_url': make_github_url,
'edit_page_url_template': '{{ make_github_url(file_name) }}',
}

# list of abbreviations for typing out units with nonstandard formatting
rst_prolog = """
.. |wm2| replace:: Wm⁻²
.. |wm2nm1| replace:: Wm⁻²nm⁻¹
.. |degc| replace:: °C
.. |deg| replace:: °
.. |^-1| replace:: ⁻¹
.. |^-2| replace:: ⁻²
"""
6 changes: 3 additions & 3 deletions pvlib/irradiance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,15 +290,15 @@ def get_total_irradiance(surface_tilt, surface_azimuth,
solar_zenith : numeric
Solar zenith angle. [degree]
solar_azimuth : numeric
Solar azimuth angle. [degree]
Solar azimuth angle. [|deg|]
dni : numeric
Direct Normal Irradiance. [W/m2]
ghi : numeric
Global horizontal irradiance. [W/m2]
dhi : numeric
Diffuse horizontal irradiance. [W/m2]
Diffuse horizontal irradiance. [|wm2|]
dni_extra : numeric, optional
Extraterrestrial direct normal irradiance. [W/m2]
Extraterrestrial direct normal irradiance. [|wm2|]
airmass : numeric, optional
Relative airmass (not adjusted for pressure). [unitless]
albedo : numeric, default 0.25
Expand Down
Loading