websights

Fill out the form to download

Required field
Required field
Not a valid email address
Required field
Required field
  • Set up your own cloud-native simulation in minutes.

  • Dashboard

    Organizing your SimScale content is critical to allowing you and your colleagues to quickly and easily find the correct project while ensuring that only the correct people can access it. This can be done within your SimScale Dashboard. There are two core features of content organization at SimScale: Spaces and Folders.

    These features allow you to organize your content as well as allow your organization to efficiently manage groups of users and the simulation content they produce and access.

    Introduction

    An organization is a group of users on the SimScale platform with common goals, typically colleagues at a company. You and the other users will have common goals but will typically work on different internal projects or within different business units or groups. It is therefore important to be able to segregate the simulation content you produce so it is easier to find and possible to restrict access when needed. This can be referred to as space (section or area).

    Dashboard

    The Dashboard is one of the main environments in the SimScale platform. Users can create new projects, verify their core hour balance, and access projects that have been shared with them from their dashboard.

    Find below an overview of the functions available:

    dashboard folders and spaces
    Figure 1: The dashboard contains methods to organize, sort, search, and create projects.
    1. Projects lists the projects owned by the user, spaces it is a part of, and the projects shared with the user.
    2. A link to all the public projects ever created by any user
    3. Within a space, the user can view and create Folders for projects.
    4. Existing projects are shown in the center of the page.
    5. Different view modes and sorting options for projects
    6. Information panel for selected projects and folders
    7. The New Project button, on the top-right corner, is used to create new projects from scratch.
    8. Search bar, allowing you to search projects with keywords of interest
    9. Panel containing a summary of your core hour balance
    10. Admin permissions, to create and manage spaces, manage users and invitations. This is available only to the organizational admins.
    11. Access to public projects, forum, and other helpful sources, managing user account.
    12. Manage user details, simulation job usage overview, and API keys

    Create New Simulation Project

    To create a new simulation project, click the ‘New Project’ button on the Dashboard. The following dialog box appears:

    sharing project main settings
    Figure 2: Project creation dialog. Choose whether to make your project publicly accessible to everybody or to keep it private. In order to make your project private, you need to be in a Professional or Professional Trial account.
    1. Project Title: The project title should contain the name of the type of application you want to analyze as well as the simulation method you want to use, e.g. ‘Heat exchanger – CHT simulation’. This will help other users to understand what you’re trying to simulate.
    2. Public/Private Toggle: This toggle determines whether your project will be publicly available to everybody or only visible to you. A public project can be seen, copied, and downloaded by any SimScale user. In order to create private projects, you require a Professional SimScale account. See Plans & Pricing to upgrade or start your Professional trial.
    3. Project Description: Use the project description box to describe the purpose of your project in more detail. A good project description will make your project rank higher in the SimScale Public Projects Library.
    4. Project Category: The category selection allows you to categorize your project based on industry. Choosing a category will help your project rank higher in the SimScale Public Projects Library.
    5. Tags: Similar to the category selection, adding tags will help your project rank higher in the SimScale Public Projects Library. Tags are not pre-defined and can be chosen freely. A maximum of 12 tags can be added with each containing 3 – 50 characters.
    6. Advanced Settings: In the advanced settings you can choose whether to use SI or Imperial units to interact with the CAD model that you choose to upload into your project. You can also allow API access here.

    Once the project is created, you’ll automatically be redirected to the SimScale simulation platform i.e. the Workbench.

    Public vs Private Projects for Paid Users

    Users on a paid plan i.e. other than the free community plan can no longer create public projects. Such users still have the option to convert their previously created projects from public to private. Until then they remain public and accessible to every other user.

    Managing Projects

    The dashboard contains functionalities that allow you to create, open, copy, move, share, edit, and delete projects. By right-clicking on a project of interest, all options are shown:

    edit project menu
    Figure 3: Several options appear by right-clicking on a given project.

    Once a project is selected, all editing options are also available on the right-hand side panel:

    project editing in simscale dashboard
    Figure 4: After selecting a project, the editing icons are available on the right-hand side panel

    Furthermore, you can also open projects with a double left-click, or by selecting the project and clicking on the top-right icon:

    options to open a project from the dashboard
    Figure 5: Opening a project in Grid View Mode

    Sharing Projects

    Using the methods shown in figures 4 and 5, a specific project can be shared and the panel looks as follows:

    sharing a specific project
    Figure 6: Steps to sharing a specific project with a user and the sharing types

    Step 1 in Figure 6 shows the current accessibility of the project (Private). Enter the username(s) you wish to share the project with and then head to the next step using the sharing icon icon. Now add a sharing type that defines what the user can do with that shared project. Can view, Can copy, and Can edit are the three sharing types available in SimScale. They define how multiple users can collaborate.

    Sharing the project can also be done from within the Workbench. This and the different sharing types (view, copy, edit) are explained in the documentation below:

    Spaces and Folders

    My Projects

    Every user has access to personal space which they can create content in. It is represented as My Projects within the Dashboard. Only you can create content within your personal space as you are the only member it contains. 

    my project UI simscale dashboard
    Figure 7: The personal space functionality, named My Projects, is available to all users in SimScale and cannot be deleted.

    Permissions in ‘My Projects’

    The following table shows what you are permitted to do as a user in your personal space:

    Permission under ‘My Projects’Owner
    Can view content and folders:check_mark:
    Can copy content:check_mark:
    Can create content and folders:check_mark:
    Can move content:check_mark:
    Can edit content:check_mark:
    Can delete content:check_mark:
    Can share content:check_mark:
    Table 1: Permissions under My Projects and the activities allowed

    Spaces

    Customers with Spaces or Enterprise licenses have access to Spaces. Spaces is a section that can be seen by multiple users; its members are controlled by a company administrator.

    Spaces can be used to allow only certain users to access specific content. For example, you might have a space for each customer project (Customer A – HX1B, Customer B – RM101) or for each group at your company (Product, Simulation). Any content created within or moved to a space can only be accessed by members of that space and any users it has been directly shared with.

    spaces ui simscale
    Figure 8: In the above example a space named ‘SimScale’ is added under the Spaces space and it consists of 6 folders.

    As an administrator, you can add and manage spaces. This is shown below:

    manage spaces in simscale dashboard
    Figure 9: Go to Manage Spaces to add or manage spaces. Only the admin has access to this.

    Admin of an organization can set different sharing permissions which consist of No sharing, Within space, and Within organization.

    Depending on the sharing permissions set by the admin individual projects can be shared with other users outside the space or your organization or made public. In this case, users will not gain access to see the folder or the space where the project is located.

    Managing an Existing Space

    To manage an already existing space select the space (see Figure 9). This will open a panel similar to Figure 10 allowing you to rename and also control the sharing permissions as well as manage the space members.

    Adding a New Space

    To add a space click on the ‘+ Add space’ button (see Figure 9). This will open a panel where you can name the space, control the sharing permissions, and choose the members you want the space to include. Don’t forget to save the settings.

    adding a new space
    Figure 10: The panel to add a new space to the space. Only admin can create a new space.

    Permissions in ‘Spaces’

    Owners or members of a space get specific permissions for all projects contained in that space. In other words, the level of permissions granted is configurable. The following table shows what a space member is permitted to do if they have Admin, Edit, Copy, and View permissions:

    Permission of a space memberAdminEditCopyView
    Can view content:check_mark::check_mark::check_mark::check_mark:
    Can copy content:check_mark::check_mark::check_mark:
    Can create content and folders:check_mark::check_mark:
    Can move content:check_mark::check_mark:
    Can edit content:check_mark::check_mark:
    Can delete content:check_mark::check_mark:
    Can share content (if allowed by space setting):check_mark::check_mark:
    Can add/remove users to/from space:check_mark:
    Table 2: Different permissions in a space and the actions allowed

    Folders

    A folder is a location to store your content, including projects and other folders. Folders in SimScale are managed in your dashboard, as discussed in the Dashboard section within this document. Every folder has an editable name.

    Creating Folders

    To create a folder, navigate to a space that you have access to and select the icon in the upper right corner as shown. You will be prompted to provide a name for the folder.

    Figure 11: The blue arrow indicates the button to create new folders/subfolders. After creating a folder, you can start organizing by moving projects into them.

    Folders can be opened, moved, edited, and deleted. To access these options, you can right-click on the folder, or use the right-hand side panel after the folder is selected:

    Figure 12: You can access folder-related operations by either right-clicking on it, or selecting the folder and using the right-hand side panel

    Important

    When a folder is deleted, all contained folders and projects within it will be deleted.

    Organizational Account

    Managing Users

    Under Manage Users, admins of an organization can:

    1. See the organizational CPU hour and GPU hour availability
    managing users by admin on dashboard
    Figure 13: Admins can provide administrator access to others, invite or remove users and limit their core hour spending.
    1. Manage administrator rights, i.e. set other members as admins
    2. Invite users/colleagues to the account
      • The admin needs to confirm the invitations that are sent by the organization members.
      • Admins also have the right to cancel the invitation after the email is sent to the invitee.
    approve cancel user invite organization account simscale
    Figure 14: The admin has the right to approve or cancel any invitation sent.

    Admins have access to the 3-dot menu on the right which allows them to:

    • Remove users
    • Set CPU and GPU budgets/spending limits for specific users
    adjust cpu gpu hours
    Figure 15: Settings panel for controlling the CPU and GPU hour limit for specific users

    Removing a User

    If a user is removed from the organization the admin should select an inheritor user for all the projects that user owned. This includes projects in spaces and in personal space (My Projects).

    Last updated: October 4th, 2024

    Contents