User Tools

Site Tools


codes:usermanual

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
codes:usermanual [2019/09/27 08:13]
jlsolano [1.3. Frequently Asked Questions]
codes:usermanual [2020/05/16 10:55]
jlsolano [1.3. Frequently Asked Questions]
Line 3: Line 3:
 ====== 1. Software setup and data submission ====== ====== 1. Software setup and data submission ======
  
-Each Brewer spectrophotometer communicates with a local PC where the raw data is stored. To upload the raw data from the client PC to the Eubrewnet database, a code written in Python 2.7 has to be installed ​in the local PC (or any other computer which has access to the Brewer raw data). When this code is executed the local (client) PC  connects to Eubrewnet'​s data server. Then, the local Brewer files and all related information (file size, modification date, etc) are compared to the data already stored in Eubrewnet. Only the files which are either new or have changed are then submitted. This process should be repeated at regular time intervals (~15 mins). ​+Each Brewer spectrophotometer communicates with a local PC where the raw data is stored. To upload the raw data from the client PC to the Eubrewnet database, a code written in Python 2.7 has to be set up in the local PC (or any other computer which has access to the Brewer raw data). When this code is executed the local (client) PC  connects to Eubrewnet'​s data server. Then, the local Brewer files and all related information (file size, modification date, etc) are compared to the data already stored in Eubrewnet. Only the files which are either new or have changed are then submitted. This process should be repeated at regular time intervals (~15 mins). ​
  
-This Section ​provides information ​to download and setup Eubrewnet'​s client software in your local PC. A quick setup guide is provided in Sec. **1.1**. In Sec. **1.2** we describe in detail how to setup and configure the software. Finally, Sec. **1.3** contains a FAQ.+This Section ​explains how to download and setup Eubrewnet'​s client software in your local PC. A Quick setup guide is provided in Sec. **1.1**. In Sec. **1.2** we describe in detail how to setup and configure the software. Finally, Sec. **1.3** contains a FAQ.
 ---- ----
  
Line 27: Line 27:
  
 ==== 1.1.2. Unzip the downloaded file to a pre-existing folder ==== ==== 1.1.2. Unzip the downloaded file to a pre-existing folder ====
 +
 +Create a new folder anywhere in your system and extract all the contents of the zip file there. Note that a new folder will **not** be created when you unzip the downloaded file.
 +
 +Depending on the version of Eubrewnet'​s software client, the files extracted will be
 +
 +**a)** for the client executable for Windows: ''​refresh.exe''​ and ''​example_client.ini''​
 +
 +**b)** for client Python script: ''​refresh.py'',​ ''​example_client.ini'',​ ''​refreshdb.py'',​ ''​util.py'',​ ''​xmlrpcproxy.py'',​ ''​log.py'',​ ''​alive.py''​ (in total, 6 ''​.py''​ files and 1 ''​.ini''​)  ​
 ---- ----
  
Line 97: Line 105:
  
 Once Python 2.7 is up and running, download Eubrewnet'​s client software from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_python.zip]]. Then, unzip the file to your preferred location, edit the ''​client.ini''​ file, and run the script from a console with ''​python refresh.py''​ to submit your data Once Python 2.7 is up and running, download Eubrewnet'​s client software from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_python.zip]]. Then, unzip the file to your preferred location, edit the ''​client.ini''​ file, and run the script from a console with ''​python refresh.py''​ to submit your data
 +
 +----
 +
 +=== If setup fails ===
 +
 +If you have a very old Windows computer which can't run the compiled .exe of the new version of the client, and furthermore can't run the official Python2.7 installer to use the python version, try the following options, sorted in order of complexity:
 +
 +** Easiest) ** Try to use the .exe of the old version of the client, available from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_exe_2014.zip]]
 +
 +** Normal) ** If you have an old setup of Python in your computer, try to use the python version of the old client, available from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_python_2014.zip]]
 +
 +** Most difficult) ** Download the file [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​Python27_32bits.zip]] and follow the instructions in the ''​running_refresh_client.txt''​ file included in the zip. In short, the zip contains a folder with the Python27 setup of a WindowsXP 32-bits computer, and you can you use it to run the python version of the new client (available from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_python.zip]])
 +
 +
 ---- ----
  
Line 201: Line 223:
  
 Despite all these changes, note that the old and new versions of Eubrewnet'​s client software share the same code at their core, so you should be able to use either version to submit your data without making any change to your ''​client.ini''​ file. Despite all these changes, note that the old and new versions of Eubrewnet'​s client software share the same code at their core, so you should be able to use either version to submit your data without making any change to your ''​client.ini''​ file.
 +----
 +**Q** Do you plan any further updates to Eubrewnet'​s software client?
 +
 +**A** Yes, in the near future we expect to release a Python 3-compatible version.
 +
 +Down the road, we are also looking into other quality of life improvements,​ such as automatically writing a log file with all the on-screen information,​ as suggested by V. Savastiouk. If you have suggestions,​ remember that you can reach us at [[eubrewnet@aemet.es]]!
 ---- ----
  
Line 286: Line 314:
  
 **A** Most likely, the registration of your Brewer in Eubrewnet has not been completed yet. Please, contact us at [[eubrewnet@aemet.es]] **A** Most likely, the registration of your Brewer in Eubrewnet has not been completed yet. Please, contact us at [[eubrewnet@aemet.es]]
 +
 +----
 +
 +**Q** My Windows computer is very old and I can't setup the refresh client following the steps in the Quick Setup -- help!!!
 +
 +**A** If you have a very old Windows computer which can't run the compiled .exe of the new version of the client, and furthermore can't run the official Python2.7 installer to use the python version, try the following options, sorted in order of complexity:
 +
 +** Easiest) ** Try to use the .exe of the old version of the client, available from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_exe_2014.zip]]
 +
 +** Normal) ** If you have an old setup of Python in your computer, try to use the python version of the old client, available from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_python_2014.zip]]
 +
 +** Most difficult) ** Download the file [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​Python27_32bits.zip]] and follow the instructions in the ''​running_refresh_client.txt''​ file included in the zip. In short, the zip contains a folder with the Python2.7 setup of a WindowsXP 32-bit computer, and you can you use it to run the python version of the new client (available from [[http://​rbcce.aemet.es/​eubrewnet/​static/​files/​client_python.zip]])
 +
 ---- ----
 ---- ----
codes/usermanual.txt · Last modified: 2023/11/06 15:31 by jlsolano