ckanext-dc-view

Preview DC data in DCOR


Keywords
CKAN, DCOR, RT-DC
License
Other
Install
pip install ckanext-dc-view==0.9.0

Documentation

ckanext-dc_view

PyPI Version Coverage Status

A CKAN resource view for DC data. The preview includes metadata from the HDF5 attributes and a summary plot (scatter plot of brightness vs. area and image, contour, mask, and fluorescence data for one event). This plugin registers a background job for generating the overview plot after a DC resource has been created.

This extensione implements:

  • A default view for RT-DC (mimetype) resources
  • A background job that generates the preview image
  • A background job that uploads preview images to the S3 object store
  • A route that makes the preview image available via "/dataset/{id}/resource/{resource_id}/preview.jpg"
  • CLI:
    • add CKAN command run-jobs-dc-view that runs all background jobs for all resources (if not already done)

Installation

pip install ckanext-dc_view

Add this extension to the plugins and defaul_views in ckan.ini:

ckan.plugins = [...] dc_view
ckan.views.default_views = [...] dc_view

Testing

Testing can be done via vagrant in a virtual machine using the dcor-test <https://app.vagrantup.com/paulmueller/boxes/dcor-test/> image. Make sure that vagrant and virtualbox are installed and run the following commands in the root of this repository:

# Setup virtual machine using `Vagrantfile`
vagrant up
# Run the tests
vagrant ssh -- sudo bash /testing/vagrant-run-tests.sh