As a Napari plugin
The easiest way to get started, no Python knowledge required.
In this guide, we will walk you through the process of installing faser as a Napari plugin. This is the easiest way to get started with faser, as it allows you to use the software directly within a bundled Napari application.
Who is this guide for?
This guide is tailored to users who are new to Napari (and of course faser) and have little to no experience with Python or package management.
Download Napari
In order to install faser as a Napari plugin, you will first need to download and install Napari. We recommend using the bundled version of Napari as it gets you up and running quickly, without any knowledge of Python or package management.
When downloading Napari make sure you are downloading the correct version for your operating system. Windows users should download the 64-bit version (x86_64) exe and Mac users should download the pkg versions that correspond to their chip architecture (i.e arm64 for M1 Macs or x86_64 for Intel based chips).
Install Napari
Once you have downloaded Napari, you can easily install it by following the installer. The installer will guide you through the process of installing Napari on your system. Here is a video that shows you how this installation process looks like:
The installation process is straightforward and should take only a few minutes to complete. As illustrated in the video, the last step of the installation might require a little longer to complete, as Napari will download and install additional dependencies.
Install faser
Almost there! Now that you have Napari installed, you can install faser as a plugin. To do this we would advise you to use the Napari plugin manager. However, currently Napari's plugin hub is not entirely functional, so we would recommend you to install faser using the napari console. Here is a video that shows you how to install faser as a Napari plugin using the Napari console:
When installing faser using the Napari console, you will need to run the following command:
!pip install "faser"Make sure to run this command in the Napari console, not in the terminal or command prompt. Also make sure to include the ! at the beginning of the command, as well as the "" around the package name.
Launch faser
faser should now appear in the Napari plugin list. You can launch faser by selecting and adding both the "Helper" and "Main" plugins to the Napari viewer. Head over to the usage guide to learn how to use faser within Napari.