Skip to content

Commit a3e4f01

Browse files
committed
DOC: Copy edits to v4 alpha installation
Rename `install` to `installation` (so normal installation instructions are at `installation` and v4 installation is at `v4/installation`)
1 parent a5da667 commit a3e4f01

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

docs/v4/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Collaboration on v4 development is happening on the [Parcels v4 Project Board](h
1717
The pages below provide further background on the development of Parcels v4. You can think of this page as a "living" document as we work towards the release of v4.
1818

1919
```{toctree}
20-
install
20+
installation
2121
api
2222
nojit
2323
TODO
Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
# Install an alpha version of Parcels v4
22

3-
````{warning}
3+
During development of Parcels v4, we are uploading versions of the package to an [index on prefix.dev](https://prefix.dev/channels/parcels/packages/parcels). This allows users to easily install an unreleased version without having to do a [development install](../installation.rst)! Give it a spin!
4+
5+
```{warning}
46
Before installing an alpha version of Parcels, we *highly* recommend creating a new environment so that doesn't affect package versions in your current environment (which you may be using for your research).
57
6-
Do the following to create a new environment:
8+
You can see what your current environment is by doing `conda env list` and seeing which environment has a `*` next to it. At any point, you can use `conda activate ...` to return to your environment with version 3 of Parcels.
79
8-
```sh
9-
conda create -n parcels-v4-alpha python=3.11
10-
conda activate parcels-v4-alpha
1110
```
1211

13-
````
14-
15-
During development of Parcels v4, we are uploading versions of the package to an [index on prefix.dev](https://prefix.dev/channels/parcels/packages/parcels). This allows users to easily install an unreleased version without having to do a [development install](../installation.rst)! Give it a spin!
12+
Do the following to create a new environment (called `parcels-v4-alpha`) with an alpha version of Parcels installed:
1613

1714
```sh
15+
conda create -n parcels-v4-alpha python=3.11
16+
conda activate parcels-v4-alpha
1817
conda install -c https://repo.prefix.dev/parcels parcels
1918
```
2019

21-
During the development of Parcels v4 we will be occasionally releasing these alpha package versions so that users can try them out. If you're installing Parcels normally (i.e., via Conda forge) you can continue to do so without disruption.
20+
During the development of Parcels v4 we will be occasionally releasing these alpha package versions so that users can try them out. If you're installing Parcels normally (i.e., via Conda forge) you will receive version 3 of Parcels as usual until version 4 is officially released.

0 commit comments

Comments
 (0)