From 8088ee8d6c74849e201b1a824eb36a3b39029c2d Mon Sep 17 00:00:00 2001 From: dacoex Date: Thu, 26 Nov 2015 00:56:43 +0100 Subject: [PATCH 01/30] fix for https://github.com/pvlib/pvlib-python/issues/102 inserted link to variables --- .../source/_static/variables_style-rules.csv | 37 +++++++++++++++++++ docs/sphinx/source/index.rst | 3 ++ docs/sphinx/source/variables_style_rules.rst | 14 +++++++ 3 files changed, 54 insertions(+) create mode 100644 docs/sphinx/source/_static/variables_style-rules.csv create mode 100644 docs/sphinx/source/variables_style_rules.rst 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; 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 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 ac236e8b7ea99d331a8d97aa9b7ecb3ae575f83f Mon Sep 17 00:00:00 2001 From: dacoex Date: Mon, 18 Jan 2016 16:35:50 +0100 Subject: [PATCH 02/30] moved table & added example for .IEC61724:1998 --- .../source/_static/variables_style-rules.csv | 37 ------------------- docs/sphinx/source/variables_style_rules.rst | 2 +- 2 files changed, 1 insertion(+), 38 deletions(-) delete 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 deleted file mode 100644 index 616835d307..0000000000 --- a/docs/sphinx/source/_static/variables_style-rules.csv +++ /dev/null @@ -1,37 +0,0 @@ -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; diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 1a7014a526..a659fcbe5e 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -7,7 +7,7 @@ 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 + :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 :widths: 5, 20, 10 From 284f4214c37e91da441a633e7b0a05448c4624fa Mon Sep 17 00:00:00 2001 From: dacoex Date: Mon, 18 Jan 2016 16:36:29 +0100 Subject: [PATCH 03/30] corrected cols --- docs/sphinx/source/variables_style_rules.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index a659fcbe5e..70eea523b4 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -10,5 +10,5 @@ There is a convention on consistent variable names throughout the library: :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 - :widths: 5, 20, 10 + :widths: 5, 20, 10, 10, 10 From e6dea98a855bb93e325ef95c632b407d01c6ceed Mon Sep 17 00:00:00 2001 From: dacoex Date: Mon, 18 Jan 2016 16:45:41 +0100 Subject: [PATCH 04/30] moving the file the hard way --- .gitignore | 2 +- pvlib/data/variables_style-rules.csv | 37 ++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 pvlib/data/variables_style-rules.csv diff --git a/.gitignore b/.gitignore index 444f214d0e..707f3a006e 100644 --- a/.gitignore +++ b/.gitignore @@ -69,7 +69,7 @@ coverage.xml #Datafiles -*.csv +#*.csv # vi *.swp diff --git a/pvlib/data/variables_style-rules.csv b/pvlib/data/variables_style-rules.csv new file mode 100644 index 0000000000..dfbbbc0a58 --- /dev/null +++ b/pvlib/data/variables_style-rules.csv @@ -0,0 +1,37 @@ +variable;description;comment;Symbol acc. IEC 61724:1998;Unit acc. IEC 61724:1998 +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.;;:math:`G_{I}`;:math:`W x m^{-2}` +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 73af0500238c031262e01e41cbf04e67045c7396 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 11:55:00 +0100 Subject: [PATCH 05/30] updated IEC symbol to better math IEC columns stay here as reference only. added links to references on units, acronyms, etc. --- docs/sphinx/source/variables_style_rules.rst | 18 +++-- pvlib/data/variables_style-rules.csv | 74 ++++++++++---------- 2 files changed, 51 insertions(+), 41 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 70eea523b4..81e3c25169 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -1,7 +1,7 @@ .. _variables_style_rules: -************************* -Variables and style rules +************************ +Variables and Symbols ************************* There is a convention on consistent variable names throughout the library: @@ -10,5 +10,15 @@ There is a convention on consistent variable names throughout the library: :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 - :widths: 5, 20, 10, 10, 10 - + :widths: 5, 10, 10, 10 + +For an definition and further help on symbols and units refer to the following sources + * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ + * with physics focus: + * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + * `Units and conversion tool `_ + * `Terminology: definitions of the main quantities. `_ + * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file diff --git a/pvlib/data/variables_style-rules.csv b/pvlib/data/variables_style-rules.csv index dfbbbc0a58..d27c94ad30 100644 --- a/pvlib/data/variables_style-rules.csv +++ b/pvlib/data/variables_style-rules.csv @@ -1,37 +1,37 @@ -variable;description;comment;Symbol acc. IEC 61724:1998;Unit acc. IEC 61724:1998 -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.;;:math:`G_{I}`;:math:`W x m^{-2}` -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;;; +variable;description;Symbol acc. IEC 61724:1998;Unit acc. IEC 61724:1998 +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.;:math:`G_{I}`;:math:`W \cdot m^{-2}` +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 8bb5be0226e3d44c451dd491c9bc9ff858978edf Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:00:53 +0100 Subject: [PATCH 06/30] included transposition factor See dicussion: https://github.com/pvlib/pvlib-python/issues/37#issuecomment-169047192 --- pvlib/data/variables_style-rules.csv | 75 ++++++++++++++-------------- 1 file changed, 38 insertions(+), 37 deletions(-) diff --git a/pvlib/data/variables_style-rules.csv b/pvlib/data/variables_style-rules.csv index d27c94ad30..fbea75ef9c 100644 --- a/pvlib/data/variables_style-rules.csv +++ b/pvlib/data/variables_style-rules.csv @@ -1,37 +1,38 @@ -variable;description;Symbol acc. IEC 61724:1998;Unit acc. IEC 61724:1998 -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.;:math:`G_{I}`;:math:`W \cdot m^{-2}` -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;; +variable;description +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 +tf;transposition factor, the gain ration of the radiation in inclinded plane to horizontal plane: :math:`\\frac{poa_global}{ghi}` From d83f93437588474b9bdfa7324765d88d239c3000 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:04:37 +0100 Subject: [PATCH 07/30] minor correction of table display --- docs/sphinx/source/variables_style_rules.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 81e3c25169..c3c2d0e468 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -6,11 +6,11 @@ Variables and Symbols There is a convention on consistent variable names throughout the library: -.. csv-table:: List of Variables +.. csv-table:: List of used Symbols and Variables :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 - :widths: 5, 10, 10, 10 + :widths: 5, 20 For an definition and further help on symbols and units refer to the following sources * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ From 4584636c01ad4f1e0155d133199505f7b618a338 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:19:23 +0100 Subject: [PATCH 08/30] link correction --- docs/sphinx/source/variables_style_rules.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index c3c2d0e468..597622df9d 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -13,7 +13,7 @@ There is a convention on consistent variable names throughout the library: :widths: 5, 20 For an definition and further help on symbols and units refer to the following sources - * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ + * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ * with physics focus: * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) * `Acronyms, Terminology and Units `_ From eb16adf240b6e05eadfd88b0e3d73ba124cc15c9 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:22:17 +0100 Subject: [PATCH 09/30] added PVPMC link --- docs/sphinx/source/variables_style_rules.rst | 22 +++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 597622df9d..0ad6423a7e 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -12,13 +12,15 @@ There is a convention on consistent variable names throughout the library: :header-rows: 1 :widths: 5, 20 -For an definition and further help on symbols and units refer to the following sources - * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ - * with physics focus: - * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) - * `Acronyms, Terminology and Units `_ - * `Plane orientations and radiation components `_ - * `Time references `_ - * `Units and conversion tool `_ - * `Terminology: definitions of the main quantities. `_ - * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file +For an definition and further help on symbols and units refer to the following sources: + +* `Refernce Variable List by PVPMC `_ +* with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ +* with physics focus: + * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + * `Units and conversion tool `_ + * `Terminology: definitions of the main quantities. `_ + * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file From e27f44336f1c38d9d2b253ddefe490be5abfdfb3 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:29:17 +0100 Subject: [PATCH 10/30] corrected list --- docs/sphinx/source/variables_style_rules.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 0ad6423a7e..67a2d50110 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -14,13 +14,13 @@ There is a convention on consistent variable names throughout the library: For an definition and further help on symbols and units refer to the following sources: -* `Refernce Variable List by PVPMC `_ -* with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ -* with physics focus: - * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) - * `Acronyms, Terminology and Units `_ - * `Plane orientations and radiation components `_ - * `Time references `_ - * `Units and conversion tool `_ - * `Terminology: definitions of the main quantities. `_ - * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file + * `Refernce Variable List by PVPMC `_ + * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ + * with physics focus: + * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + * `Units and conversion tool `_ + * `Terminology: definitions of the main quantities. `_ + * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file From 59ad15a4f912de41d5af1bc75483c7a9fa50f006 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:36:27 +0100 Subject: [PATCH 11/30] list fixing --- docs/sphinx/source/variables_style_rules.rst | 21 ++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 67a2d50110..877d4e150c 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -14,13 +14,14 @@ There is a convention on consistent variable names throughout the library: For an definition and further help on symbols and units refer to the following sources: - * `Refernce Variable List by PVPMC `_ - * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis`_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ - * with physics focus: - * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) - * `Acronyms, Terminology and Units `_ - * `Plane orientations and radiation components `_ - * `Time references `_ - * `Units and conversion tool `_ - * `Terminology: definitions of the main quantities. `_ - * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file +* `Reference Variable List by PVPMC `_ +* with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis `_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ +* with physics focus: + + * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + * `Units and conversion tool `_ + * `Terminology: definitions of the main quantities. `_ + * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file From ddff85992727c189f98e2620d459224d722c8a0e Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:40:53 +0100 Subject: [PATCH 12/30] minor corrections --- docs/sphinx/source/variables_style_rules.rst | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 877d4e150c..302943452d 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -15,13 +15,12 @@ There is a convention on consistent variable names throughout the library: For an definition and further help on symbols and units refer to the following sources: * `Reference Variable List by PVPMC `_ -* with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis `_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998): Photovoltaic System Performance Monitoring - Guidelines for Measurement, Data exchange and Analysis [ETD 28: Solar Photovoltaic Energy Systems] `_ +* with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis `_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998) `_ * with physics focus: - - * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) - * `Acronyms, Terminology and Units `_ - * `Plane orientations and radiation components `_ - * `Time references `_ - * `Units and conversion tool `_ - * `Terminology: definitions of the main quantities. `_ - * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file + * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + * `Units and conversion tool `_ + * `Terminology: definitions of the main quantities. `_ + * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file From fcbd87ba2c14c107ec9f533f37016d9096d91a4e Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:42:26 +0100 Subject: [PATCH 13/30] list correction --- docs/sphinx/source/variables_style_rules.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 302943452d..1435a331fc 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -17,6 +17,7 @@ For an definition and further help on symbols and units refer to the following s * `Reference Variable List by PVPMC `_ * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis `_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998) `_ * with physics focus: + * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) * `Acronyms, Terminology and Units `_ * `Plane orientations and radiation components `_ From f5cb190705e756660a4bb4cf0ca052f74ffcee6a Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 12:45:08 +0100 Subject: [PATCH 14/30] list --- docs/sphinx/source/variables_style_rules.rst | 25 ++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 1435a331fc..8f1add208a 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -10,7 +10,7 @@ There is a convention on consistent variable names throughout the library: :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 - :widths: 5, 20 + :widths: 5, 10 For an definition and further help on symbols and units refer to the following sources: @@ -24,4 +24,25 @@ For an definition and further help on symbols and units refer to the following s * `Time references `_ * `Units and conversion tool `_ * `Terminology: definitions of the main quantities. `_ - * `Acronyms in solar radiation `_ (more extensive list) \ No newline at end of file + * `Acronyms in solar radiation `_ (more extensive list) + +Test: + +* This is a bulleted list. +* It has two items, the second + item uses two lines. + +1. This is a numbered list. +2. It has two items too. + +#. This is a numbered list. +#. It has two items too. + + +* this is +* a list + + * with a nested list + * and some subitems + +* and here the parent list continues \ No newline at end of file From ca1ce2da3b9e9e753a50aec422dde5fc225db63e Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 13:30:51 +0100 Subject: [PATCH 15/30] table tweak --- docs/sphinx/source/variables_style_rules.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 8f1add208a..b39ab44b76 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -10,7 +10,7 @@ There is a convention on consistent variable names throughout the library: :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 - :widths: 5, 10 + :widths: 5, 7 For an definition and further help on symbols and units refer to the following sources: From 19a4a2c661874735187b73fe60363b0e568296d3 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 13:33:27 +0100 Subject: [PATCH 16/30] list testing --- docs/sphinx/source/variables_style_rules.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index b39ab44b76..56303e15ae 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -26,7 +26,9 @@ For an definition and further help on symbols and units refer to the following s * `Terminology: definitions of the main quantities. `_ * `Acronyms in solar radiation `_ (more extensive list) -Test: +.. _test: + +List Test acc. http://www.sphinx-doc.org/en/stable/rest.html#lists-and-quote-like-blocks * This is a bulleted list. * It has two items, the second From 798796f6a00f9fae71d3a74698e9f8b2e5596764 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 13:36:39 +0100 Subject: [PATCH 17/30] endless list check with RTD stylesheet --- docs/sphinx/source/variables_style_rules.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 56303e15ae..8a3de8a623 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -14,6 +14,7 @@ There is a convention on consistent variable names throughout the library: For an definition and further help on symbols and units refer to the following sources: + * `Reference Variable List by PVPMC `_ * with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis `_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998) `_ * with physics focus: @@ -25,6 +26,7 @@ For an definition and further help on symbols and units refer to the following s * `Units and conversion tool `_ * `Terminology: definitions of the main quantities. `_ * `Acronyms in solar radiation `_ (more extensive list) + .. _test: From 10d2572bd64fe9a99777d5e7439a0ecc48eb162c Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 14:23:35 +0100 Subject: [PATCH 18/30] testing --- docs/sphinx/source/variables_style_rules.rst | 22 +++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 8a3de8a623..5e6da61b99 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -11,6 +11,7 @@ There is a convention on consistent variable names throughout the library: :delim: ; :header-rows: 1 :widths: 5, 7 + _stub-columns: 1 For an definition and further help on symbols and units refer to the following sources: @@ -49,4 +50,23 @@ List Test acc. http://www.sphinx-doc.org/en/stable/rest.html#lists-and-quote-lik * with a nested list * and some subitems -* and here the parent list continues \ No newline at end of file +* and here the parent list continues + + +.. list-table:: Frozen Delights! + :widths: 15 10 30 + :header-rows: 1 + + * - Treat + - Quantity + - Description + * - Albatross + - 2.99 + - On a stick! + * - Crunchy Frog + - 1.49 + - If we took the bones out, it wouldn't be + crunchy, now would it? + * - Gannet Ripple + - 1.99 + - On a stick! \ No newline at end of file From 95dbf86725a44e70e7da6b8f8270eac2673e2ec6 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 14:26:51 +0100 Subject: [PATCH 19/30] test --- docs/sphinx/source/variables_style_rules.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 5e6da61b99..abc6a8e64a 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -11,7 +11,7 @@ There is a convention on consistent variable names throughout the library: :delim: ; :header-rows: 1 :widths: 5, 7 - _stub-columns: 1 + :stub-columns: 1 For an definition and further help on symbols and units refer to the following sources: From 5561cff66cdcad9bcb6606d3a46cefb09cc5f7e8 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 14:37:58 +0100 Subject: [PATCH 20/30] test tables --- docs/sphinx/source/variables_style_rules.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index abc6a8e64a..273ef49831 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -10,7 +10,7 @@ There is a convention on consistent variable names throughout the library: :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 - :widths: 5, 7 + :widths: 5, 5 :stub-columns: 1 For an definition and further help on symbols and units refer to the following sources: @@ -69,4 +69,18 @@ List Test acc. http://www.sphinx-doc.org/en/stable/rest.html#lists-and-quote-lik crunchy, now would it? * - Gannet Ripple - 1.99 - - On a stick! \ No newline at end of file + - On a stick! + + +.. csv-table:: + :header: Header1, Header2, Header3 + + A, B, "These lines appear as one line, + even though they are written in two lines." + C, D, "| These lines appear as two lines, + | but they are indented, and my OCD will simply not allow it." + E, F, "| If I continue this line in another line, + it will appear in a new line." + G, H, "If there is a blank line between the two lines, + + there will be a blank line between the lines." \ No newline at end of file From e92b67d945e31cada70c53f05d007e1eb18c117c Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 14:39:46 +0100 Subject: [PATCH 21/30] latex math: fraction --- pvlib/data/variables_style-rules.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/data/variables_style-rules.csv b/pvlib/data/variables_style-rules.csv index fbea75ef9c..572fdb8fe1 100644 --- a/pvlib/data/variables_style-rules.csv +++ b/pvlib/data/variables_style-rules.csv @@ -35,4 +35,4 @@ photocurrent;photocurrent saturation_current;diode saturation current resistance_series;series resistance resistance_shunt;shunt resistance -tf;transposition factor, the gain ration of the radiation in inclinded plane to horizontal plane: :math:`\\frac{poa_global}{ghi}` +tf;transposition factor, the gain ration of the radiation in inclinded plane to horizontal plane: :math:`\frac{poa_global}{ghi}` From 50e9683b3494b5cb28879f1f16e0a6d3fc6d443f Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 14:45:32 +0100 Subject: [PATCH 22/30] underscore --- pvlib/data/variables_style-rules.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/data/variables_style-rules.csv b/pvlib/data/variables_style-rules.csv index 572fdb8fe1..2c08e61d6c 100644 --- a/pvlib/data/variables_style-rules.csv +++ b/pvlib/data/variables_style-rules.csv @@ -35,4 +35,4 @@ photocurrent;photocurrent saturation_current;diode saturation current resistance_series;series resistance resistance_shunt;shunt resistance -tf;transposition factor, the gain ration of the radiation in inclinded plane to horizontal plane: :math:`\frac{poa_global}{ghi}` +tf;transposition factor, the gain ration of the radiation in inclinded plane to horizontal plane: :math:`\frac{poa\_global}{ghi}` From c231d91a270e9e41560e5c55a586fe218e22b968 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 16:12:31 +0100 Subject: [PATCH 23/30] corrected title --- docs/sphinx/source/variables_style_rules.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 273ef49831..94c7e6d28c 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -1,8 +1,7 @@ .. _variables_style_rules: -************************ Variables and Symbols -************************* +===================== There is a convention on consistent variable names throughout the library: From ee35b815d0c9ffb685433839c75746865c52a923 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 16:33:40 +0100 Subject: [PATCH 24/30] removed test lists --- docs/sphinx/source/variables_style_rules.rst | 56 -------------------- 1 file changed, 56 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 94c7e6d28c..876232a7ef 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -27,59 +27,3 @@ For an definition and further help on symbols and units refer to the following s * `Terminology: definitions of the main quantities. `_ * `Acronyms in solar radiation `_ (more extensive list) - -.. _test: - -List Test acc. http://www.sphinx-doc.org/en/stable/rest.html#lists-and-quote-like-blocks - -* This is a bulleted list. -* It has two items, the second - item uses two lines. - -1. This is a numbered list. -2. It has two items too. - -#. This is a numbered list. -#. It has two items too. - - -* this is -* a list - - * with a nested list - * and some subitems - -* and here the parent list continues - - -.. list-table:: Frozen Delights! - :widths: 15 10 30 - :header-rows: 1 - - * - Treat - - Quantity - - Description - * - Albatross - - 2.99 - - On a stick! - * - Crunchy Frog - - 1.49 - - If we took the bones out, it wouldn't be - crunchy, now would it? - * - Gannet Ripple - - 1.99 - - On a stick! - - -.. csv-table:: - :header: Header1, Header2, Header3 - - A, B, "These lines appear as one line, - even though they are written in two lines." - C, D, "| These lines appear as two lines, - | but they are indented, and my OCD will simply not allow it." - E, F, "| If I continue this line in another line, - it will appear in a new line." - G, H, "If there is a blank line between the two lines, - - there will be a blank line between the lines." \ No newline at end of file From c80ebeb88100ac5a0578dcb70809bd31cc0e73eb Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 16:43:54 +0100 Subject: [PATCH 25/30] fix list --- docs/sphinx/source/variables_style_rules.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 876232a7ef..04b9d6e74a 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -20,10 +20,11 @@ For an definition and further help on symbols and units refer to the following s * with physics focus: * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) - * `Acronyms, Terminology and Units `_ - * `Plane orientations and radiation components `_ - * `Time references `_ - * `Units and conversion tool `_ - * `Terminology: definitions of the main quantities. `_ - * `Acronyms in solar radiation `_ (more extensive list) + + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + * `Units and conversion tool `_ + * `Terminology: definitions of the main quantities. `_ + * `Acronyms in solar radiation `_ (more extensive list) From b9de720405908e3917b2f8f65c96d064f73da981 Mon Sep 17 00:00:00 2001 From: dacoex Date: Tue, 19 Jan 2016 17:29:53 +0100 Subject: [PATCH 26/30] implemented change proposals in https://github.com/pvlib/pvlib-python/pull/103#discussion_r50128818 --- docs/sphinx/source/index.rst | 2 +- docs/sphinx/source/variables_style_rules.rst | 19 +++++++++---------- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 88e3e62511..84e202cadb 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -42,7 +42,7 @@ 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. +There is a :ref:`variable naming convention ` to ensure consistency throughout the library. Installation ============ diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 04b9d6e74a..4edecb8fac 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -16,15 +16,14 @@ For an definition and further help on symbols and units refer to the following s * `Reference Variable List by PVPMC `_ -* with technical focus in `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis `_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998) `_ -* with physics focus: - - * Explanation of Solar irradiation and solar geometry by `SoDa Service `_ and partner pages (http://www.soda-is.com/, http://pro.soda-is.com/) +* `IEC 61724:1998 -- Photovoltaic system performance monitoring - Guidelines for measurement, data exchange and analysis `_ ; the Indian Standard referencing the global IEC standard is available online: `IS/IEC 61724 (1998) `_ +* Explanation of Solar irradiation and solar geometry by `SoDa Service `_ - * `Acronyms, Terminology and Units `_ - * `Plane orientations and radiation components `_ - * `Time references `_ - * `Units and conversion tool `_ - * `Terminology: definitions of the main quantities. `_ - * `Acronyms in solar radiation `_ (more extensive list) + * `Acronyms, Terminology and Units `_ + * `Plane orientations and radiation components `_ + * `Time references `_ + * `Units and conversion tool `_ + * `Terminology: definitions of the main quantities. `_ + * `Acronyms in solar radiation `_ (more extensive list) +.. note:: These further references might not use the same terminology as :mod:pvlib. But the physical process referred to is the same. \ No newline at end of file From 4173532dbbab02b8ac1163f00756aa6a5300ed27 Mon Sep 17 00:00:00 2001 From: DaCoEx Date: Tue, 19 Jan 2016 22:59:26 +0100 Subject: [PATCH 27/30] coorections acc. https://github.com/pvlib/pvlib-python/pull/103/files#r50156306 --- .../data/{variables_style-rules.csv => variables_style_rules.csv} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pvlib/data/{variables_style-rules.csv => variables_style_rules.csv} (100%) diff --git a/pvlib/data/variables_style-rules.csv b/pvlib/data/variables_style_rules.csv similarity index 100% rename from pvlib/data/variables_style-rules.csv rename to pvlib/data/variables_style_rules.csv From af2f656053783dd780d68e509fcaa8acfbf79d9c Mon Sep 17 00:00:00 2001 From: DaCoEx Date: Tue, 19 Jan 2016 23:04:03 +0100 Subject: [PATCH 28/30] corrections as in https://github.com/pvlib/pvlib-python/pull/103/files#r50156306 --- .gitignore | 2 +- docs/sphinx/source/variables_style_rules.rst | 4 ++-- pvlib/data/variables_style_rules.csv | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 707f3a006e..444f214d0e 100644 --- a/.gitignore +++ b/.gitignore @@ -69,7 +69,7 @@ coverage.xml #Datafiles -#*.csv +*.csv # vi *.swp diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 4edecb8fac..897fb514ef 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -5,7 +5,7 @@ Variables and Symbols There is a convention on consistent variable names throughout the library: -.. csv-table:: List of used Symbols and Variables +.. csv-table:: List of used Variables and Parameters :file: ../../../pvlib/data/variables_style-rules.csv :delim: ; :header-rows: 1 @@ -26,4 +26,4 @@ For an definition and further help on symbols and units refer to the following s * `Terminology: definitions of the main quantities. `_ * `Acronyms in solar radiation `_ (more extensive list) -.. note:: These further references might not use the same terminology as :mod:pvlib. But the physical process referred to is the same. \ No newline at end of file +.. note:: These further references might not use the same terminology as *pvlib*. But the physical process referred to is the same. diff --git a/pvlib/data/variables_style_rules.csv b/pvlib/data/variables_style_rules.csv index 2c08e61d6c..9db1130a7e 100644 --- a/pvlib/data/variables_style_rules.csv +++ b/pvlib/data/variables_style_rules.csv @@ -35,4 +35,4 @@ photocurrent;photocurrent saturation_current;diode saturation current resistance_series;series resistance resistance_shunt;shunt resistance -tf;transposition factor, the gain ration of the radiation in inclinded plane to horizontal plane: :math:`\frac{poa\_global}{ghi}` +transposition_factor; the gain ratio of the radiation on inclined plane to global horizontal irradiation: :math:`\frac{poa\_global}{ghi}` From c820ee41342f89a4f14272b073c2667bbf7bfe45 Mon Sep 17 00:00:00 2001 From: DaCoEx Date: Tue, 19 Jan 2016 23:17:00 +0100 Subject: [PATCH 29/30] corrected file reference --- docs/sphinx/source/variables_style_rules.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 897fb514ef..3f63f84d51 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -6,7 +6,7 @@ Variables and Symbols There is a convention on consistent variable names throughout the library: .. csv-table:: List of used Variables and Parameters - :file: ../../../pvlib/data/variables_style-rules.csv + :file: ../../../pvlib/data/variables_style_rules.csv :delim: ; :header-rows: 1 :widths: 5, 5 From c5447f723fe31546293f8d6fe07e84aedc62e3ea Mon Sep 17 00:00:00 2001 From: DaCoEx Date: Tue, 19 Jan 2016 23:22:37 +0100 Subject: [PATCH 30/30] typos --- docs/sphinx/source/variables_style_rules.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst index 3f63f84d51..f1d45cbe02 100644 --- a/docs/sphinx/source/variables_style_rules.rst +++ b/docs/sphinx/source/variables_style_rules.rst @@ -12,7 +12,7 @@ There is a convention on consistent variable names throughout the library: :widths: 5, 5 :stub-columns: 1 -For an definition and further help on symbols and units refer to the following sources: +For a definition and further explanation on the variables, common symbols and units refer to the following sources: * `Reference Variable List by PVPMC `_