Installation¶

Starst3r Python¶

Starst3r can be installed as a pip package.

pip install starst3r

The package includes four Python modules:

For most cases, your script will only use the starster module.

See Quickstart for more information on how to use the library.

Download the pretrained Mast3r model.

Starst3r uses the same Mast3r model internally.

The Python module can be built and installed from source.

./build.sh python
pip install build/dist/*.whl

This will create the appropriate file structure and build the Python package in build/dist.

Starst3r can be used as a Blender add-on.

Due to the nature of Blender Python, the installation procedure is complicated.

Please follow the instructions carefully.

If you haven’t done so in the past, you must configure the Blender Python scripts directory.

This is an additional directory that Blender will load user installed Python modules from.

Create a new directory where you would like. Create an extra directory ``modules`` inside your chosen directory.

So, if you choose to use /home/user/BlenderScripts, you should create a directory /home/user/BlenderScripts/modules.

In Blender’s preferences, add a script path and set it to your chosen directory, without the ``modules`` directory.

Next, install Starst3r (and it’s dependencies) into the modules directory.

Use the --target option of pip to set the install dir.

pip install --target=/home/user/BlenderScripts/modules starst3r

There is a known issue with user installed numpy.

Remove the numpy installation from modules.

rm -r /home/user/BlenderScripts/modules/numpy*

Install the add-on zip file as you would any other add-on.