biigle/largo

BIIGLE module to review image annotations in a regular grid.

v2.36.1 2024-09-06 09:38 UTC

Requires

• jcupitt/vips: ^1.0 || ^2.0
• meyfa/php-svg: ^0.14.6
• php-ffmpeg/php-ffmpeg: ^0.14 || ^0.19 || ^1.0

GPL-3.0-only

• Martin Zurowietz

• biigle
• biigle-module

README

This is the BIIGLE module to review image annotations in a regular grid.

Installation

This module is already included in biigle/biigle.

1. Run composer require biigle/largo.
2. Install the Python dependencies with pip install -r requirements.txt.
3. Add Biigle\Modules\Largo\LargoServiceProvider::class to the providers array in config/app.php.
4. Run php artisan vendor:publish --tag=public to publish the public assets of this module.
5. Configure a storage disk for the Largo annotation patches and set the LARGO_PATCH_STORAGE_DISK variable to the name of this storage disk in the .env file. The content of the storage disk should be publicly accessible. Example for a local disk:

   'largo' => [
       'driver' => 'local',
       'root' => storage_path('app/public/largo-patches'),
       'url' => env('APP_URL').'/storage/largo-patches',
       'visibility' => 'public',
   ],

   This requires the link storage -> ../storage/app/public in the public directory.

Developing

Take a look at the development guide of the core repository to get started with the development setup.

Want to develop a new module? Head over to the biigle/module template repository.

Contributions and bug reports

Contributions to BIIGLE are always welcome. Check out the contribution guide to get started.