Installation#

To install the latest stable version of fafbseg-py with pip.

pip3 install fafbseg

For the development version from Github:

pip3 install git+https://github.com/navis-org/fafbseg-py.git

After the successful installation, please check out the FlyWire setup for instructions on how to retrieve and set your FlyWire API token.

To get started, have a look at the examples or the API reference.

Warning

For Windows users: fafbseg is unlikely to work off the bat as some of its dependencies might not install correctly. I highly recommend you install and use the Windows Subsystem for Linux which lets you circumvent the problem by running a virtual Linux on your Windows machine.