This guide takes you from signing in to viewing your first resource. It uses the web interface and takes about five minutes on a running BisQue deployment.
Before you begin
Section titled “Before you begin”You need:
- the URL of a BisQue deployment;
- a BisQue account; and
- an image or other scientific data file to upload.
For a local developer deployment, see Run BisQue locally.
1. Sign in
Section titled “1. Sign in”Open BisQue and select Sign in. Your deployment may use a local account or redirect you to your organization’s identity provider.
After authentication, BisQue returns you to the page you originally requested.
2. Upload a resource
Section titled “2. Upload a resource”- Select Upload in the application toolbar.
- Drop one or more files into the upload area, or choose them with the file picker.
- Review the permission for each file. New resources are Private by default.
- Optionally add tags or choose a dataset destination.
- Start the upload.
The upload queue continues to show transfer and processing status. Large scientific images may need additional server-side processing before they can be viewed. Archives can pause at Needs input when BisQue needs you to confirm how their contents should be interpreted.
3. Open the result
Section titled “3. Open the result”When processing finishes, select the output name in the upload queue. BisQue opens the viewer appropriate for that resource type.
For an image, try the available slice, channel, and display controls. Supported multidimensional images retain their scientific metadata, while compatible TIFF input is normalized for efficient image serving.
4. Create a project
Section titled “4. Create a project”- Go to Projects and select New project.
- Enter a unique project name.
- Choose the project’s annotation geometry and label configuration.
- Add collaborators if needed, then create the project.
- Add your uploaded resource to the project.
Projects bring resources, labels, collaborators, annotation branches, and workflows into one workspace. Continue with Create an annotation project or Build and run a workflow.
If something goes wrong
Section titled “If something goes wrong”- The upload pauses: Open the item in the upload queue and follow the requested archive review step.
- Processing fails: Use Retry when it is offered. A failed destination publication can be retried without retransferring a completed upload.
- A feature is missing: Ask the deployment administrator whether that capability is enabled. BisQue advertises optional capabilities to the web interface instead of showing actions that cannot work.