|
1 | 1 | Installation |
2 | 2 | ============ |
3 | 3 |
|
4 | | -To install PyBispectra, activate the desired environment in which you want the package, |
5 | | -then install it using `pip <https://pip.pypa.io/en/stable/>`_: |
| 4 | +PyBispectra is available on `PyPI <https://pypi.org/project/pybispectra/>`_, and |
| 5 | +`conda-forge <https://anaconda.org/channels/conda-forge/packages/pybispectra/overview>`_ |
| 6 | +for version ≥ 1.2.2. |
| 7 | + |
| 8 | +PyBispectra requires Python ≥ 3.10. |
| 9 | + |
| 10 | +To install PyBispectra, activate the desired environment or project in which you want |
| 11 | +the package, then install it using `pip <https://pip.pypa.io/en/stable/>`_: |
6 | 12 |
|
7 | 13 | .. code-block:: |
8 | 14 | |
9 | 15 | pip install pybispectra |
10 | 16 |
|
11 | | -or `conda <https://docs.conda.io/en/latest/>`_ from |
12 | | -`conda-forge <https://anaconda.org/conda-forge>`_ (for PyBispectra ≥ 1.2.2): |
| 17 | +`uv <https://docs.astral.sh/uv/>`_: |
13 | 18 |
|
14 | 19 | .. code-block:: |
15 | 20 | |
16 | | - conda install -c conda-forge pybispectra |
17 | | -
|
18 | | -PyBispectra requires Python ≥ 3.10. |
| 21 | + uv pip install pybispectra |
19 | 22 |
|
20 | | -If you need to create an environment in which to install PyBispectra, you can do so |
21 | | -using `conda <https://docs.conda.io/en/latest/>`_, |
22 | | -`venv <https://docs.python.org/3/library/venv.html>`_, or |
23 | | -`uv <https://docs.astral.sh/uv/>`_. |
| 23 | +`conda <https://docs.conda.io/en/latest/>`_: |
24 | 24 |
|
25 | | -With ``conda`` |
26 | | --------------- |
| 25 | +.. code-block:: |
| 26 | + |
| 27 | + conda install -c conda-forge pybispectra |
27 | 28 |
|
28 | | -In a shell with ``conda`` available, run the following commands: |
| 29 | +or `pixi <https://pixi.prefix.dev/latest/>`_: |
29 | 30 |
|
30 | 31 | .. code-block:: |
| 32 | + |
| 33 | + pixi add pybispectra |
31 | 34 |
|
32 | | - conda create -n pybispectra_env |
33 | | - conda activate pybispectra_env |
34 | | - conda install -c conda-forge pybispectra |
| 35 | +| |
| 36 | +
|
| 37 | +If you need to create an environment or project in which to install PyBispectra, you can |
| 38 | +do so using `venv <https://docs.python.org/3/library/venv.html>`_, |
| 39 | +`uv <https://docs.astral.sh/uv/>`_, `pixi <https://pixi.prefix.dev/latest/>`_, or |
| 40 | +`conda <https://docs.conda.io/en/latest/>`_. |
35 | 41 |
|
36 | 42 | With ``venv`` |
37 | 43 | ------------- |
@@ -68,3 +74,25 @@ then install the package: |
68 | 74 | .. code-block:: |
69 | 75 |
|
70 | 76 | uv pip install pybispectra |
| 77 | +
|
| 78 | +With ``pixi`` |
| 79 | +------------- |
| 80 | + |
| 81 | +In a shell with ``pixi`` available, run the following commands: |
| 82 | + |
| 83 | +.. code-block:: |
| 84 | +
|
| 85 | + pixi init |
| 86 | + pixi shell-hook |
| 87 | + pixi add pybispectra |
| 88 | +
|
| 89 | +With ``conda`` |
| 90 | +-------------- |
| 91 | + |
| 92 | +In a shell with ``conda`` available, run the following commands: |
| 93 | + |
| 94 | +.. code-block:: |
| 95 | +
|
| 96 | + conda create -n pybispectra_env |
| 97 | + conda activate pybispectra_env |
| 98 | + conda install -c conda-forge pybispectra |
0 commit comments