diff --git a/docs/user_guide/getting_started/installation.md b/docs/user_guide/getting_started/installation.md index ed91b26ef..d01e60f56 100644 --- a/docs/user_guide/getting_started/installation.md +++ b/docs/user_guide/getting_started/installation.md @@ -2,52 +2,33 @@ ## Basic Installation - - -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. -``` +**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 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 -``` - - +**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. ## Installation for developers