Create Grasshopper examples

xRadne commented 3 years ago

Create examples for user to get started (and explore possibilites) with the API.

To start with, all the examples should be made for Grasshopper. Preferably all examples should have an equivalent in C#, Dynamo as well, but for now only the most basic examples should be created.

Instructions on getting started

[x] (Maybe) Update README.md installation section, if something is unclear.
[x] #304

Basic examples to implement (Scripts)

[x] Example 1: Creating a simply supported beam with supports, loads, loadcases - prio 1
[x] Example 2: Analyse a simple model - prio 1
[x] #253
[x] #202
[x] #257
[x] #258
[x] #266

Practical examples to implement (Scripts)

[x] Creating a parametric bridge model similar to this - prio 1 See attached specification below http://blog.rhino3d.com/2021/10/parametric-bridge-design-online.html https://sofistikforyou.com/challenges-of-bridge-design-and-detailing-in-autodesk-revit/ Exempel Bro Specifikation.docx
[ ] Bridge with complex load combinations and load groups. Crack analysis.
[ ] Pile stiffness - iterative optimization using scripting component (C#/Python) in Grasshopper #328
[ ] Reading and writing data to excel. Piling. Read piling report with actual pile coordinates (in SweRef) and update the supports to actual positions.
[ ] Create an example generating a simple plate (balcony?) and loads, running analysis and deciding reinforcement (iterative analysis)
[ ] Mapping between Revit/FEM Design (already started)
[ ] Example with iterative analysis in Grasshopper, using maybe Anemone or similar (for users who don't know C#)

Wishes from customers

[ ] Reading results
[ ] Adding elements to an existing model
[ ] Railway noise barriers
[ ] Basic piling situation

Possible examples (to be considered)

[ ] Approximating the functions of the FEM-Design load macros (wind, snow, moving load etc)
[ ] High rise building with varying wind load

JRiad commented 2 years ago

I think we need to have

Basic examples for understanding and learning how to use the API
Practical examples on what you actually want to do with the API, "real world problems"

Some (relatively simple) real world problems should be prioritized as they explain why you should even use the API

JRiad commented 2 years ago

@xRadne and @samnyb , I guess we should update examples to FD 21 version. Because they were made for FD 20 right?

xRadne commented 2 years ago

I agree! However it is not required since the API is backward compatible, meaning all grasshopper scripts made in v20 can be used with API v21. But it will have an OLD tag

The same goes for Dynamo.

But not C#, but it will give clear hints on what needs to be fixed,

xRadne commented 2 years ago

I agree! However it is not required since the API is backward compatible, meaning all grasshopper scripts made in v20 can be used with API v21.

The same goes for Dynamo.

But not C#, but it will give clear hints on what needs to be fixed,

Include this in documentation #35. Ping @andosca

xRadne commented 2 years ago

@samnyb I think the About component #189 should be added to all scripts as well.

samnyb commented 2 years ago

@xRadne and @samnyb , I guess we should update examples to FD 21 version. Because they were made for FD 20 right?

@samnyb I think the About component #189 should be added to all scripts as well.

I'll put both these things on my to-do-list!

andosca commented 2 years ago

I agree! However it is not required since the API is backward compatible, meaning all grasshopper scripts made in v20 can be used with API v21. The same goes for Dynamo. But not C#, but it will give clear hints on what needs to be fixed,

Include this in documentation #35. Ping @andosca

There is not any clear distinction between FD21 and FD20. For now it is backwards compatible as no xml-schema changes were introduced.

JRiad commented 2 years ago

Is it really backwards compatible all the way? I thought some components may have a changed number of inputs or have some changes, making it necessary to replace them. I think it would be nice at least to check that they work in FD 21

xRadne commented 2 years ago

Is it really backwards compatible all the way? I thought some components may have a changed number of inputs or have some changes, making it necessary to replace them. I think it would be nice at least to check that they work in FD 21

If the grasshopper plugin is not backwards compatible: It's a bug. The components we have changed should be functioning but marked as OLD.

samnyb commented 2 years ago

@xRadne and @samnyb , I guess we should update examples to FD 21 version. Because they were made for FD 20 right?

@samnyb I think the About component #189 should be added to all scripts as well.

I'll put both these things on my to-do-list!

[x] Checked all examples for OLD components
[x] Added About component to all examples

samnyb commented 2 years ago

Possible improvement of bridge example: using the Perp Frames component instead of orienting planes along axis. Cuts 7-8 components per flange. I haven't tested if it's a complete match in functionality though, so I'll have to get back to it at a later point.

samnyb commented 2 years ago

22/03/16: Add Python filepath component and logotype to all existing examples

[x] Example 1
[x] Example 2
[x] Example 3
[x] Example 4
[x] Example 5
[x] Example 6 (in progress)
[x] Example 7 (only logotype)
[x] Potentially the Bridge example

samnyb commented 2 years ago

2022-03-24: Load combination factors apparently in wrong order in example 2.

[x] Check example 2
[x] Check other examples for similar error

xRadne commented 2 years ago

We should create these examples in C# as well. These examples should be equivalent so that a user familiar with one framework could easily compare c# to grasshopper (and eventually python and/or dynamo)

samnyb commented 2 years ago

❗ FemDesign.Examples migration

We have initiated the process of migrating examples from FemDesign.Samples to a future directory called FemDesign.Examples. Progress on this is mapped in #203.

[x] 🎉 Grasshopper migration completed! All Examples are now found under FemDesign.Examples.

samnyb commented 2 years ago

@xRadne when you have time, I would like to merge branch 34 to master to set Example 7 in the right folder, and also rebase (?) branch 34 so the new structure is applied there as well, and all duplicate files removed. I still feel a little unsure around merging, so I would like your support, as well as a green light of the whole process, of course.

xRadne commented 2 years ago

@xRadne when you have time, I would like to merge branch 34 to master to set Example 7 in the right folder, and also rebase (?) branch 34 so the new structure is applied there as well, and all duplicate files removed. I still feel a little unsure around merging, so I would like your support, as well as a green light of the whole process, of course.

Example 7 added to master branch

strusoft / femdesign-api