Skip to content

CulverLab/sparcd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scientific Photo Analysis for Research & Conservation database (SPARCd), known during development as Scientific Animal Image Analysis (SANIMAL)

SPARC'd is a program developed for the University of Arizona's Jaguar and Ocelot Monitoring Project at the Wild Cat Research and Conservation Center, School of Natural Resources and the Environment Department.

  • It allows users to tag camera trap image data, transfer it onto a database, and then query it.

Getting Started

Clone the repository and build it using maven. All dependencies will be automatically fetched.

Prerequisites

Java 21:
https://www.oracle.com/java/technologies/downloads/#java21
Maven:
https://maven.apache.org/install.html

Prebuilt executable

If you want to run the software without needing to build from source, prebuilt executables can be downloaded from our main website's download page


Executables are executed with (replace 'sparcd-X-Y.jar' with the name of the file you downloaded):
java -jar 'sparcd-X-Y.jar' 

Build from Source

Clone the github repository into a directory:

git clone https://github.com/CulverLab/sparcd.git <directory>

Build the project into an executable JAR file to run:

cd '<directory>/Sanimal FX'
mvn -U compile package

Run the program:

java -jar '<directory>/Sanimal FX/target/SanimalFX-1.0-SNAPSHOT-jar-with-dependencies.jar'

Sample screenshots

Login - This screen is used to log into your account.

login screen

Home - This tab is used to credit developers and provide an exit button.

home tab

Import - This tab is used to tag images with metadata.

import tab

Collections - This tab is used to show collections and upload images.

collections tab

Analyze/Query - This tab is used to query uploaded image data.

query tab

Map - This tab is used to display all locations on an interactive map.

map tab

Settings - This tab is used to change program settings.

settings tab

New S3 Endpoints

SPARC'd supports any compatible S3 endpoint as its data store allowing greater freedom on how and where to store data.

The locations, species, and setting are stored as JSON files in a central settings bucket at the S3 endpoint. This settings bucket needs to be uniquely named to prevent conflicts with other SPARC'd instances. If you do not setup this settings bucket, SPARC'd will create one and populate it with the default files.

To manually setup the settings bucket, create a new bucket that has a name starting with "sparcd-settings" (without the quotes). For example, "sparcd-settings-my-settings", or "sparcd-settings-a7h823husa90hz".

After manually creating the settings bucket, create a "Settings" subfolder/object and populate that with the settings JSON files found in this repository.

You may want to edit the locations and species entries, in their respective files, to best suit your needs.

As mentioned above, SPARCd can create the settings bucket and files on your behalf. If you want to allow SPARCd to create the settings folder, running the app and logging in will create the necessary bucket and files. The settings bucket will be created using a name prefixed with "sparcd-settings-", and have random characters after that prefix. After the files are created, you can modify their contents to best suit your needs.

Built With

  • Maven - Dependency Management

  • This version of “SPARC’d” is being developed by University of Arizona School of Natural Resources and the Environment (SNRE) and CyVerse.

Authors

  • David Slovikosky - Lead Developer - DavidM1A2
  • Susan Malusa - Project Coordination/Design - smalusa
  • Project Site Documentation - smalusa

Acknowledgements

  • Co-Principal Investigators - Dr. Melanie Culver and Nirav Merchant

  • Technical Advisors - Dr. Richard Snodgrass and Dr. Carlos Scheidegger

  • S3 Support - Julian Pistorius and Chris Schnaufer

  • Support and Ideas - The University of Arizona Jaguar & Ocelot Monitoring Team, The Slovikosky Family

  • CyVerse Support (legacy) - Dr. Blake Joyce, Tony Edgin, Julian Pistorius and Chris Schnaufer