Skip to content

Commit c02991a

Browse files
committed
Improve projects content
1 parent edbfde6 commit c02991a

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

tutorial/create_project.rst

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
Simulation Project
22
==================
33

4-
To Do:
5-
6-
* Explain what a simulation project is and what it contains
7-
* How to create a simulation project with the SDK
8-
9-
A simulation project is a container for the elements needed to setup a simulation, the two most
10-
important of them being the CAD geometry and the simulation or physics setup. We can visualize
11-
the hierarchy with a tree structure:
4+
A simulation project is a container for the building blocks needed to setup a simulation: the two most
5+
important of them being the CAD geometry and the physics setup. We can visualize the hierarchy with a tree structure:
126

137
.. code-block::
148
@@ -26,9 +20,9 @@ the hierarchy with a tree structure:
2620
2721
2822
Eeach simulation is linked to one geometry, and each simulation setup contains the physics definition.
29-
More details to follow in the specific steps.
23+
More details to follow in the specific steps for geometry and simulation workflows.
3024

31-
In order to create and manipulate simulation projects, the SimScale SDK provides a Projects API client:
25+
In order to create and manipulate simulation projects, the SimScale SDK provides a Projects API client module:
3226

3327
.. code-block:: python
3428
@@ -43,7 +37,7 @@ In order to create and manipulate simulation projects, the SimScale SDK provides
4337
4438
4539
We can see that the projects api object is initialized with the ``api_client``, which we previously
46-
initialized with our Api key and host URL.
40+
initialized with the data for our Api key and host URL.
4741

4842
The project data is hosted in a ``Project`` object, which is then included as the argument of the
4943
actual Api call to create the project:

0 commit comments

Comments
 (0)