A general introduction of the projects tab

Introduction

The Projects tab serves as the primary landing page and central workspace within ColdStream. Here, you can create, configure, and manage all your project folders and individual cases. This article introduces the core functionalities and structural layout of the Projects tab.

Managing Project Folders

Creating a New Project

To start a new workspace, click the Add project button located in the top right corner of the Projects view. You will be prompted to provide a mandatory name and description for the newly created project folder.

Projects view example.

How to add a new project.

Editing Project Details

Project Name and Description

To update the project's metadata, open the desired project folder and click directly on its name or description text. Apply your modifications and click the checkmark to save, or the cross to discard the changes.

Project Thumbnail

A custom thumbnail can be assigned to a project folder for easier visual identification. To create one, open any case setup within that project, orient the 3D viewer to your preferred angle, and click the Camera icon in the toolbar. A prompt will appear allowing you to set this specific view as the project's official thumbnail.

How to set up a project's thumbnail.

Deleting a Project

To delete an existing project, open the target folder, click the Actions icon in the top right corner and select Delete Project. A confirmation modal will appear, requiring you to manually type the exact project name to authorize the deletion.

How to delete a project

❗️

Important

Deleting a project folder is irreversible and will permanently delete all cases and simulation data contained within that folder.

Project Tracking and Case Status

Each project tile provides a high-level summary of the cases inside it, allowing users to track progress without having to open every individual folder.

Project status

The overarching status of a project is displayed in the top right corner of its folder tile. This status aggregates the progress of all contained cases:

  1. Ongoing: At least one case is active and not yet finished.
  2. Problem: At least one case has encountered an error or stalled.
  3. Finished: All cases within the project have successfully completed.
  4. Closed: The project has been archived. You can manually archive any project by clicking its status indicator and selecting Close project.

You can filter your main dashboard to display only specific project statuses using the dropdown menu located next to the Add project button.

Status selection for projects.

Case Status Distribution

The bottom section of each project tile displays the total number of cases it contains (in the lower right corner) alongside a color-coded progress bar. This bar represents the real-time status distribution of those cases:

  1. Grey: The project is empty.
  2. Orange: Cases require setup input or are ready to be submitted.
  3. Blue: Cases are actively running.
  4. Green: Cases are finished and results are available.
  5. Red: Cases have stalled or encountered an error.

Hovering over the respective color segments on the bar will display the exact number of cases currently in that state.


Did this page help you?