Installing VectoRose

Installing VectoRose is very straightforward. You must have Python version 3.10 or higher. VectoRose can be installed from PyPI using pip.

pip install vectorose

This should be sufficient for most uses. Alternatively, you can download the wheel from our GitHub releases page.

You can make sure that VectoRose was properly installed by opening a Python console:

import vectorose as vr

print(vr.__version__)

1.5.2

If there is a ModuleNotFoundError, try restarting your Python console. If it still does not work, then try reinstalling it. If there are error messages that appear when installing or importing, please read them and share them on GitHub Issues so that we can try to resolve them.

Jupyter Setup

You can easily use VectoRose in Jupyter Lab to visualise results interactively. Make sure that you have jupyter and jupyterlab installed. Try to run your code in Jupyter Lab. If it does not work, add the following to the first cell in your notebook:

pv.set_jupyter_backend("trame")

For more details on using the PyVista plotting packing with Jupyter Lab, check out this page.

Development Setup

To set up VectoRose for development, clone our GitHub repository:

git clone https://github.com/bzrudski/vectorose.git

We use Poetry to manage our dependencies and to help with package development. To install Poetry, read the online documentation.

We also suggest creating a new environment to store all the dependencies for VectoRose. This may be a virtual environment, a Conda environment, a Poetry environment or any equivalent.

With this new environment activated, switch into the cloned git repository and install all the dependencies using:

poetry install

All dependencies, as well as VectoRose itself, should now be installed in your environment.

Packaging Acknowledgement

A great resource that we used to develop VectoRose is Python Packages by Beuzen and Timbers [2022]. We recommend consulting this book for any assistance required on the basics of developing Python packages.