topovec 0.1.0

Visualizer of 3d vector field with accent of topological solitons.

TopoVec

Installation

Prerequisites

We recommend to Install UV package manager according to the manual.

Normal installation

If only GUI or scripts are going to be used, topovec can be installed as a tool. E.g. using UV

uvx tool install topovec

or using pipx:

pipx install topovec

To use topovec in jupter or marimo notebook, we suggest to use virtual environment. UV provides very convenient way to proceed. First create directory for you project:

uv init <your_project>

Then enter into the just create folder and install topovec:

cd <your_project>
uv add topovec

Most functionality of topovec are in plugins. All the plugins can be installed using

uv add topovec --all-extras

Now you can start notebook as described below.

For development

Clone or download the repository:

git clone https://gitlab.com/alepoydes/topovec.git

Switch to the newly created directory:

cd topovec

Run UV to create virtual environment and install the library.

uv sync --all-extras

Most of the functionality are provided by plugins which have dependencies on external packages. --all-extras will install all dependencies, which may lead to long installation time or incompatibilities with already installed software. You can select which plugins to choose using --extra key. For example, if we are interested only in OpenGL functionality, we can install only mgl plugin.

uv sync --extra mgl

First steps

It is convenient to prepare plots for publication in a notebook. To run Jupter Lab inside the environment associated with topovec, run in the topovec folder the following command:

uv run --with jupyter jupyter lab

Demonstration of basic functionality of the library can be found in the notebook notebooks/demo1.ipynb.