Skip to content

Commit

Permalink
Remove typos from basic install guide and remove installation of geop…
Browse files Browse the repository at this point in the history
…andas
  • Loading branch information
2320sharon committed Dec 12, 2024
1 parent ac99a89 commit 5d7f95a
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/basic-install-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,19 +69,19 @@ To get started, you'll need to install Anaconda, which is a free and open-source
- Only install these dependencies if you plan to use CoastSeg's Zoo workflow notebook.
- **Warning** installing tensorflow will not work correctly on Mac see for more details [Mac install guide](https://satelliteshorelines.github.io/CoastSeg/mac-install-guide/)

```bash
pip install tensorflow==2.16.2
pip install transformers
pip install tf-keras==2.16
```
```bash
pip install tensorflow==2.16.2
pip install transformers
pip install tf-keras==2.16
``
## Method #2: Install from Pypi
**1.Create an miniconda/Anaconda environment**
- This command creates an anaconda environment named `coastseg` and installs `python 3.10` in it.
```bash
conda create --name coastseg python=3.11 -y
conda create --name coastseg python=3.10 -y
```
**2.Activate your conda environment**
Expand All @@ -95,20 +95,20 @@ conda activate coastseg
<img src="https://user-images.githubusercontent.com/61564689/184215725-3688aedb-e804-481d-bbb6-8c33b30c4607.png"
alt="coastseg activated in anaconda prompt" width="350" height="150">
**3.Install Conda Dependencies**
- CoastSeg requires `geopandas` to function properly so they will be installed in the `coastseg` environment.
- [Geopandas](https://geopandas.org/en/stable/) has [GDAL](https://gdal.org/) as a dependency so its best to install it with conda.
- Make sure to install geopandas from the `conda-forge` channel to ensure you get the latest version and to avoid dependency conflicts
**3.Install the CoastSeg from PyPi**
```bash
conda install -c conda-forge geopandas gdal -y
pip install coastseg
```
**4.Install the CoastSeg from PyPi**
**4.Install GDAL from conda-forge**
- CoastSeg requires `gdal` to function properly and requires it to be installed from `conda-forge` due to how it is configured in the conda environment.
- Make sure to install `gdal` from the `conda-forge` channel to ensure you get the latest version and to avoid dependency conflicts.
```bash
pip install coastseg
conda install -c conda-forge gdal -y
```
Expand Down

0 comments on commit 5d7f95a

Please sign in to comment.