Tuturial read me by MSlootwegVIKTOR · Pull Request #1 · viktor-platform/sample-dynamo

MSlootwegVIKTOR · 2023-04-12T12:42:31Z

No description provided.

MSlootwegVIKTOR · 2023-04-12T12:44:18Z

README.md

@@ -1,59 +1,380 @@
-![](https://img.shields.io/badge/SDK-v13.0.0-blue) <Please check version is the same as specified in requirements.txt>
+# Tuturial dynamo 
+Welcome to this tutorial on integrating Dynamo with VIKTOR! VIKTOR is a platform dedicated to the Engineering and Construction industry, providing a seamless integration with 3rd party software. In this tutorial, we will explore how to render a basic house with Dynamo and visualize it in VIKTOR. To get started, the user will provide parameters such as the number of houses, width, depth, number of floors, and heights for floors and roofs. The Viktor worker will then compute the Dynamo model using the command-line interface included within Dynamo Sandbox. The geometry of the model is generated using either Autodesk Revit or FormIt. The geometry JSON is then converted to a mesh, which is rendered and visualized in Viktor. In this tutorial, we will cover the step-by-step process of setting up a VIKTOR app with Dynamo integration we will cover:


Suggested change

Welcome to this tutorial on integrating Dynamo with VIKTOR! VIKTOR is a platform dedicated to the Engineering and Construction industry, providing a seamless integration with 3rd party software. In this tutorial, we will explore how to render a basic house with Dynamo and visualize it in VIKTOR. To get started, the user will provide parameters such as the number of houses, width, depth, number of floors, and heights for floors and roofs. The Viktor worker will then compute the Dynamo model using the command-line interface included within Dynamo Sandbox. The geometry of the model is generated using either Autodesk Revit or FormIt. The geometry JSON is then converted to a mesh, which is rendered and visualized in Viktor. In this tutorial, we will cover the step-by-step process of setting up a VIKTOR app with Dynamo integration we will cover:

Welcome to this tutorial on integrating Dynamo with VIKTOR! VIKTOR is a platform dedicated to the Engineering and Construction industry, providing a seamless integration with 3rd party software. In this tutorial, we will explore how to render a basic house with Dynamo and visualize it in VIKTOR. To get started, the user will provide parameters such as the number of houses, width, depth, number of floors, and heights for floors and roofs. The Viktor worker will then compute the Dynamo model using the command-line interface included within Dynamo Sandbox. The geometry of the model is generated using either Autodesk Revit or FormIt. The geometry JSON is then converted to a mesh, which is rendered and visualized in VIKTOR. In this tutorial, we will cover the step-by-step process of setting up a VIKTOR app with Dynamo integration we will cover:

MSlootwegVIKTOR · 2023-04-12T12:45:43Z

README.md

+Step 2. [Setting up worker](#2-fill-the-template-with-data)

-An example of the application is shown in the image below.
+By the end of this tutorial, you will have created a simple viktor application that creates a geometry and data view of a simple house, see gif below:


Suggested change

By the end of this tutorial, you will have created a simple viktor application that creates a geometry and data view of a simple house, see gif below:

By the end of this tutorial, you will have created a simple VIKTOR application that creates a geometry and data view of a simple house, see GIF below:

MSlootwegVIKTOR · 2023-04-12T12:46:31Z

README.md


-Additionally, the file should contain the following arguments:
+During the tutorial, we added some links to additional information; but don't let them distract you too much. Stay
+focused on completing the tutorial. After this, you will know everything you need to create an app which includes Dynamo integration.


Suggested change

focused on completing the tutorial. After this, you will know everything you need to create an app which includes Dynamo integration.

focused on completing the tutorial. After this, you will know everything you need to create an app which includes integrating with Dynamo.

MSlootwegVIKTOR · 2023-04-12T12:47:26Z

README.md

+the terminal:

+```
+viktor-cli create-app my-Dynamo-app


Suggested change

viktor-cli create-app my-Dynamo-app

viktor-cli create-app my-dynamo-app

My preference goes for lowercase project names

MSlootwegVIKTOR · 2023-04-12T12:48:20Z

README.md

+the application editor.
+
+### Step 1.2 Define the input fields
+The dynamo file has got the following input paramaters.


Suggested change

The dynamo file has got the following input paramaters.

The Dynamo file has got the following input paramaters.

MSlootwegVIKTOR · 2023-04-12T12:52:20Z

README.md

+2. With the update method, the value of input nodes can be updated.
+3. When all inputs have been updated as desired, the generate method can be used to generate an updated `File` object.
+
+### Step 1.4 Define the app logic to convert the output.xml to a data_group


Suggested change

### Step 1.4 Define the app logic to convert the output.xml to a data_group

### Step 1.4 Define the app logic to convert the output.xml to a DataGroup

MSlootwegVIKTOR · 2023-04-12T12:52:52Z

README.md

+3. When all inputs have been updated as desired, the generate method can be used to generate an updated `File` object.
+
+### Step 1.4 Define the app logic to convert the output.xml to a data_group
+In this step, we will define code to extract data from the dynamo file and output file. The dynamo file is used to get the node id, and the output.xml file is used to get the values. We will be creating another `staticmethod`  in the `controller`    class. See code below:


Suggested change

In this step, we will define code to extract data from the dynamo file and output file. The dynamo file is used to get the node id, and the output.xml file is used to get the values. We will be creating another `staticmethod` in the `controller` class. See code below:

In this step, we will define code to extract data from the Dynamo file and output file. The Dynamo file is used to get the node id, and the output.xml file is used to get the values. We will be creating another `staticmethod` in the `Controller` class. See code below:

MSlootwegVIKTOR · 2023-04-12T12:55:49Z

README.md

+Let us go through the above mentioned logic:
+1. Get the node_id, which corresponds to the same node id as the input file.
+2. Collect the numerical results.
+3. We create a structured data group from the collected numerical results using the `DataGroup` and `DataItem` classes.


I'm not sure if the reader will understand what we mean by a structured DataGroup. Maybe good to mention that for more information on this, refer to:

https://docs.viktor.ai/docs/create-apps/results-and-visualizations/data-and-tables

MSlootwegVIKTOR · 2023-04-12T12:56:04Z

README.md

+
+### Step 1.5 generate a geometry and data view
+
+We create a new `GeometryAndDataView` method insdie the `controller` class. This method will enable us to show the 3D model of the house along with its data. Here is the code:


Suggested change

We create a new `GeometryAndDataView` method insdie the `controller` class. This method will enable us to show the 3D model of the house along with its data. Here is the code:

We create a new `GeometryAndDataView` method insdie the `Controller` class. This method will enable us to show the 3D model of the house along with its data. Here is the code:

MSlootwegVIKTOR · 2023-04-12T12:56:26Z

README.md

+    return GeometryAndDataResult(geometry=glb_file, data=data_group)
+```
+Let us go through the above mentioned logic:
+1. Update the dynamo file with the `update_model` method(see step 1.3)


Suggested change

1. Update the dynamo file with the `update_model` method(see step 1.3)

1. Update the Dynamo file with the `update_model` method(see step 1.3)

MSlootwegVIKTOR · 2023-04-12T13:01:08Z

@LuukBoot I've reviewed the tutorial. Maybe good that @dsommersviktor also takes a quick look?

ddijkhuizen

I think there's still quite some reformatting to do before it is suitable to be included in the docs.

The most major point is the structure. You want people to have results fast. Therefore I would think the structure should be such that the user would:

Create input fields
Create a GeometryView with mocked output files
Create a data processing method
Create a DataView with the mocked output files
Create a GeometryAndDataView with the mocked output files
Add the worker logic to supply real output files

Other than that some textual changes I also remarked on the recent 3D model tutorial:

No numbered headings below the top level (Introduction, Prerequisites and To infinity and beyond sections have no numbering despite being on the top level)
Include showLineNumbers at code snippets
Having first references to any object which can be linked to another part of the docs include a link to that object.
The app can be bumped to V14 so we can lose the viktor_enforce_field_constraint = True
Include the warning on app creation that this tutorial was written with V14 and that the create-app command will always create an app of the most recent SDK version which may cause unforeseen behaviour.

I do have to say that I am impressed with the brevity of this tutorial even though the subject matter is slightly more complex!!

Interested to hear what you think about it!

LuukBoot added 4 commits April 3, 2023 13:36

v1

18c4035

V1

24ea511

V1.1 (minor changes)

6507f54

V1.1

e97396a

MSlootwegVIKTOR commented Apr 12, 2023

View reviewed changes

MSlootwegVIKTOR requested a review from ddijkhuizen April 12, 2023 13:00

ddijkhuizen reviewed Apr 18, 2023

View reviewed changes

LuukBoot added 6 commits April 24, 2023 11:16

Updated

2c032ef

Updated

a640c6b

Final

71f112d

Minor changes

81015f8

minor changes

f9e59a0

UPdated tutuorial

dde9e55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tuturial read me#1

Tuturial read me#1
MSlootwegVIKTOR wants to merge 10 commits intomainfrom
Tuturial_read_me

MSlootwegVIKTOR commented Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR Apr 12, 2023

Uh oh!

MSlootwegVIKTOR commented Apr 12, 2023

Uh oh!

ddijkhuizen left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	By the end of this tutorial, you will have created a simple viktor application that creates a geometry and data view of a simple house, see gif below:
	By the end of this tutorial, you will have created a simple VIKTOR application that creates a geometry and data view of a simple house, see GIF below:

	focused on completing the tutorial. After this, you will know everything you need to create an app which includes Dynamo integration.
	focused on completing the tutorial. After this, you will know everything you need to create an app which includes integrating with Dynamo.

	viktor-cli create-app my-Dynamo-app
	viktor-cli create-app my-dynamo-app

	The dynamo file has got the following input paramaters.
	The Dynamo file has got the following input paramaters.

	### Step 1.4 Define the app logic to convert the output.xml to a data_group
	### Step 1.4 Define the app logic to convert the output.xml to a DataGroup

	In this step, we will define code to extract data from the dynamo file and output file. The dynamo file is used to get the node id, and the output.xml file is used to get the values. We will be creating another `staticmethod` in the `controller` class. See code below:
	In this step, we will define code to extract data from the Dynamo file and output file. The Dynamo file is used to get the node id, and the output.xml file is used to get the values. We will be creating another `staticmethod` in the `Controller` class. See code below:


		### Step 1.5 generate a geometry and data view

		We create a new `GeometryAndDataView` method insdie the `controller` class. This method will enable us to show the 3D model of the house along with its data. Here is the code:

	1. Update the dynamo file with the `update_model` method(see step 1.3)
	1. Update the Dynamo file with the `update_model` method(see step 1.3)

Conversation

MSlootwegVIKTOR commented Apr 12, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MSlootwegVIKTOR commented Apr 12, 2023

Uh oh!

ddijkhuizen left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants