Skip to content

Commit 58ca9b2

Browse files
authored
[MAINT] Update installation info (#200)
1 parent 653e635 commit 58ca9b2

2 files changed

Lines changed: 53 additions & 17 deletions

File tree

docs/Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,11 @@ help:
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21+
22+
clean:
23+
rm -rf $(BUILDDIR)/*
24+
rm -rf $(SOURCEDIR)/auto_examples/*
25+
rm -rf $(SOURCEDIR)/generated/*
26+
27+
view:
28+
@python -c "import webbrowser; webbrowser.open_new_tab('file://$(PWD)/build/html/index.html')"

docs/source/installation.rst

Lines changed: 45 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
11
Installation
22
============
33

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/>`_:
612

713
.. code-block::
814
915
pip install pybispectra
1016
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/>`_:
1318

1419
.. code-block::
1520
16-
conda install -c conda-forge pybispectra
17-
18-
PyBispectra requires Python ≥ 3.10.
21+
uv pip install pybispectra
1922
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/>`_:
2424

25-
With ``conda``
26-
--------------
25+
.. code-block::
26+
27+
conda install -c conda-forge pybispectra
2728
28-
In a shell with ``conda`` available, run the following commands:
29+
or `pixi <https://pixi.prefix.dev/latest/>`_:
2930

3031
.. code-block::
32+
33+
pixi add pybispectra
3134
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/>`_.
3541

3642
With ``venv``
3743
-------------
@@ -68,3 +74,25 @@ then install the package:
6874
.. code-block::
6975
7076
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

Comments
 (0)