Package: django-rgd
Resonant GeoData Core ApplicationThe core Resonant GeoData (RGD) app containing file and permissions management
as well as spatial models. Each of the other RGD apps depend on the core
functionality built here.Installationpip install --find-links https://girder.github.io/large_image_wheels django-rgdIt is necessary to use a postgis database with the RGD apps. To do so, set your
database ENGINE todjango.contrib.gis.db.backends.postgis.Add RGD to yourINSTALLED_APPS:INSTALLED_APPS+=['django.contrib.gis','rgd',]MIDDLEWARE+=('crum.CurrentRequestUserMiddleware',)REST_FRAMEWORK['DEFAULT_AUTHENTICATION_CLASSES']+=('rest_framework.authentication.TokenAuthentication',)# doesn't have to use girder_utils if downstream projects don't have it installed, but this must be set to *something* valid to enable pagination in the APIREST_FRAMEWORK['DEFAULT_PAGINATION_CLASS']='girder_utils.rest_framework.BoundedLimitOffsetPagination'REST_FRAMEWORK['PAGE_SIZE']=100# or whatever default pagination size you want(note that RGD requiresdjango-crummiddleware.)It is also necessary to configure GDAL in your project settings:try:importreimportosgeolibsdir=os.path.join(os.path.dirname(os.path.dirname(osgeo._gdal.__file__)),'GDAL.libs')libs={re.split(r'-|\.',name)[0]:os.path.join(libsdir,name)fornameinos.listdir(libsdir)}GDAL_LIBRARY_PATH=libs['libgdal']GEOS_LIBRARY_PATH=libs['libgeos_c']exceptException:passConfigurationsThe RGD core app has a few optional settings:RGD_GLOBAL_READ_ACCESS: option to give all users access to files that lack permissions (otherwise only admin users can access these files)RGD_FILE_FIELD_PREFIX: the path prefix when uploading files to the project's S3 storage.RGD_AUTO_APPROVE_SIGN_UP: automatically approve all user sign ups.RGD_AUTO_COMPUTE_CHECKSUMS: automatically compute checksums for all ChecksumFile records (default False)RGD_TEMP_DIR: A temporary directory for working filesRGD_TARGET_AVAILABLE_CACHE: The target free space to remain for the cache in Gigabytes (default 2).RGD_REST_CACHE_TIMEOUT: the time in seconds for the REST views cache (for endpoints that are cached).RGD_SIGNED_URL_TTL: The time in seconds for which URL signatures are valid (defaults to 24 hours).RGD_SIGNED_URL_QUERY_PARAM: The signature querystring variable name (defaults tosignature).RGD_DEBUG_LOGS: enable debug level logging for RGD (default True)ModelsChecksumFile: the central file storage model. Supports uploaded files, S3 URLs, and http URLS.CollectionandCollectionPermission: for grouping files and controlling permission groups on those groups.SpatialEntry: the core model for indexing spatial metadata. This is intended to be inherited from but also provides a robust search filter.SpatialAsset: a simple spatial model for registering any collection of files with manually inputted spatial metadata.WhitelistedEmail: a model for pre-approving users for sign up.The core RGD app is intended to be inherited from for developing domain-specific
geospatial models. For instance, we will demo the implementation of the simpleSpatialAssetmodel shipped in this app.We can develop a new model on top ofdjango-rgdthrough the inheritting the
coreSpatialEntrymodel and using a few mixin classes fromdjango-rgd. This
new model will represent a collection of files with some spatial reference.fromdjango_extensions.db.modelsimportTimeStampedModelfromrgd.modelsimportChecksumFile,SpatialEntryclassSpatialAsset(SpatialEntry,TimeStampedModel):"""Any spatially referenced file set."""files=models.ManyToManyField(ChecksumFile,related_name='+')Just like that, you now have a way to associate a set of files to any geospatial
location. To populate data in this model, first createChecksumFilerecords,
then create a newSpatialAssetpopulating the fields defined fromSpatialEntry:acquisition_date,footprint,outline, andinstrumentation.Management CommandsThe core app has two management commands:rgd_s3_files: used to ingestChecksumFiles from S3 or
Google Cloud storage.whitelist_email: pre-approve users for sign-up.Use the--helpoption for more details.