Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbertGallegoJimenez committed Jul 26, 2024
1 parent e0d9614 commit 1b183a7
Showing 1 changed file with 12 additions and 19 deletions.
31 changes: 12 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,33 +35,28 @@ This tool is developed as part of a [Python Toolbox](https://pro.arcgis.com/en/p
<!-- GETTING STARTED -->
## Getting Started

### Prerequisites

Check that you have installed all the required libraries used in the toolbox. All packages with their tested versions are listed in [requirements.txt](https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool/tree/main/requirements.txt). Note that when working with a cloned version of the ArcGIS ```anaconda``` environment there are already pre-installed libraries, those that are not and need to be installed manually are the following:

* ```shapely```
* ```statsmodels```
* ```cartopy```
* ```seaborn```
* ```contextily```

_From ArcGIS version 3.2, both ```statsmodels``` and ```seaborn``` packages are included in the base ArcGIS ```anaconda``` environment._
### Input data

In terms of data, this tool relies on the use of the following two files:
* <ins>**Baseline**</ins> (Vector - Polyline). This is the reference line used to assess the evolution of the coastal stretch. It can be digitized manually by the user with the help of a background orthophoto, it is recommended to place the baseline **inland**. The baseline must capture the general orientation of the coast.
* <ins>**Baseline**</ins> (Vector - Polyline). This is the reference line used to assess the evolution of the coastal stretch. It can be digitized manually by the user with the help of a background orthophoto, taking care to place the baseline **inland** (behind all shorelines). The baseline must capture the general orientation of the coast.
* <ins>**Shorelines**</ins> (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**.

> [!WARNING]
> Note that both **Baseline** and **Shorelines** must be defined in a projected coordinate system, not a geographic coordinate system.
> Note that both **Baseline** and **Shorelines** must be defined in a projected coordinate system.
> These layers must be stored as **Feature Classes in the Geodatabase** of the ArcGIS project.
### 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. Install the required packages listed in the *Prerequisites* section if they are not already installed.
2. Download the content in the [src](https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool/tree/main/src) folder.
3. Open the Catalog Pane in ArcGIS Pro and open the downloaded Toolbox (.pyt) to see the tools.
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. Clone this repo on your computer.
2. Check that you have installed all the required libraries used in the toolbox. All packages with their tested versions are listed in [requirements.txt](https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool/tree/main/requirements.txt). To install the packages, follow these steps:
1. Open an Anaconda terminal and activate the cloned version of the ArcGIS Anaconda environment. (_If you don't have Anaconda installed on your computer, you can try to open the ArcGIS terminal located in "C:\Program Files\ArcGIS\Pro\bin\Python\Scripts\proenv.bat"_)
2. Navigate to the main directory of your local clone of the repo and install the packages via pip:
``` shell
pip install -r requirements.txt
```
3. Open the Catalog Pane in ArcGIS Pro and add the Python Toolbox (.pyt) to see the tools.
<div align="center">
<a href="https://github.com/AlbertGallegoJimenez/shoreline-evolution-tool">
<img src="images/open-toolbox.png" width="600" >
Expand All @@ -77,8 +72,6 @@ For further details on how to run the different tools that make up the toolbox,
<a href="https://arcg.is/ez9KK0">
<img src="images/guide-website.PNG" alt="Website thumbnail" width="50%">
</a>

*The platform used to develop the website is ArcGIS StoryMaps, if you are interested in more details click [here](https://www.esri.com/en-us/arcgis/products/arcgis-storymaps/overview).*
</div>

<!-- CONTACT -->
Expand Down

0 comments on commit 1b183a7

Please sign in to comment.