TerraNexus API¶
This section describes the core functions and modules that constitutes the TerraNexus Web Application.
TerraNexus API Packages¶
The TerraNexus Web Application includes the following packages (django applications):
- TerraNexus Web Application Package
- Home Page Package
- OGC API Package
- OGC API Submodules
- ogcapi.admin module
- ogcapi.apps module
- ogcapi.consumers module
- ogcapi.forms module
- ogcapi.models module
- ogcapi.routing module
- ogcapi.urls module
- ogcapi.views module
BaseWorkflowExecutorBuildDGGRSProcessorDGGSZoneDataHandlerDGGSZoneHandlerDGGSZoneQueryHandlerExtendedStreamingDataProcessorFindChildZonesExecutorFindNeighbourZonesExecutorFindParentZonesExecutorFindRegisteredZonesExecutorGenerateNewZonesExecutorMapDataToZonesExecutorMapDataToZonesProcessorOGCAPICollectionItemsHandlerProcessExecutorProcessExecutorWithStreamingPublishToImmutableCatalogueProcessorStreamingDataProcessorWorkflowExecutorFactoryWorkflowManager_check_TerraNexusAuthentication()_executeBuildDGGRS_process()_executeFindChildZones_process()_executeFindNeighbourZones_process()_executeFindParentZones_process()_executeFindRegisteredZones_process()_executeGenerateNewZones_process()_executeMapDataToZones_process()_executePublishToImmutableCatalogue_process()_generate_feature_links()_get_required_feature_fields()_initialise_static_process_descriptions()_process_description_error()_process_properties_efficiently()_validate_ogcapi_applicationPackage_description()_validate_ogcapi_execute_document()_validate_ogcapi_input_description()_validate_ogcapi_input_value()_validate_ogcapi_output_description()_validate_ogcapi_output_value()_validate_ogcapi_process_description()_validate_ogcapi_workflow_description()api_definition()check_file_status()check_task_status()collection_dggs_definition()collection_dggs_definition_list()collection_dggs_zone_data()collection_dggs_zone_info()collection_dggs_zones_list()collection_items_list()collection_items_return()collection_landing_page()collection_queryables_list()collections()conformance()dggs_definition()dggs_definition_doc()dggs_definition_list()dggs_zone_data()dggs_zone_data_status()dggs_zone_info()dggs_zones_list()download_generated_file()get_collection_crs()get_collection_json()get_dggrs_definition()get_dggs_instances()get_feature_json()handle_zone_query()landing_page()process_callback_details()process_callback_failed()process_callback_inprogress()process_callback_list()process_callback_success()process_description()process_execution()process_job_details()process_job_result_details()process_job_results()process_jobs_list()process_workflows_collection_details()process_workflows_collections()process_workflows_details()process_workflows_list()processes_listing()serialize_for_celery()timeout()- ogcapi.views tasks
- ogcapi.tests module
- OGC API Submodules
- Surface DGGS Package
- Surface DGGS Subpackages
- Surface DGGS Submodules
- surface_dggs.apps module
- surface_dggs.consumers module
- surface_dggs.forms module
BuildSurfaceDGGSFormBuildSurfaceTerraNexusFormBuildSurface_rHealPIXFormClient_upload_fileFormSurfaceTerraNexus_FindCellsQueryFormSurfaceTerraNexus_GetCellCentroidsFormSurfaceTerraNexus_GetCellMeshFormSurfaceTerraNexus_GetCellVertsFormSurfaceTerraNexus_GetChildCellsQueryFormSurfaceTerraNexus_GetDataMeshFormSurfaceTerraNexus_GetMappedDataFormSurfaceTerraNexus_GetNeighbouringCellsQueryFormSurfaceTerraNexus_GetParentCellQueryFormSurfaceTerraNexus_MapDataFormSurfaceTerraNexus_RegisteredCellsQueryFormSurfaceTerraNexus_ToolsSelectionForm
- surface_dggs.routing module
- surface_dggs.tests module
- surface_dggs.urls module
- surface_dggs.views module
- Volumetric DGGS Package
- Volumetric DGGS Subpackages
- Volumetric DGGS Submodules
- volumetric_dggs.apps module
- volumetric_dggs.consumers module
- volumetric_dggs.forms module
BuildVolumetricDGGSFormBuildVolumetricTerraNexusFormLoadDataFormRepairVolumetricDGGSFormVolumetricTerraNexus_FindVoxelsQueryFormVolumetricTerraNexus_GetChildVoxelsQueryFormVolumetricTerraNexus_GetDataMeshFormVolumetricTerraNexus_GetMappedDataFormVolumetricTerraNexus_GetNeighbouringVoxelsQueryFormVolumetricTerraNexus_GetParentVoxelQueryFormVolumetricTerraNexus_GetVoxelCentroidsFormVolumetricTerraNexus_GetVoxelMeshFormVolumetricTerraNexus_GetVoxelVertsFormVolumetricTerraNexus_MapDataFormVolumetricTerraNexus_RegisteredVoxelsQueryFormVolumetricTerraNexus_ToolsSelectionForm
- volumetric_dggs.models module
- volumetric_dggs.routing module
- volumetric_dggs.tests module
- volumetric_dggs.urls module
- volumetric_dggs.views module
- Database Viewer Package
- TerraNexus Utilities Package
- TerraNexus Utilities Submodules
- util.dggs_operations module
RobustMongoDBBatchTracker_update_callback()_update_provenance_activity()batch_process_data_files()calculate_polygon_coverage()check_batch_status()check_job_status()cleanup_completed_batches()cleanup_references()clearCallbackLogs()create_collection_entity()create_dggs_instance()create_map_execution_agent()create_process_data_agent()create_reorganise_activity()create_reorganise_agent()create_surface_dggs_tasks()create_tesseract_geometry_df()create_test_points()create_volumetric_dggs_tasks()fetch_additional_data()fetch_next_page()find_cooincident_data()force_batch_completion()generate_radial_points()generate_zones()get_FMSDI_TideData()get_child_zone_coordinates_callback()get_child_zone_coverage_callback()get_chunk_size()get_feature_data()get_feature_parameters()get_job_data()get_mapped_child_zones_callback()get_mapped_data()get_new_zones_callback()get_voxels_callback()get_zoneTile_callback()handle_exception()handle_retry_exception()health_check()init_footprint_collection()init_properties_collection()initialise_registered_zones()initialize_dataset_collections()interpolate_path()interpolate_zoneCoverage_path()map_data()map_data_execution()map_feature_geometry()map_voxels_callback()map_zones_to_features_callback()mesh_cells()mesh_voxel()mesh_voxels_callback()orthometric_to_ellipsoidal()parse_temporal_value()process_batch_with_robust_mongodb()process_chunked_data()process_complex_tesseract_feature()process_data_file()process_data_file_batch()process_data_files_in_batches()process_feature()process_feature_collection()process_feature_data()process_feature_properties()process_feature_zones()process_features_in_batches()process_geometry_collection()process_geometry_collection_linestring()process_geometry_collection_multilinestring()process_geometry_collection_multipoint()process_geometry_collection_multipolygon()process_geometry_collection_point()process_geometry_collection_polygon()process_higher_resolution()process_level0_zone()process_linestring()process_multilinestring()process_multipoint()process_multipolygon()process_point_chunk()process_sample_points_in_batches()process_simple_tesseract_feature()process_spatial_dggs()process_tesseract_dggs()process_tesseract_resolution()process_volumetric_geometry()publish_message_to_group()recover_stuck_batch()recreate_dggs_zone()reprocess_missing_tasks()restart_all_selected_pods()restart_kubernetes_pod()restart_pod_callback()retry_failed_tasks()retry_mongodb_operation()retry_with_exponential_backoff()rotated_mesh_callback()setup_dggs()setup_provenance()setup_surface_dggs()setup_tesseract_dggs()setup_volumetric_dggs()store_feature_geometry()store_tesseract_coverage()store_tesseract_zone_mappings()store_zone_coverage()update_feature_bounding_box()update_map_execution_activity()update_process_data_activity()update_provenance_activity()update_reorganise_activity_completion()- util.dggs_operations tasks
- util.dggs_util module
- util.logging_middleware module
- util.ui_tools module
- util.slack_logger module
- util.dggs_operations module
- TerraNexus Utilities Submodules
- User Account Package
- User Account Submodules
- user.admin module
- user.apps module
- user.auth_middleware module
- user.decorators module
- user.forms module
- user.models module
CustomUserCustomUser.MetaCustomUser.check_password()CustomUser.clean()CustomUser.get_email_field_name()CustomUser.get_full_name()CustomUser.get_session_auth_hash()CustomUser.get_short_name()CustomUser.get_username()CustomUser.has_module_perms()CustomUser.has_perm()CustomUser.has_usable_password()CustomUser.is_anonymousCustomUser.is_authenticatedCustomUser.natural_key()CustomUser.normalize_username()CustomUser.save()CustomUser.set_password()CustomUser.set_unusable_password()CustomUser.validate_secret_question()
UserUser.DoesNotExistUser.MultipleObjectsReturnedUser.REQUIRED_FIELDSUser.USERNAME_FIELDUser.date_joinedUser.emailUser.first_nameUser.get_full_name()User.get_next_by_date_joined()User.get_next_by_last_login()User.get_previous_by_date_joined()User.get_previous_by_last_login()User.get_secret_question_1_display()User.get_secret_question_2_display()User.get_short_name()User.has_module_perms()User.has_perm()User.idUser.is_activeUser.is_staffUser.is_superuserUser.last_loginUser.last_nameUser.licencesUser.logentry_setUser.objectsUser.organisationUser.passwordUser.profile_pictureUser.secret_answer_1User.secret_answer_2User.secret_question_1User.secret_question_2User.username
UserManager
- user.serializers module
- user.tests module
- user.tokens module
- user.urls module
- user.views module
- User Signup Package
- Legal Package