Skip to content

Commit 31eea36

Browse files
marcvivesmassanapiotrkluba
marcvivesmassana
and
piotrkluba
authored
[FXC-4909] Project Settings (#55)
* content * Update docs/01.introduction/07.project-settings.md * added faq question --------- Co-authored-by: piotrkluba <piotr.kluba@flexcompute.com>
1 parent 80c0d6f commit 31eea36

4 files changed

Lines changed: 168 additions & 0 deletions

File tree

‎docs/01.introduction/07.project-settings.md‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Project Settings
2+
3+
*The Project Settings panel provides access to project-level configuration, run settings, and project metadata. This panel allows you to manage project properties, configure units, and view project statistics.*
4+
5+
---
6+
7+
## **Accessing Project Settings**
8+
9+
The Project Settings panel is accessible through:
10+
11+
- The settings icon in the top bar (next to the help icon)
12+
13+
<div align="center">
14+
15+
![Project Settings](Figures/project_settings.png)
16+
17+
</div>
18+
19+
- A dropdown menu appears with options including "Project settings" and "Variable settings"
20+
- Clicking "Project settings" opens the panel on the right side of the interface
21+
22+
---
23+
24+
## **Overview**
25+
26+
The Project Settings panel is organized into two main tabs:
27+
28+
- **Run settings**: Configuration options for the current simulation run, including units, mesher options, solver version, and run statistics
29+
- **Project details**: Project-level metadata including project name, ID, folder location, tags, description, and project cost
30+
31+
---
32+
33+
## **Run Settings Tab**
34+
35+
The "Run settings" tab contains configuration options and information specific to the current simulation run:
36+
37+
### **Project Information**
38+
39+
- **Project Name**: The name of the current project/case
40+
- Displayed with a document icon
41+
- Shows the case name for the current run
42+
43+
### **Units System**
44+
45+
- **Set up button**: Click "Set up" to open a dropdown menu with predefined unit system options:
46+
- **Set as SI**: Sets units to SI system (m, kg, s, K)
47+
- **Set as CGS**: Sets units to CGS system (cm, g, s, K)
48+
- **Set as Imperial**: Sets units to Imperial system (ft, lb, s, F)
49+
- Selecting a unit system applies the corresponding units across all settings in the project
50+
51+
### **Mesher Options**
52+
53+
- **Geometry AI**: Toggle switch for "Use the Geometry AI surface mesher"
54+
55+
- **Beta mesher**: Toggle switch for "Use the beta version of Mesher for simulation"
56+
57+
### **Solver Configuration**
58+
59+
- **Solver version**: Dropdown menu to select the Flow360 solver version (e.g., `release-25.8`)
60+
- Choose from available solver releases
61+
- Default is the latest stable release
62+
63+
- **Project length unit**: Dropdown menu to specify the length unit for the project. Available options: `m` (meters), `cm` (centimeters), `mm` (millimeters), `ft` (feet), `inch` (inches)
64+
65+
### **Run Status and Statistics**
66+
67+
> **Note:** The following sections (Run Status and Statistics, and Time Information) are only available when a simulation run has finished.
68+
69+
- **Status**: Displays the current status of the simulation run
70+
- Shows "Completed" with a green checkmark when the run has finished successfully
71+
- Other statuses may include "Running", "Queued", "Visualizing", "Failed".
72+
73+
- **Tags**: Option to add tags to the run for organization and filtering
74+
- Click "+ Add" to add new tags
75+
- Tags help categorize and search for runs
76+
77+
- **Volume ID**: Unique identifier for the volume mesh used in this run
78+
79+
- **Case cost**: Total FlexCredits consumed by this simulation run
80+
81+
- **Location**: The workspace where the project is stored
82+
83+
### **Time Information**
84+
85+
- **Total time**: Total duration of the simulation run
86+
87+
- **Time per stage**: Detailed breakdown of time spent in each simulation stage.
88+
89+
- **Creation time**: Timestamp when the case was created
90+
91+
- **Update time**: Timestamp when the case was last modified
92+
93+
---
94+
95+
## **Project Details Tab**
96+
97+
The "Project details" tab contains project-level metadata and information:
98+
99+
### **Project Information**
100+
101+
- **Project Name**: The name of the project. Can be edited.
102+
103+
- **Project ID**: Unique identifier for the project. Frequently used through the python API.
104+
105+
### **Organization**
106+
107+
- **Folder**: The workspace folder where the project is located. Can be expanded or edited to change the project location
108+
109+
- **Tags**: Option to add tags to the project for organization
110+
- Click "+ Add" to add new tags
111+
- Tags help categorize and search for projects
112+
113+
- **Description**: Optional text field for project description and notes.
114+
115+
### **Project Statistics**
116+
117+
- **Project cost**: Total FlexCredits consumed across all runs in this project. Cumulative cost of all simulation runs within the project
118+
119+
- **Solver version**: The solver version with which the project was created.
120+
121+
### **Timestamps**
122+
123+
- **Creation time**: Timestamp when the project was created
124+
125+
- **Update time**: Timestamp when the project was last modified
126+
127+
---
128+
129+
<details>
130+
<summary><h3 style="display:inline-block">❓ Frequently Asked Questions</h3></summary>
131+
132+
- **What's the difference between Run settings and Project details?**
133+
> Run settings contain configuration and statistics for the current simulation run, while Project details contain project-level metadata that applies to all runs in the project.
134+
135+
- **Can I change the solver version after a run has completed?**
136+
> Yes, you can change the solver version in Run settings, but this will only affect new runs. Completed runs retain their original solver version.
137+
138+
- **How do I change units for my entire project?**
139+
> Use the "Set up" button in the Units system section of Run settings to change all units at once.
140+
141+
- **What are FlexCredits?**
142+
> FlexCredits are the computational currency used in Flow360. Project cost shows the total credits consumed across all runs in the project.
143+
144+
- **Can I edit the project name?**
145+
> Project name can typically be edited in the Project details tab or through the project tree interface.
146+
147+
- **What is the difference between case cost and project cost?**
148+
> Case cost (in Run settings) shows the cost for a single simulation run, while project cost (in Project details) shows the cumulative cost of all runs in the project.
149+
150+
- **Why are run settings sometimes locked?**
151+
> When viewing a completed or running case, you are in view-only mode and cannot modify settings. To edit settings, you need to start a new run setup by clicking "New run" or "Fork" in the top bar.
152+
153+
</details>

‎docs/01.introduction/Figures/project_settings.png‎

10.4 KB
Loading

‎docs/01.introduction/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
|[General workflow](./04.general-workflow.md)| The example of a general workflow in the application |
1313
|[Project tree](./05.project-tree.md)| Description of the project tree and the concept of a project |
1414
|[Keyboard shortcuts](./06.shortcuts.md)| Available keyboard shortcuts in the Flow360 WebUI |
15+
|[Project settings](./07.project-settings.md)| Configuration and metadata for projects and simulation runs |
1516

1617
---
1718
## **Detailed Descriptions**
@@ -76,6 +77,18 @@
7677
- **Branching:** Supports multiple branches at each level for mesh sensitivity, parameter studies, and continuation runs (forks).
7778
- **Component Actions:** Open in workbench, create new run, interpolate, rename, view details, expand/collapse, delete.
7879

80+
---
81+
82+
### **Project Settings**
83+
84+
*The Project Settings panel provides access to project-level configuration, run settings, and project metadata. This panel allows you to manage project properties, configure units, and view project statistics.*
85+
86+
- **Run Settings:** Configuration options for the current simulation run, including units system, mesher options, solver version, and run statistics.
87+
- **Project Details:** Project-level metadata including project name, ID, folder location, tags, description, and project cost.
88+
- **Units Management:** Change all units in the setting system at once through the units system configuration.
89+
- **Mesher Options:** Toggle between standard and AI-powered surface meshing, and enable beta mesher features.
90+
- **Statistics:** View detailed timing information, FlexCredit costs, and status for runs and projects.
91+
7992
```{toctree}
8093
:hidden:
8194
:maxdepth: 3
@@ -85,4 +98,5 @@
8598
./04.general-workflow.md
8699
./05.project-tree.md
87100
./06.shortcuts.md
101+
./07.project-settings.md
88102
```

‎docs/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Content:
77
- [Workbench Layout](./01.introduction/03.workbench-layout/README.md)
88
- [General Workflow](./01.introduction/04.general-workflow.md)
99
- [Project Tree](./01.introduction/05.project-tree.md)
10+
- [Project Settings](./01.introduction/07.project-settings.md)
1011
- [Simulation Setup](./02.simulation-setup/README.md)
1112
- [Flow conditions](./02.simulation-setup/01.flow-conditions/README.md)
1213
- [Mesh](./02.simulation-setup/02.mesh/README.md)

0 commit comments

Comments
 (0)