Final commit tests and readme

.gitignore

@@ -1,8 +1,9 @@
 __pycache__
+.pytest_cache
 .ipynb_checkpoints
 *.tif
 csv/dataset_postprocessed.csv
-data/
+data2/
 data_prueba/
 vm_data/
-daily.md
+ml/

LICENSE

@@ -0,0 +1,9 @@
+ The MIT License (MIT)
+
+Copyright © 2023 Jesús Aldana Martín
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -29,30 +29,33 @@ Code functions:
 To run locally the script you just need to install all libraries specified in the requirements.txt. The code below showw how can you do it.
 
 ```Python
-pip install -r requirements.txt
+python3 pip install -r requirements.txt
 ```
 
 ## Usage
 
 Use all the functions as you wish or run the whole workflow with the launch.sh app. In order to run the script please, replace the 'elements' with your own paths.
 
 ```Shell
-bash launch.sh -r 'raster path' -s 'shp path' -o 'output path' -t 'delete tmp'
+bash launch.sh -r <raster path> -s <shp path> -o <output path> -t <delete tmp>
 ```
 
-## Credits
+## Testing
 
----
-
-## The MIT License (MIT)
+The framework used for the unit tests is pytests. In order to run the tests:
 
-Copyright © 2023 <Yo>
+```Python
+pytest tests/
+```
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Output example
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+![title](../satelite_images_sigpac/assets/images/sgpc.png)
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+For extra information check out the [showcase.ipynb](showcase.ipynb) notebook.
 
+---
 
+## The MIT License (MIT)
 
+This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.