Polish code

Author: ggiraldof

index.rst

@@ -60,5 +60,3 @@ Summary
    tutorial/meshing
    tutorial/simulation_run
    tutorial/postprocessing
-   advanced/advanced_topics
-

tutorial/api_keys.rst

@@ -19,7 +19,7 @@ If doing so, your ``.env`` file should contain a line such as:
 
 .. code-block:: python
 
-    SIMSCALE_API_KEY=(generated api key)
+    SIMSCALE_API_KEY="your_api_key"
 
 
 API Client
@@ -37,13 +37,10 @@ The following snippet shows an example of the creation and setup of the ``ApiCli
     # Python
 
     import os
-    from dotenv import load_dotenv()
 
     import simscale_sdk as sim
 
-    load_dotenv()
-
-    API_KEY = os.getenv('SIMSCALE_API_KEY')
+    API_KEY = "your_api_key"
     API_HOST_URL = "https://api.simscale.com/v0"
 
     configuration = sim.Configuration()
@@ -63,11 +60,9 @@ The following snippet shows an example of the creation and setup of the ``ApiCli
     using SimScale.Sdk.Api;
     using SimScale.Sdk.Client;
     using SimScale.Sdk.Model;
-    using dotenv.net;
 
-    DotEnv.Load();
 
-    var API_KEY = System.Environment.GetEnvironmentVariable("SIMSCALE_API_KEY")
+    var API_KEY = "your_api_key"
     var API_HOST_URL = "https://api.simscale.com/v0"
 
     Configuration configuration = new Configuration();

tutorial/create_project.rst

@@ -47,8 +47,8 @@ actual Api call to create the project:
     import simscale_sdk as sim
 
     project_data = sim.Project(
-        name="My first simulation project",
-        description="Created via SDK",
+        name="SDK Tutorial",
+        description="Created with SimScale SDK",
         measurement_system="SI"
     )
 

tutorial/meshing.rst

@@ -24,11 +24,13 @@ with a model object. It can be done as follows:
             curvature=sim.AutomaticCurvature(),
         ),
         automatic_layer_settings=sim.AutomaticLayerOn(
-            number_of_layers=3,
-            total_relative_thickness=0.4,
-            growth_rate=1.5
+            layer_type=sim.FractionalHeight2(
+                number_of_layers=3,
+                total_relative_thickness=0.4,
+                growth_rate=1.5
+            ),
         ),
-        pysics_based_meshing=True,
+        physics_based_meshing=True,
         hex_core=True,
     )
 
@@ -69,7 +71,7 @@ The mesh operation object is used to launch the computation and track its progre
     mesh_operation_api.start_mesh_operation(
         project_id,
         mesh_operation.mesh_operation_id,
-        simulation_id=simulation_id,
+        simulation_id=simulation.simulation_id,
     )
 
     while mesh_operation.status not in ("FINISHED", "CANCELED", "FAILED"):
@@ -98,11 +100,11 @@ so the platform knows that it should use it as part of the simulation computatio
 .. code-block:: python
 
     # Might not be needed if the simulation_spec object is updated
-    simulation_spec = simulations_api.get_simulation(project_id, simulation_id)
+    simulation_spec = simulations_api.get_simulation(project_id, simulation.simulation_id)
 
     simulation_spec.mesh_id = mesh_operation.mesh_id
 
-    simulations_api.update_simulation(project_id, simulation_id, simulation_spec)
+    simulations_api.update_simulation(project_id, simulation.simulation_id, simulation_spec)
 
 
 Now our simulation is ready for computation, with its physics model and a mesh

tutorial/postprocessing.rst

@@ -54,7 +54,7 @@ create a series of configuration objects:
 
     model_settings = sim.ModelSettings(
         parts=[],
-        sacalar_field=scalar_field,
+        scalar_field=scalar_field,
     )
 
     cutting_plane = sim.CuttingPlane(
@@ -121,7 +121,7 @@ happens in the platform:
 
     create_report_res = reports_api.create_report(
         project_id,
-        report_request,
+        report_req,
     )
 
     report_id = create_report_res.report_id

tutorial/simulation_run.rst

@@ -18,23 +18,23 @@ import or mesh computation operations:
 
     simulation_run = simulation_run_api.create_simulation_run(
         project_id,
-        simulation_id,
+        simulation.simulation_id,
         sim.SimulationRun(
             name="Run 1"
         ),
     )
 
     simulation_run_api.start_simulation_run(
         project_id,
-        simulation_id,
+        simulation.simulation_id,
         simulation_run.run_id,
     )
 
-    while simulation_run.status not in ("FINSIHED", "CANCELED", "FAILED"):
+    while simulation_run.status not in ("FINISHED", "CANCELED", "FAILED"):
 
         simualtion_run = simulation_run_api.get_simulation_run(
             project_id,
-            simulation_id,
+            simulation.simulation_id,
             simulation_run.run_id,
         )
 

tutorial/simulation_setup.rst

@@ -25,7 +25,7 @@ A ``SimulationSpec`` object is initialized with this data, then passed to the
         model=model
     )
 
-    simulation = simulation_api.create_simulation(project_id, simulation_spec)
+    simulation = simulations_api.create_simulation(project_id, simulation_spec)
 
 
 Now we need to delve deeper into the physics ``model``.
@@ -64,8 +64,8 @@ an example:
             ...
         ),
         numerics=sim.FluidNumerics(
-            relaxation_factors=sim.RelaxationFactor(),
-            pressure_reference_vale=sim.DimensionalPressure(value=0, unit="Pa"),
+            relaxation_factor=sim.RelaxationFactor(),
+            pressure_reference_value=sim.DimensionalPressure(value=0, unit="Pa"),
             residual_controls=sim.ResidualControls(
                 velocity=sim.Tolerance(),
                 pressure=sim.Tolerance(),
@@ -90,9 +90,9 @@ an example:
             delta_t=sim.DimensionalTime(value=1, unit="s"),
             write_control=sim.TimeStepWriteControl(write_interval=20),
             max_run_time=sim.DimensionalTime(value=10000, unit="s"),
-            decompose_altorithm=sim.ScotchDecomposeAlgorithm(),
-        )
-        result_control=sim.FluidResultControls()
+            decompose_algorithm=sim.ScotchDecomposeAlgorithm(),
+        ),
+        result_control=sim.FluidResultControls(),
     )
 
 
@@ -180,7 +180,7 @@ The boundary conditions are setup with the following code:
                 ],
             ),
         ),
-        VelocityInletBC(
+        sim.VelocityInletBC(
             name="Velocity inlet 2",
             velocity=sim.FixedValueVBC(
                 value=sim.DimensionalVectorFunctionSpeed(
@@ -204,7 +204,7 @@ The boundary conditions are setup with the following code:
                 ],
             ),
         ),
-        PressureOutletBC(
+        sim.PressureOutletBC(
             name="Pressure outlet",
             gauge_pressure=sim.FixedValuePBC(
                 value=sim.DimensionalFunctionPressure(