diff --git a/docs/basic-install-guide.md b/docs/basic-install-guide.md index c0a1cb1a..2be0b932 100644 --- a/docs/basic-install-guide.md +++ b/docs/basic-install-guide.md @@ -2,9 +2,9 @@ We recommend that you use Windows 10, Windows 11, or Ubuntu Linux. Mac users, please see [Mac install guide](https://satelliteshorelines.github.io/CoastSeg/mac-install-guide/) -In order to use Coastseg you need to install Python packages in an environment. We recommend you use [Anaconda](https://www.anaconda.com/products/distribution) or [Miniconda](https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html) to install the python packages in an environment for Coastseg. +In order to use Coastseg you need to install Python packages in an environment. We recommend you use [Miniforge](https://conda-forge.org/miniforge/) to install the python packages in an environment for Coastseg. -After you install miniconda/Anaconda on your PC, open the Anaconda prompt or Terminal in Mac and Linux and use the `cd` command (change directory) to go the folder where you have downloaded the Coastseg repository. +After you install Anaconda/miniforge on your PC (see our [How to Install Miniforge](https://satelliteshorelines.github.io/CoastSeg/install-miniforge/)), open the Anaconda Prompt/Miniforge Prompt in Windows or Terminal in Mac and Linux. Then use the `cd` command (change directory) to go the folder where you have downloaded the Coastseg repository. We highly recommend you install CoastSeg using `conda` following the instructions in [Install from conda-forge](#install-from-conda-forge). @@ -13,14 +13,18 @@ We highly recommend you install CoastSeg using `conda` following the instruction 1. Make sure you have git installed and if not please download it [here](https://git-scm.com/downloads) - This install `git` as well as `git bash` on your computer 2. Open a terminal (or if you are on windows open `git bash`) and run the command + ```bash git --version ``` + - It should return something like this if you have it git installed + ```bash git --version git version 2.47.0.windows.1 ``` + 3. Open a terminal that has git installed, then use the `cd` command ( `c`hange `d`irectory) to switch the location you want to install CoastSeg - Then use the `git clone https://github.com/SatelliteShorelines/CoastSeg.git --depth 1` to install the code from github - Once the git clone command finishes use the `cd` command ( `c`hange `d`irectory) to switch the CoastSeg directory containing the code you installed. @@ -34,22 +38,16 @@ We highly recommend you install CoastSeg using `conda` following the instruction ## Method #1: Install from conda-forge (Recommended) -**0. Install Anaconda** +**0. Install MiniForge/Anaconda** -To get started, you'll need to install Anaconda, which is a free and open-source distribution of Python and R that comes with essential packages and tools for scientific computing and data science. Here’s how you can install it: +To get started, you'll need to install MiniForge, which is a free and open-source distribution of Python and R that comes with essential packages and tools for scientific computing and data science. -1. Install Anaconda by following the instructions at [Anaconda install page](https://docs.anaconda.com/anaconda/install/) +Follow our guide here: [How to Install Miniforge](https://satelliteshorelines.github.io/CoastSeg/install-miniforge/) -2. Verify the installation - - Once the installation is complete, open your terminal (or Anaconda Prompt on Windows). - - Type the following command to check if Anaconda is installed correctly: +Note: CoastSeg will work in Anaconda, however since not all users can use Anaconda due to the EULA we provide only provide installation instructions for Miniforge. - ```bash - conda --version - - ``` -**1.Create an miniconda/Anaconda environment and Activate it** +**1.Create an Conda Environment and Activate it** - This command creates an anaconda environment named `coastseg` and installs `python 3.10` in it. @@ -58,22 +56,26 @@ To get started, you'll need to install Anaconda, which is a free and open-source conda activate coastseg ``` + ![install conda in miniforge](https://github.com/user-attachments/assets/9a6b9cde-f82f-4395-85fd-720ef986b00f) + **2.Install coastseg** ```bash conda install -c conda-forge coastseg ``` + ![install coastseg from conda forge](https://github.com/user-attachments/assets/e2126a94-aaa2-49b9-86e7-6ede187dfa53) + **3.(Optional) Install Optional Dependencies** - 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 diff --git a/docs/install-miniforge.md b/docs/install-miniforge.md new file mode 100644 index 00000000..05a4010e --- /dev/null +++ b/docs/install-miniforge.md @@ -0,0 +1,43 @@ +# Miniforge Installation Guide + +Miniforge is a minimal installer for conda specifically designed to install conda itself along with its dependencies and a small number of external packages. It is an alternative to Miniconda and Anaconda that uses conda-forge as the default channel. + +## Step 1: Download Miniforge + +Visit the [Miniforge GitHub releases page](https://conda-forge.org/miniforge/) to download the installer suitable for your system (Windows, macOS, or Linux). + +Choose the correct installer for your system: + +- For Windows: `Miniforge3-Windows-x86_64.exe` + +### Windows + +1. Run the downloaded executable. +2. Follow the on-screen instructions to complete the installation. + +## Step 2: Verify Miniforge Installation + +1.Open the Miniforge Prompt + +![miniforg_terminal](https://github.com/user-attachments/assets/11e05395-2165-4986-bc67-10d51e79c27b) + +2.Verify the installation: + +- Type the following command to check if conda is installed correctly: + + ```bash + conda --version + + ``` + +![conda--version](https://github.com/user-attachments/assets/febd08a6-2ea8-4158-aa51-f3b319a778ef) + +## Step 3: Follow Guide to Install CoastSeg in Miniforge Prompt + +1.Follow the rest of the guide to install CoastSeg in Miniforge Prompt [here](https://satelliteshorelines.github.io/CoastSeg/basic-install-guide/) + + - Below are a few screenshots that should show you how installing CoastSeg in MiniForge should look + +![install conda in miniforge](https://github.com/user-attachments/assets/9a6b9cde-f82f-4395-85fd-720ef986b00f) + +![install coastseg from conda forge](https://github.com/user-attachments/assets/e2126a94-aaa2-49b9-86e7-6ede187dfa53) diff --git a/mkdocs.yml b/mkdocs.yml index 6d0c122d..33e10adc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,6 +51,7 @@ nav: - 3. Register an existing project with Google Earth Engine: register-existing-gee-account.md - Installation: - Basic Installation Guide: basic-install-guide.md + - How to Install MiniForge: install-miniforge.md - Secure Installation Guide: secure-install-guide.md - Mac Installation Guide: mac-install-guide.md - Update Guide: update-guide.md