Documentation updated

Readme.md

@@ -1,47 +1,85 @@
-# Readme
+# csv2kml
 
-# Basic Instructions of Repository 
+**This repository provides a .py code to convert a .csv database to a .kml archive, used to store markers for Google Earth and Google Maps.** In this document, it's explained how to use it and how it works, in order to help users modify it for future projects.  
 
-**This is the main repository of your project, please consider to follow the next rules to work in a collaborative way with other fellows.**
+This code is based on the **Sample CSV format.csv** file in this repository, and works for that structure. It can be modified to make it usable for other data.
 
+## Requirements
 
-## Readme and Wiki 
+To be able to run this code it is important to **install the modules: csv and simplekml**. Using:  
 
-Use `Readme.md` file to let others know how to use, connect (circuits) or implement the repository elements in a basic and simple way. For detailed information, remark notes, tutorials, or documentation (reports and thesis) of the repository use the **Wiki** Tab in the same repository.
+    pip install python-csv
+    pip install simplekml
 
-*Considers that the Wiki page is not considered by the git system*.
+## Code
 
+### Reading csv file
 
+The function open is used to open any type of file, it's important to provide its path and open it in read mode using encoding UTF-8, the name of the variable where the stream is saved is *file*, however it can be named differently. Next, this variable can be passed to the csv reader using its *reader* function. The header can be extracted by executing csv *next* function. All of this is done in the following lines:
 
-## Projects and Issues tab 
+    with open(r'D:\aleja\Downloads\cosa\Pozos OOAPAS_1.csv', 'r', encoding='UTF-8') as file:
+        reader = csv.reader(file)
+        headers = next(reader)
 
-To organize your progress, use the issues and projects tabs. In this way, it is possible to schedule your tasks and set milestones. Thus, each week can start by reviewing the pending tasks, organize your week tasks, and at the end of the week check and mark your progress.
+Now, it's necessary to create a kml object where the data is going to be stored before creating the output file, that is:
 
-### Issues and Labels
+        kml = simplekml.Kml()
 
-Let us start by setting some milestones (proposal, prototype, software function, etc.), set a Due Date, and its description. With your milestones, it will be easy to organize issues and track your progress.
+Once that is done, it's possible to extract data from the rest of the rows and start building strings keeping in mind that rows from a csv file work as if they were arrays. In this case, according to the information retrieved, this process is done with the following code:
 
-After defining a milestone, 
+        # Iterate over the rows in the CSV file
+        for row in reader:
+            # Extract the data for each field in the row
+            name = row[1]
+            pressure = "Sensor de presion: " + row[2] + "  |  "  + row[3]
+            starter = "Arrancador: " + row[4] + "  |  "  + row[5]
+            flow = "Caudalimetro: " + row[6] + "  |  "  + row[7]
+            power = "Analizador de potencia: " + row[8] + "  |  "  + row[9]
+            switch = "Interruptor de presion: " + row[10] + "  |  " + row[11]
+            rtu = "RTU: " + row[12] + "  |  "  + row[13]
+            modem = "Modem: " + row[14] + "  |  "  + row[15]
+            ID = "ID: " + row[18]
+            level = "Sensor de nivel: " + row[19] + "  |  " + row[20]
 
+            latitude = float(row[17])
+            longitude = float(row[16])
 
-- **task**
-- **bug** 
-- **improve**
-- **
+### Marker description box
 
-The `git-template` includes 9 basic labels to use each time you create an issue. These labels are detailed next:
+We want this information to be displayed in an description box of the marker. To achieve that, a function with an undefined number of arguments is used, which takes any number of strings and concatenate them adding a *<BR>* between them, to display them in different lines each.
 
-- bug: Somethign is not working as expected or getting wrong results 
-- duplicated: This issue or pull request already exists 
-- further work: General advices to be considered in future elements, projects or submodules 
-- help wanted: Some help is required by supervisors; directions, raw material, material, review results, or laboratory assistance 
-- improve: Something has to be improved or rebuiled to improve expected results 
-- question: Something needs a fast review or guidance to focus the aim of the project 
-- submodules: The project should considers to create a submodule element to integrate in this project
-- task: Assigned task to complete a milestone or project element; the assigned collaborators have to complete the task 
-- wiki: Elements or information to be included in the Wiki page 
+    def description(*argv):
+        """Creates a description block with the arguments of the function"""
 
-### Projects
-**Considers that this is the main repository. Thus, create projects for main elements (circuit stage, specific behaivior, component, document, simulation, or submodule, etc.) to manage components or submodules related with the main repository**.
+        block = ''
+        check = 0
+        for arg in argv:
+            if arg == argv[0] and check == 0:
+                block = block + arg
+                check = 1
+            else:
+                block = block + '<BR>' + arg
+            
+        return block
 
-In the project always create three main boards: Todo, In Progress and Done. 
+When calling this function with the data read from the csv, we get:
+
+            datos = description(name, ID, pressure, starter, flow, power, switch, rtu, modem, level)
+
+### Creating a new point in kml
+
+Finally, we create a new point in the kml where the name is the string that will appear next to the marker in the map, description is the information to place in the description box, and coords are the coordinates where the marker will be placed. The size of the marker can be defined with *scale* and the icon to show can be different, choosing it from Google's website.
+
+            point = kml.newpoint(name=name, description=datos, coords=[(longitude, latitude)])
+            point.style.labelstyle.scale = 1
+            point.style.iconstyle.icon.href = 'http://maps.google.com/mapfiles/kml/shapes/water.png'
+
+### Saving file
+
+To print the file, we can use:
+
+        print(kml.kml())
+
+And to save it we use kml *save* method, including the path where it is desired to store the file.
+
+        kml.save(r'D:\aleja\Downloads\cosa\Pozos OOAPAS_1.kml')