Eubrewnet Wiki

User Tools

Site Tools

Trace:
codes:checklist

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
codes:checklist [2016/12/01 10:58] – bhcruzcodes:checklist [2022/10/20 07:54] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== CHECKLIST ====== ====== CHECKLIST ======
-**Definition of the checklist functions that are developed in [[http://rbcce.aemet.es/eubrewnet|Eubrewnet]]**+**Definition of the checklist functions that are developed in [[http://eubrewnet.aemet.es/eubrewnet|Eubrewnet]]**
  
-The users with the right permissions have access to some functions to directly check some tests that can be do to Brewers. The root of the access functions is the same for all http://rbcce.aemet.es/eubrewnet/data/checklist. From this point users can select different function. As Example **Check SI**.+The users with the right permissions have access to some functions to directly check some tests that can be do to Brewers. The root of the access functions is the same for all http://eubrewnet.aemet.es/eubrewnet/data/checklist. From this point users can select different function. As Example **Check SI**.
  
 The SI check function tests if the Brewer Operators perform Sittings periodically. The Regional Brewer Calibration Center Europe has stablished a standard of one test every week. The check is OK (returns True as result) if the number of Sittings per week is greater or equal to one. It is possible to modify the reference to change the number of sittings per week. The SI check function tests if the Brewer Operators perform Sittings periodically. The Regional Brewer Calibration Center Europe has stablished a standard of one test every week. The check is OK (returns True as result) if the number of Sittings per week is greater or equal to one. It is possible to modify the reference to change the number of sittings per week.
  
-  * It receives as inputs brewerid, date and enddate: [[http://rbcce.aemet.es/eubrewnet/data/checklist/SI?brewerid=183&date=2016-11-15&enddate=2016-11-21|Use of check SI with brewerid, date and enddate]] +  * It receives as inputs brewerid, date and enddate: [[http://eubrewnet.aemet.es/eubrewnet/data/checklist/SI?brewerid=183&date=2016-11-15&enddate=2016-11-21|Use of check SI with brewerid, date and enddate]] 
-  * Optionally, a reference (v2) input parameter can be provided (The 1.0 default value is changed by v2, if there's no need to perform at least one Sitting per week): [[http://rbcce.aemet.es/eubrewnet/data/checklist/SI?brewerid=214&date=2016-11-01&enddate=2016-11-14&v2=0.5|Use of check SI changing]]+  * Optionally, a reference (v2) input parameter can be provided (The 1.0 default value is changed by v2, if there's no need to perform at least one Sitting per week): [[http://eubrewnet.aemet.es/eubrewnet/data/checklist/SI?brewerid=214&date=2016-11-01&enddate=2016-11-14&v2=0.5|Use of check SI changing]]
  
 **Description of the SI Check Function**: **Description of the SI Check Function**:
Line 13: Line 13:
   * Description: The Sitting tests have to be done periodically. The RBCCE has stablished a standard of one test every week. The test is passed if the number of sittings per week during period is greater or equal to v2 (1 by default). v2 can be passed as parameter to change the reference value. For less than a sitting per week, use decimal values: for example, 0.25 means 1 sitting every month.   * Description: The Sitting tests have to be done periodically. The RBCCE has stablished a standard of one test every week. The test is passed if the number of sittings per week during period is greater or equal to v2 (1 by default). v2 can be passed as parameter to change the reference value. For less than a sitting per week, use decimal values: for example, 0.25 means 1 sitting every month.
   * Inputs:   * Inputs:
-      - brewerid: see [[codes:checklist#common_inputs|Brewerid in common inputs]] +      - brewerid: see [[codes:checklist#common|Brewerid in common inputs]] 
-      - date: see [[codes:checklist#common_inputs|Date in common inputs]] +      - date: see [[codes:checklist#common|Date in common inputs]] 
-      - enddate: see [[codes:checklist#common_inputs|Enddate in common inputs]] +      - enddate: see [[codes:checklist#common|Enddate in common inputs]] 
-      - v2: see [[codes:checklist#v2|V2]]. New reference to compare if there are enough Sittings during period+      - v2: see [[codes:checklist#common|V2]]. New reference to compare if there are enough Sittings during period
   * Output: Number of sittings during daterange and dates   * Output: Number of sittings during daterange and dates
       - result: True if the number of Sittings is greater or equal        - result: True if the number of Sittings is greater or equal 
Line 23: Line 23:
       - comments: List of dates when the sittings have been done       - comments: List of dates when the sittings have been done
  
-There is a [[codes:checklist#check_functions|Check Function Table]] with a summary of the available functions to perform tests and their links as example. The extended documentation for each function can be directly access from the table using the links in the column //Long Description//. There is a [[https://goo.gl/h0THF3|Google Spread Sheet]] with the complete table with all the information in one view.+There is a [[https://goo.gl/h0THF3|Checklist Table]] with a summary of the available functions to perform tests and their links as example. It has the extended documentation for each function.
  
-There are common inputs for the functions as the parameter brewerid wich can be used in almost every function. The description can be found in the [[codes:checklist#common|COMMON SECTION]].+There are common inputs for the functions as the parameter brewerid wich can be used in almost every function are listed in the [[codes:checklist#common_inputs|common inputs]] section. A short description of the outpus can be found in the [[codes:checklist#common_outputs|common outputs]] section. 
 + 
 +The functions can be run building a complete checklist with all tests in [[http://eubrewnet.aemet.es/eubrewnet/checklist/check|EUBREWNET CHECKLIST]] which can be obtained from the Menu - User - Checklist - Check. The list of all predefined date periods is in the [[codes:checklist#default_date_ranges|Default Date Ranges]] section.
  
 **For security purposes user authentication has been added to this tools and their use is registered.** **For security purposes user authentication has been added to this tools and their use is registered.**
Line 32: Line 34:
  
 ===== COMMON ===== ===== COMMON =====
 +==== Common Inputs====
 Almost all functions receive the following inputs, too: Almost all functions receive the following inputs, too:
-  * brewerid: +  * **brewerid**: Brewer identification number 
-  * date: +  * **date**: Start date of a period (yyyy-mm-dd format) 
-  * enddate: +  * **enddate**: End date of a period (yyyy-mm-dd format). If it is not provided, the period will be only one day. 
-  * v2 (optional): There are functions with reference values that can change depending on Brewer. Commonly +  * **v2** (optional): There are functions with reference values that can change depending on Brewer. Commonly 
-^ Parameter ^ Description ^ Example ^ + 
-^ brewerid | Brewer identification number | [[http://rbcce.aemet.es/eubrewnet/data/check/SI?brewerid=157&date=2015-01-01&format=text|Get function with brewerid input parameter]] | +---- 
-^ date | Date in YYYY-MM-DD format | [[http://rbcce.aemet.es/eubrewnet/data/get/DS?brewerid=157&date=2015-01-01&format=text|Get function with date input parameter]] | + 
-^ enddate | Date in YYYY-MM-DD format. If provided, the function will return the query in a date range | [[http://rbcce.aemet.es/eubrewnet/data/get/DS?brewerid=157&date=2015-01-01&enddate=2015-01-05&format=text|Get function with enddate input parameter]] | +==== Common Outputs==== 
-Examples of connections in [[codes:dbaccess#matlab|matlab]] and [[codes:dbaccess#python|python]] are provided for understanding.+All functions return the following outputs: 
 +  * **result**: First returned value. True/False value if test is passed or not. Depending on the test, it will represent that the checked values are between limits of an interval, if all files are received, if process could be done... 
 +  * **v1**: Second returned value. Commonly a set of measurements that have been gotten during process. Depending on the test it will be a list of measurements by date and time, an average value, detected values which rise a condition (for example, outliers)... 
 +  * **v2**: Third returned value. Commonly it’s a complement value of V1 or a reference that can be passed to the function. Depending on the test it will be a list of values (for example, v1 contains passed values and v2 contains failed values), a reference value (Sitting function admits a v2 value to change the limit of one test / week), a calculation (v1 and v2 are the slope and v2 is the intercept of a linear regression)... 
 +  * **comments**: Fourth returned value. In occasions, there is needed other value to finally understand a test. Depending on the test it will be a comment itself (For example, “Missing B/UV Files detected”), a percentage value (Comparison between passed measurements and total measurements), a list of complementary information (Dates where tests fail), a complementary value (Correlation coefficient in a linear regression)... 
 + 
 +---- 
 + 
 +===== Default Date Ranges ===== 
 + 
 +^ Section ^ Function ^ Default Date Range (days) ^ 
 +^ Instrument Operation | Setup and Level | 28 |  
 +^ Instrument Operation | Sitting | 28 |  
 +^ Instrument Operation | Files Read | 15 |  
 +^ Instrument Historic | HP/HG | 365 |  
 +^ Instrument Historic | Run Stop | 365 |  
 +^ Instrument Historic | Deadtime | 365 |  
 +^ Instrument Historic | SL R6 Temp | 365 |  
 +^ Instrument Historic | SL R5 Temp | 365 |  
 +^ Instrument Historic | F5 Intensity | 365 |  
 +^ Instrument Weekly | HP/HG | 15 |  
 +^ Instrument Weekly | Deadtime Reference | 15 |  
 +^ Instrument Weekly | Deadtime STD | 15 |  
 +^ Instrument Weekly | Run Stop | 15 |  
 +^ Instrument Weekly | AP | 15 |  
 +^ Instrument Weekly | SL Current | 15 |  
 +^ Instrument Weekly | SL Voltage | 15 |  
 +^ Instrument Weekly | HT Voltage | 15 |  
 +^ Instrument Weekly | SL R6 | 15 |  
 +^ Instrument Weekly | SL R5 | 15 |  
 +^ Instrument Weekly | SL intensity | 15 |  
 +^ Instrument Weekly | SL Outliers | 15 |  
 +^ SL Temperature and Filter Analysis | Weekly SL Temperature Linearity | 15 |  
 +^ SL Temperature and Filter Analysis | Weekly SL R6 Temperature Dependence | 15 |  
 +^ SL Temperature and Filter Analysis | Weekly Temperature Range | 15 |  
 +^ SL Temperature and Filter Analysis | Monthly SL Temperature Linearity | 45 |  
 +^ SL Temperature and Filter Analysis | Monthly SL R6 Temperature Dependence | 45 |  
 +^ SL Temperature and Filter Analysis | Monthly Temperature Range | 45 |  
 +^ SL Temperature and Filter Analysis | Monthly Filter Attenuation | 45 |  
 +^ SL Temperature and Filter Analysis | Monthly Filter Linearity | 45 |  
 +^ SL Temperature and Filter Analysis | Monthly Filter Corrections | 45 |  
 +^ Wavelength | Sun Scan Performed | 45 |  
 +^ Wavelength | Calc Step | 45 |  
 +^ Wavelength | OSC | 45 |  
 +^ Wavelength | SC Range | 45 |  
 +^ Wavelength | HS | 15 |  
 +^ Wavelength | HL | 15 | 
codes/checklist.1480589916.txt.gz · Last modified: 2016/12/01 10:58 by bhcruz