From f4cd62b27bc6de636c6b2a1e326d358dd8dedd1f Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Wed, 9 Sep 2026 15:49:51 +0200 Subject: [PATCH 1/5] Update installation.md --- .../getting_started/installation.md | 45 ++++++++----------- 1 file changed, 19 insertions(+), 26 deletions(-) diff --git a/docs/user_guide/getting_started/installation.md b/docs/user_guide/getting_started/installation.md index ed91b26ef..dc7f4ac7b 100644 --- a/docs/user_guide/getting_started/installation.md +++ b/docs/user_guide/getting_started/installation.md @@ -2,52 +2,45 @@ ## Basic Installation - +**Step 2:** Start a terminal (Linux / macOS) or the Anaconda prompt (Windows). Activate the `base` environment of your Miniconda and create an environment containing Parcels, all its essential dependencies, `trajan` (a trajectory plotting dependency used in the notebooks) and the nice-to-have cartopy and jupyter packages: -Parcels v4 is in active development. - -A pre-release version of Parcels (i.e., the latest version on `main`) can be installed via conda using the following instructions (which creates an environment `parcelsv4-env`, activates it, installs Parcels from a custom pre-release channel that we're using, and installs some additional helper packages). - -```{warning} -Before installing the latest version of Parcels, we *highly* recommend creating a new environment so that it doesn't affect your current environment (which you may be using for your research). - -You can find your current environment with `conda env list` and identifying the environment with a `*` next to it. At any point, you can use `conda activate ...` (replacing `...` with the name that had the `*` next to it) to return to your environment with version 3 of Parcels. +```bash +conda create -n parcelsv4-env -c conda-forge parcels trajan cartopy jupyter ``` +**Step 3:** Activate the newly created Parcels environment: + ```bash -conda config --add channels conda-forge -conda create -n parcelsv4-env python conda activate parcelsv4-env -conda install -c https://prefix.dev/parcels parcels -conda install trajan cartopy jupyter ``` - +```bash +conda config --add channels conda-forge +conda create -n parcelsv4-nightly python +conda activate parcelsv4-nightly +conda install -c https://prefix.dev/parcels parcels +conda install trajan cartopy jupyter +``` ## Installation for developers From c03a96c7083cb0fde287e4691889aedad8b7b2fc Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Thu, 10 Sep 2026 10:05:11 +0200 Subject: [PATCH 2/5] remove nightly builds from installation instructions --- docs/user_guide/getting_started/installation.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/docs/user_guide/getting_started/installation.md b/docs/user_guide/getting_started/installation.md index dc7f4ac7b..ed002c54a 100644 --- a/docs/user_guide/getting_started/installation.md +++ b/docs/user_guide/getting_started/installation.md @@ -30,18 +30,6 @@ The next time you start a terminal and want to work with Parcels, activate the e **Step 4:** Create a Jupyter Notebook or Python script to set up your first Parcels simulation! The [quickstart tutorial](tutorial_quickstart.md) is a great way to get started immediately. You can also first read about the core [Parcels concepts](explanation_concepts.md) to familiarize yourself with the classes and methods you will use. -## Nightly builds - -Parcels v4 is in active development. A pre-release version of Parcels (i.e., the latest version on `main`) can be installed via conda using the following instructions (which creates an environment `parcelsv4-nightly`, activates it, installs Parcels from a custom pre-release channel that we're using, and installs some additional helper packages). - -```bash -conda config --add channels conda-forge -conda create -n parcelsv4-nightly python -conda activate parcelsv4-nightly -conda install -c https://prefix.dev/parcels parcels -conda install trajan cartopy jupyter -``` - ## Installation for developers See the [development section in our contributing guide](../../development/index.md#development) for development instructions. From 7fbbe726ee3bd27fbbf9d47ee4f9e0ec19c96fff Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Thu, 10 Sep 2026 10:05:26 +0200 Subject: [PATCH 3/5] rename parcels conda environment --- docs/user_guide/getting_started/installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user_guide/getting_started/installation.md b/docs/user_guide/getting_started/installation.md index ed002c54a..edb52c80b 100644 --- a/docs/user_guide/getting_started/installation.md +++ b/docs/user_guide/getting_started/installation.md @@ -15,17 +15,17 @@ The steps below are the installation instructions for Linux, macOS and Windows. **Step 2:** Start a terminal (Linux / macOS) or the Anaconda prompt (Windows). Activate the `base` environment of your Miniconda and create an environment containing Parcels, all its essential dependencies, `trajan` (a trajectory plotting dependency used in the notebooks) and the nice-to-have cartopy and jupyter packages: ```bash -conda create -n parcelsv4-env -c conda-forge parcels trajan cartopy jupyter +conda create -n parcelsv4 -c conda-forge parcels trajan cartopy jupyter ``` **Step 3:** Activate the newly created Parcels environment: ```bash -conda activate parcelsv4-env +conda activate parcelsv4 ``` ```{note} -The next time you start a terminal and want to work with Parcels, activate the environment with `conda activate parcelsv4-env`. +The next time you start a terminal and want to work with Parcels, activate the environment with `conda activate parcelsv4`. ``` **Step 4:** Create a Jupyter Notebook or Python script to set up your first Parcels simulation! The [quickstart tutorial](tutorial_quickstart.md) is a great way to get started immediately. You can also first read about the core [Parcels concepts](explanation_concepts.md) to familiarize yourself with the classes and methods you will use. From 40a0a5098a125e4f49959cc54869733a3922bc8c Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Thu, 10 Sep 2026 10:06:22 +0200 Subject: [PATCH 4/5] rename parcels environment name --- docs/user_guide/getting_started/installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user_guide/getting_started/installation.md b/docs/user_guide/getting_started/installation.md index edb52c80b..23cd7b4f7 100644 --- a/docs/user_guide/getting_started/installation.md +++ b/docs/user_guide/getting_started/installation.md @@ -15,17 +15,17 @@ The steps below are the installation instructions for Linux, macOS and Windows. **Step 2:** Start a terminal (Linux / macOS) or the Anaconda prompt (Windows). Activate the `base` environment of your Miniconda and create an environment containing Parcels, all its essential dependencies, `trajan` (a trajectory plotting dependency used in the notebooks) and the nice-to-have cartopy and jupyter packages: ```bash -conda create -n parcelsv4 -c conda-forge parcels trajan cartopy jupyter +conda create -n parcels-v4 -c conda-forge parcels trajan cartopy jupyter ``` **Step 3:** Activate the newly created Parcels environment: ```bash -conda activate parcelsv4 +conda activate parcels-v4 ``` ```{note} -The next time you start a terminal and want to work with Parcels, activate the environment with `conda activate parcelsv4`. +The next time you start a terminal and want to work with Parcels, activate the environment with `conda activate parcels-v4`. ``` **Step 4:** Create a Jupyter Notebook or Python script to set up your first Parcels simulation! The [quickstart tutorial](tutorial_quickstart.md) is a great way to get started immediately. You can also first read about the core [Parcels concepts](explanation_concepts.md) to familiarize yourself with the classes and methods you will use. From f8f4efbebc9c325768434df5d6d90e58d962f0ee Mon Sep 17 00:00:00 2001 From: Erik van Sebille Date: Thu, 10 Sep 2026 10:07:47 +0200 Subject: [PATCH 5/5] Update docs/user_guide/getting_started/installation.md Co-authored-by: Nick Hodgskin <36369090+VeckoTheGecko@users.noreply.github.com> --- docs/user_guide/getting_started/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_guide/getting_started/installation.md b/docs/user_guide/getting_started/installation.md index 23cd7b4f7..d01e60f56 100644 --- a/docs/user_guide/getting_started/installation.md +++ b/docs/user_guide/getting_started/installation.md @@ -2,7 +2,7 @@ ## Basic Installation -The simplest way to install the Parcels code is to use Anaconda and the [Parcels conda-forge package](https://anaconda.org/conda-forge/parcels) with the latest release of Parcels. This package will automatically install all the requirements for a fully functional installation of Parcels. This is the "batteries-included" solution probably suitable for most users. Note that we support Python 3.11 and higher. +The simplest way to install the Parcels code is to use Anaconda and the [Parcels conda-forge package](https://anaconda.org/conda-forge/parcels) with the latest release of Parcels. This package will automatically install all the requirements for a fully functional installation of Parcels. This is the "batteries-included" solution suitable for most users. Note that we support Python 3.11 and higher. If you want to install the latest development version of Parcels and work with features that have not yet been officially released, you can follow the instructions in the [development section in our contributing guide](../../development/index.md#development).