Getting Started for Users

Warning

The following guide is for users. If you want to contribute to pyvisgrid as a developer, see Getting Started for Developers.

Install pyvisgrid

pyvisgrid is available on PyPI To install pyvisgrid into an existing virtual environment, use one of the following installation methods.

Should I use pip or …?

With many so many package installers available, installing software can be confusing. Here is a guide to help you make a sensible choice.

1. Are you already using an environment manager?

   Great, then you should use that tool to install pyvisgrid.

2. Are you considering using an environment manager?

   There are lots of environment managers to choose from. If you are unsure where to start, consider starting with a Python virtual environment. mamba is also a great choice and comes in a lightweight bundle with Miniforge.

3. If environment managers are not your thing…

   …you can also use pip to install packages directly to your Python path using

      $ pip install -U pyvisgrid
   

Ignoring environment management

While environment managers may sound complicated at first, they are strongly recommended. Ignoring them may lead to confusion if something breaks later on.

Install with pip

In a virtual environment:

pip install pyvisgrid

Install with mamba / conda

Warning

pyvisgrid is not yet released on conda-forge. A release is planned for the future.

Install with pipx

Never heard of pipx? See the documentation for more.

pipx install pyvisgrid

Install with uv

Never heard of uv? See the documentation for more.

uv add pyvisgrid

Or, if you prefer the pip interface:

uv pip install pyvisgrid

Install with pixi

Never heard of pixi? See the documentation for more.

Warning

pyvisgrid is not yet released on conda-forge. A release is planned for the future.

Recommendation

Note

We strongly recommend using uv to install pyvisgrid for now.

First Steps

To get to know pyvisgrid, check out the Tutorials and Examples section.