From b60438d2bd774158a6410b1108f03f7d56efb090 Mon Sep 17 00:00:00 2001 From: "Thomas S. Binns" Date: Sun, 15 Mar 2026 15:52:56 +0100 Subject: [PATCH] [MAINT] Update installation info (#200) --- docs/Makefile | 8 +++++ docs/source/installation.rst | 62 ++++++++++++++++++++++++++---------- 2 files changed, 53 insertions(+), 17 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf..06e1859 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -18,3 +18,11 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +clean: + rm -rf $(BUILDDIR)/* + rm -rf $(SOURCEDIR)/auto_examples/* + rm -rf $(SOURCEDIR)/generated/* + +view: + @python -c "import webbrowser; webbrowser.open_new_tab('file://$(PWD)/build/html/index.html')" diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 25998fa..49b25d2 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,37 +1,43 @@ Installation ============ -To install PyBispectra, activate the desired environment in which you want the package, -then install it using `pip `_: +PyBispectra is available on `PyPI `_, and +`conda-forge `_ +for version ≥ 1.2.2. + +PyBispectra requires Python ≥ 3.10. + +To install PyBispectra, activate the desired environment or project in which you want +the package, then install it using `pip `_: .. code-block:: pip install pybispectra -or `conda `_ from -`conda-forge `_ (for PyBispectra ≥ 1.2.2): +`uv `_: .. code-block:: - conda install -c conda-forge pybispectra - -PyBispectra requires Python ≥ 3.10. + uv pip install pybispectra -If you need to create an environment in which to install PyBispectra, you can do so -using `conda `_, -`venv `_, or -`uv `_. +`conda `_: -With ``conda`` --------------- +.. code-block:: + + conda install -c conda-forge pybispectra -In a shell with ``conda`` available, run the following commands: +or `pixi `_: .. code-block:: + + pixi add pybispectra - conda create -n pybispectra_env - conda activate pybispectra_env - conda install -c conda-forge pybispectra +| + +If you need to create an environment or project in which to install PyBispectra, you can +do so using `venv `_, +`uv `_, `pixi `_, or +`conda `_. With ``venv`` ------------- @@ -68,3 +74,25 @@ then install the package: .. code-block:: uv pip install pybispectra + +With ``pixi`` +------------- + +In a shell with ``pixi`` available, run the following commands: + +.. code-block:: + + pixi init + pixi shell-hook + pixi add pybispectra + +With ``conda`` +-------------- + +In a shell with ``conda`` available, run the following commands: + +.. code-block:: + + conda create -n pybispectra_env + conda activate pybispectra_env + conda install -c conda-forge pybispectra