|
2 | 2 |
|
3 | 3 | Install Xee with pip or conda. Use virtual environments (`venv`, conda envs) to avoid dependency conflicts. |
4 | 4 |
|
5 | | -```{admonition} Temporary note for v0.1.0 prerelease |
6 | | -:class: warning |
| 5 | +Xee v0.1.0 introduced a refactored API with breaking changes relative to the 0.0.x series. This page documents the v0.1.0+ install and usage path. If you are upgrading from 0.0.x, review the [Migration Guide](migration-guide-v0.1.0.md). |
7 | 6 |
|
8 | | -This documentation describes the refactored v0.1.0 API. During the prerelease period, default install commands may still resolve to the previous stable line. |
9 | | -``` |
10 | | - |
11 | | -## Install the v0.1.0 prerelease (refactored API) |
| 7 | +## Install |
12 | 8 |
|
13 | | -Use pip prerelease resolution: |
| 9 | +Install from pip: |
14 | 10 |
|
15 | 11 | ```shell |
16 | | -pip install --upgrade --pre xee |
| 12 | +pip install --upgrade xee |
17 | 13 | ``` |
18 | 14 |
|
19 | | -Or pin a specific release candidate: |
| 15 | +Install from conda-forge: |
20 | 16 |
|
21 | 17 | ```shell |
22 | | -pip install xee==0.1.0rc1 |
| 18 | +conda install -c conda-forge xee |
23 | 19 | ``` |
24 | 20 |
|
25 | | -## Install current stable (pre-v0.1.0 API) |
| 21 | +```{admonition} Prerelease versions |
| 22 | +:class: note |
26 | 23 |
|
27 | | -Install from pip: |
| 24 | +Before each stable release, Xee publishes one or more release candidates (e.g. `v0.1.1rc1`) to PyPI. If you want to test upcoming changes before the stable release: |
28 | 25 |
|
29 | 26 | ```shell |
30 | | -pip install --upgrade xee |
| 27 | +pip install --upgrade --pre xee |
31 | 28 | ``` |
32 | 29 |
|
33 | | -Install from conda-forge: |
| 30 | +Or pin a specific release candidate: |
34 | 31 |
|
35 | 32 | ```shell |
36 | | -conda install -c conda-forge xee |
| 33 | +pip install xee==0.1.1rc1 |
37 | 34 | ``` |
38 | 35 |
|
39 | | -Note: conda-forge may lag PyPI during prerelease testing. Use pip for the latest RCs. |
| 36 | +Prerelease builds are not published to Conda-Forge. |
| 37 | +``` |
40 | 38 |
|
41 | 39 | ## Earth Engine setup |
42 | 40 |
|
|
0 commit comments