From b38a239276cae93786960cc4500c83f08af5d2c3 Mon Sep 17 00:00:00 2001 From: dacoex Date: Thu, 26 Nov 2015 00:24:20 +0100 Subject: [PATCH 1/3] Added variable names as in https://github.com/pvlib/pvlib-python/issues/102 --- .../source/_static/variables_style-rules.csv | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/sphinx/source/_static/variables_style-rules.csv diff --git a/docs/sphinx/source/_static/variables_style-rules.csv b/docs/sphinx/source/_static/variables_style-rules.csv new file mode 100644 index 0000000000..616835d307 --- /dev/null +++ b/docs/sphinx/source/_static/variables_style-rules.csv @@ -0,0 +1,37 @@ +variable;description;comment +tz;timezone; +latitude;latitude; +longitude;longitude; +dni;direct normal irradiance; +dni_extra;direct normal irradiance at top of atmosphere (extraterrestrial); +dhi;diffuse horizontal irradiance; +ghi;global horizontal irradiance; +aoi;angle of incidence; +aoi_projection;cos(aoi); +airmass;airmass; +airmass_relative;relative airmass; +airmass_absolute;absolute airmass; +poa_ground_diffuse;in plane ground reflected irradiation; +poa_direct;direct/beam irradiation in plane; +poa_diffuse;total diffuse irradiation in plane. sum of ground and sky diffuse.; +poa_global;global irradiation in plane. sum of diffuse and beam projection.; +poa_sky_diffuse;diffuse irradiation in plane from scattered light in the atmosphere (without ground reflected irradiation); +surface_tilt;tilt angle of the surface; +surface_azimuth;azimuth angle of the surface; +solar_zenith;zenith angle of the sun in degrees; +apparent_zenith;refraction-corrected solar zenith angle in degrees; +solar_azimuth;azimuth angle of the sun in degrees East of North; +temp_cell;temperature of the cell; +temp_module;temperature of the module; +temp_air;temperature of the air; +temp_dew;dewpoint temperature; +relative_humidity;relative humidity; +v_mp, i_mp, p_mp;module voltage, current, power at the maximum power point; +v_oc;open circuit module voltage; +i_sc;short circuit module current; +i_x, i_xx;Sandia Array Performance Model IV curve parameters; +effective_irradiance;effective irradiance; +photocurrent;photocurrent; +saturation_current;diode saturation current; +resistance_series;series resistance; +resistance_shunt;shunt resistance; From f78f616b0dd030e2c3fbe9db340fda6e80031a24 Mon Sep 17 00:00:00 2001 From: dacoex Date: Thu, 26 Nov 2015 00:27:16 +0100 Subject: [PATCH 2/3] added page for variables --- docs/sphinx/source/variables_style_rules.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/sphinx/source/variables_style_rules.rst diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst new file mode 100644 index 0000000000..1a7014a526 --- /dev/null +++ b/docs/sphinx/source/variables_style_rules.rst @@ -0,0 +1,14 @@ +.. _variables_style_rules: + +************************* +Variables and style rules +************************* + +There is a convention on consistent variable names throughout the library: + +.. csv-table:: List of Variables + :file: ./_static/variables_style-rules.csv + :delim: ; + :header-rows: 1 + :widths: 5, 20, 10 + From 2835f047ac77bd1785a15db391d26de66ca5232e Mon Sep 17 00:00:00 2001 From: dacoex Date: Thu, 26 Nov 2015 00:45:53 +0100 Subject: [PATCH 3/3] added link to variables --- docs/sphinx/source/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 518f86a1a9..88e3e62511 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -42,6 +42,8 @@ and The GitHub wiki also has a page on `Projects and publications that use pvlib python `_ for inspiration and listing of your application. +There is a :ref:`convention of variable naming ` to ensure consistency throughout the library. + Installation ============ @@ -60,6 +62,7 @@ Contents self whatsnew comparison_pvlib_matlab + variables_style_rules pvlib