0.5.2 • Published 11 months ago

sentinel-desktop v0.5.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
11 months ago

Sentinel Desktop Application

An open source desktop application that allows users to execute Conservation X Lab’s image processing models locally via a user-friendly UI.

Current Status

This app is currently in development and not yet production ready.

Project Description

CXL produces Sentinel hardware and a Sentinel web app to allow conservation organizations to capture and process images in order to identify wildlife. To make CXL’s models accessible to conservation teams in the field, to users with limited command-line expertise, and to organizations that already possess a large host of images requiring processing, CXL has partnered with Two Sigma Data Clinic to build an open source desktop app that facilitates local imaging processing via a user-friendly UI.

Pre-requisites

  • Python version 3.10.2 or above
  • Node 20.12.2 or higher (its possible lower versions will work but this is what it was developed on)
  • Docker Desktop

Local setup

  1. Clone repo
  2. Set up .env file: yarn reset-env
  3. Install all dependencies: yarn install
  4. Initiliaze the local sqlite db and Prisma client: yarn upgrade-db
    • This is also the command you should run if the database schema has changed and you need to migrate your db to the new schema.
  5. Start the app: yarn start

License

Apache 2.0

Contributors

Conservation X Labs' Sentinel team. Contact: sentinel-support@conservationxlabs.org

Data Clinic, the pro bono data and tech-for-good arm of Two Sigma. Contact: dataclinic@twosigma.com, GitHub: https://github.com/tsdataclinic

Packaging the app

The app can be packaged with yarn package. More details, such as how to manage Prisma binary versions when packaging, can be found in the Developer Documentation.