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
35 changes: 32 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,42 @@ pyvisgrid |ci| |pre-commit| |codecov| |pypi| |zenodo| |license|
Installation
============

You can install the necessary packages in a mamba/conda environment of your choice by executing
You can install the necessary packages in a virtual environment of your choice using, e.g., `uv <https://docs.astral.sh/uv/>`_:

.. code::

$ pip install -e .
$ uv pip install pyvisgrid

or

.. code::

$ uv add pyvisgrid

*pyvisgrid* can also be installed via mamba/conda or `pixi <https://pixi.sh/latest/>`_ through `conda-forge`:

.. code::

$ mamba install -c conda-forge pyvisgrid

or

.. code::

$ pixi install pyvisgrid

We recommend using a virtual environment with ``python>=3.10``.

Installation as a Developer
---------------------------

If you want to contribute as a developer, please fork/clone this repository and install the
package with its development dependencies as an editable installation:

.. code::

$ uv pip install --group dev -e .

We recommend using a conda/mamba environment with ``python`` version ``>=3.10``.

Example
=======
Expand Down
1 change: 1 addition & 0 deletions docs/changes/44.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
``pyvisgrid`` is now available on ``conda-forge`` and can be installed via ``mamba`` or ``pixi``
10 changes: 4 additions & 6 deletions docs/user-guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,8 @@ pip install pyvisgrid

:::{grid-item-card} Install with [`mamba`][mamba] / `conda`

```{warning}
pyvisgrid is not yet released on `conda-forge`.
A release is planned for the future.
```shell-session
mamba install -c conda-forge pyvisgrid
```
:::

Expand Down Expand Up @@ -98,9 +97,8 @@ uv pip install pyvisgrid
:::{grid-item-card} Install with [`pixi`][pixi]

Never heard of `pixi`? See [the documentation][pixi] for more.
```{warning}
pyvisgrid is not yet released on `conda-forge`.
A release is planned for the future.
```shell-session
pixi install pyvisgrid
```
:::

Expand Down