Skip to content

Commit dcabb1c

Browse files
committed
Update README
1 parent 8442d53 commit dcabb1c

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.rst

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,42 @@ pyvisgrid |ci| |pre-commit| |codecov| |pypi| |zenodo| |license|
2929
Installation
3030
============
3131

32-
You can install the necessary packages in a mamba/conda environment of your choice by executing
32+
You can install the necessary packages in a virtual environment of your choice using, e.g., [uv](https://docs.astral.sh/uv/):
3333

3434
.. code::
3535
36-
$ pip install -e .
36+
$ uv pip install pyvisgrid
37+
38+
or
39+
40+
.. code::
41+
42+
$ uv add pyvisgrid
43+
44+
*pyvisgrid* can also be installed via `mamba`/`conda` or [pixi](https://pixi.sh/latest/) through `conda-forge`:
45+
46+
.. code::
47+
48+
$ mamba install -c conda-forge pyvisgrid
49+
50+
or
51+
52+
.. code::
53+
54+
$ pixi install pyvisgrid
55+
56+
We recommend using a virtual environment with ``python>=3.10``.
57+
58+
Installation as a Developer
59+
---------------------------
60+
61+
If you want to contribute as a developer, please fork/clone this repository and install the
62+
package with its development dependencies as an editable installation:
63+
64+
.. code::
65+
66+
$ uv pip install --group dev -e .
3767
38-
We recommend using a conda/mamba environment with ``python`` version ``>=3.10``.
3968
4069
Example
4170
=======

0 commit comments

Comments
 (0)