Skip to main content

Aggregation code for Zooniverse panoptes projects.

Project description

Getting started

This is a collection of external reducers written for caesar and offline use.


You can find the latest documentation on the aggregations code's website.

Installing for offline use

With your own python install (python 3 only)

Instal the latest stable release:

pip install panoptes_aggregation

Or for development or testing, you can install the development version directly from GitHub:

pip install -U git+git://

Upgrade and existing installation:

pip install -U panoptes_aggregation

If you see an error about Cython not being installed run pip install cython and try pip install . again.

With Docker

Using docker-compose

docker-compose -f docker-compose.local_scripts.yml build local_scripts

From the root directory of this repository, run the desired python scripts using the docker image, e.g. config_workflow_panoptes --help

docker-compose -f docker-compose.local_scripts.yml run --rm local_scripts config_workflow_panoptes --help

Or directly via docker

docker build . -f Dockerfile.bin_cmds -t aggregation_for_caesar

From the root directory of this repository, run the desired python scripts using the docker image, e.g. config_workflow_panoptes --help

docker run -it --rm --name config_workflow_panoptes -v "$PWD":/usr/src/aggregation aggregation_for_caesar config_workflow_panoptes --help

Installing for online use

The docker file included is ready to be deployed on any server. Once deployed, the extractors will be available on the /extractors/<name of extractor function> routes and the reducers will be available on the /reducers/<name of reducer function> routes. Any keywords passed into these functions should be included as url parameters on the route (e.g. For more complex keywords (e.g. detals for subtasks), python's urllib.parse.urlencode can be used to translate a keyword list into the proper url encoding.

The documentation will be built and available on the /docs route.

Build/run the app in docker locally

To run a local version use:

docker-compose build
docker-compose up

and listen on localhost:5000.

Running tests in the docker container

To run the tests use:

docker-compose run --rm aggregation nosetests

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for panoptes-aggregation, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size panoptes_aggregation-1.1.0-py3-none-any.whl (83.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size panoptes_aggregation-1.1.0.tar.gz (50.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page