Changes for page HBP Image Service User Guide
Last modified by alexisdurieux on 2022/05/05 10:13
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. mmorgan1 +XWiki.evareill - Content
-
... ... @@ -1,16 +1,45 @@ 1 -=== What is the //Image Service//? === 1 +(% class="jumbotron" %) 2 +((( 3 +(% class="container" %) 4 +((( 5 +== Documentation for the HBP Image Service == 6 +))) 7 +))) 2 2 3 -The image service is designed to optimize the visualization and/or the processing of very large 2D or 3D images. The image service preprocesses such images, and converts them into 2D tiles or 3D chunks at various levels of resolution. This allows end-users to browse (pan and zoom) through a very large image without having to download the entire image. 9 +(% class="row" %) 10 +((( 11 +(% class="col-xs-12 col-sm-8" %) 12 +((( 13 += What can I find here? = 4 4 5 -A common example everyone is familiar with is Google Map or Google Earth where the image is a very large 2D projection of the planet's surface. 15 +* A broad description of the HBP Image Service. 16 +* Documentation on how to interact with the service 17 +* Walk through examples on the workflows of the service. 6 6 7 -= ==Who has access? ===19 += Who has access? = 8 8 9 -Th eimageservice isavailabletouserswithan EBRAINS account. The userquires authorizationtoconsume supercomputingresources and,assuch,furtherlimitationsmay apply.21 +This documentation is intended for public access. The current version of the service has limited public read access and the features require an EBRAINS account for the moment. 10 10 11 -= ==Howis theserviceavailable? ===23 += What is the Image Service? = 12 12 13 -The service can be accessed either:25 +The Image Service was designed to allow users to process imaging data in order to be used with interactive HBP tools. These tools often need special formats and data descriptors to work, and the Image Service's goal is to provide streamlined workflows with which datasets can be made available to these tools with the simplest possible input, on-demand, using resources allocated in the [[FENIX Research Infrastructure>>attach:https://fenix-ri.eu/]]. 14 14 15 -* via the [[User Interface>>https://image-service.ebrains.eu||rel=" noopener noreferrer" target="_blank"]] 16 -* via its API (see its [[Swagger documentation>>https://img-svc.apps.hbp.eu/api/||rel=" noopener noreferrer" target="_blank"]]) 27 += Where is the service available? = 28 + 29 +The user facing part of the service is currently hosted on HBP's own OpenShift cluster and is available at: 30 + 31 +[[https:~~/~~/img-svc.apps.hbp.eu/>>https://img-svc.apps.hbp.eu/]] 32 + 33 +The only way to currently interact with the Service is through its API. An [[interactive API documentation>>https://img-svc.apps.hbp.eu/api]] is exposed so users and developers can conveniently explore its features and requirements. 34 +))) 35 + 36 + 37 +(% class="col-xs-12 col-sm-4" %) 38 +((( 39 +{{box title="**Contents**"}} 40 +{{toc/}} 41 +{{/box}} 42 + 43 + 44 +))) 45 +)))