Merge branch 'main' of https://github.com/AlbertGallegoJimenez/shorel…

…ine-evolution-tool

README.md

@@ -9,7 +9,7 @@
 <br />
 <div align="center">
   <a href="https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool">
-    <img src="images/logo-tool.png" alt="Logo" width="80" height="80">
+    <img src="images/logo-tool.png" alt="Logo" width="270" height="200">
   </a>
 
 <h3 align="center">Shoreline Evolution Analysis</h3>
@@ -26,12 +26,10 @@
 ## About The Project
 
 <div align="center">
-  <a href="https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool">
-    <img src="images/framework.png">
-  </a>
-<br />
+  <img src="images/framework.png" width="400">
+</div>
 
-The analysis methodology is simple but effective, it is based on the analysis of shoreline variations by segmenting the area into profiles and evaluating linear regressions.
+The analysis methodology is simple but effective, it is based on the analysis of shoreline variations by segmenting the area into profiles and evaluating them with linear regressions.
 This tool is developed as part of a [Python Toolbox](https://pro.arcgis.com/en/pro-app/latest/arcpy/geoprocessing_and_python/a-quick-tour-of-python-toolboxes.htm) for ArcGIS Pro. The tools that make up the toolbox are designed in a very intuitive way with an interface that is fully integrated seamlessly into ArcGIS Pro.
 
 
@@ -47,19 +45,20 @@ The following is a list of the programs and libraries used in the tool, with the
 * Shapely (version 2.0)
 * Statsmodels (version 0.13)
 
-Regarding the data, this tool is based on the following two files:
-* Baseline (Vector - Polyline). This is the reference line used for the assessment of the evolution of the coastal stretch.
+In terms of data, this tool relies on the use of the following two files:
+* Baseline (Vector - Polyline). This is the reference line used to assess the evolution of the coastal stretch.
 * Shorelines (Vector - Polyline). These are the time series of the different shorelines on which the analysis will be based.
-  * For the correct functioning of the tool, the file must have a numeric id and date fields.
+  * For the correct functioning of the tool, the file must have a numeric ID and date fields.
 
 ### Installation
 
 0. Make sure you have cloned the base ArcGIS' anaconda environment so you can install more packages. More info [here](https://pro.arcgis.com/en/pro-app/latest/arcpy/get-started/clone-an-environment.htm).
-1. Download the content in the "src" folder.
-2. Open the Catalog Pane in ArcGIS Pro and open the Toolbox (.pyt file) to see the tools.
+1. Install both ```shapely``` and ```statsmodels``` packages.
+2. Download the content in the [src](https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool/tree/main/src).
+3. Open the Catalog Pane in ArcGIS Pro and open the Toolbox (.pyt) to see the tools.
 <div align="center">
   <a href="https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool">
-    <img src="images/open-toolbox.png" >
+    <img src="images/open-toolbox.png" width="600" >
   </a>
 
 
@@ -75,10 +74,9 @@ Project Link: [https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool]
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
+[forks-shield]: https://img.shields.io/github/forks/AlbertGallegoJimenez/shoreline-evolution-tool.svg?style=for-the-badge
 [forks-url]: https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool/forks
-[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
+[stars-shield]: https://img.shields.io/github/stars/AlbertGallegoJimenez/shoreline-evolution-tool.svg?style=for-the-badge
 [stars-url]: https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool/stargazers
 [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
 [linkedin-url]: https://www.linkedin.com/in/albert-gallego-jimenez
-[product-screenshot]: images/framework.png