Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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')"
62 changes: 45 additions & 17 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,37 +1,43 @@
Installation
============

To install PyBispectra, activate the desired environment in which you want the package,
then install it using `pip <https://pip.pypa.io/en/stable/>`_:
PyBispectra is available on `PyPI <https://pypi.org/project/pybispectra/>`_, and
`conda-forge <https://anaconda.org/channels/conda-forge/packages/pybispectra/overview>`_
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 <https://pip.pypa.io/en/stable/>`_:

.. code-block::

pip install pybispectra

or `conda <https://docs.conda.io/en/latest/>`_ from
`conda-forge <https://anaconda.org/conda-forge>`_ (for PyBispectra ≥ 1.2.2):
`uv <https://docs.astral.sh/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 <https://docs.conda.io/en/latest/>`_,
`venv <https://docs.python.org/3/library/venv.html>`_, or
`uv <https://docs.astral.sh/uv/>`_.
`conda <https://docs.conda.io/en/latest/>`_:

With ``conda``
--------------
.. code-block::

conda install -c conda-forge pybispectra

In a shell with ``conda`` available, run the following commands:
or `pixi <https://pixi.prefix.dev/latest/>`_:

.. 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 <https://docs.python.org/3/library/venv.html>`_,
`uv <https://docs.astral.sh/uv/>`_, `pixi <https://pixi.prefix.dev/latest/>`_, or
`conda <https://docs.conda.io/en/latest/>`_.

With ``venv``
-------------
Expand Down Expand Up @@ -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
Loading