Karamba toolkit - Converters for K3D 1D model created

[EnricoAntolini]

NOTE: Requires installation of Karamba V3 (pre-release)

Install from:
https://github.com/karamba3d/K3D_NightlyBuilds/releases/tag/3.0.0.4-WIP

Make sure you have the right version by using the Karamba License component:

Description

This PR effectively add translation of Karamba elements to BHoM objects.
In order to Push to external software the converted BHoM objects, some new BHoM_Adapter feature have been implemented. Not all Toolkits have these features already. Currently, you will need:

• Robot (no action needed -- PR already merged and present in latest installer): it should just work.
• No other toolkit supported at the moment

Issues addressed by this PR

Closes #5

Test files

1. Test from @Martian42

2. Beam cantilever test with Push to Robot: (@IsakNaslundBh could we go through the second bullet point under here together? Could be an example of a BHoM_Adapter issue in the Push of multiple types at same time @alelom)

   • Example file that includes Karamba components: Beam_Cantilever.zip

   • Example file with internalised BHoM objects converted from Karamba (does not require Karamba installed): Beam_Cantilever_convertedFromKarambaInternalised.zip
     Currently this has an issue
     

[alelom]

@BHoMBot check required

[EnricoAntolini]

At the moment there is an bug in the Karamba3D_Engine_Tests.TestUtilities.BuildModel() that needs an update to a new NuGet version. This will affect only the test and not the converters and is the reason why tests for loads are commented and return a warning for now.

[EnricoAntolini]

The ResourceDesigner it is used to handle the .res file where all the warning and error messages are stored. This class is automatically generated and therefore any changes will be deleted every time there is a new change. Would make sense to avoid the compliance checks in this case.

[alelom]

Approving based on:

• Code review: all looks good and makes sense. I would agree with the request for dispensation of the ResourceDesigner file @FraserGreenroyd.
• Test scripts. All works well now. Tested with Robot, and the current implementation of the base adapter makes this work also with all other structural adapters. Although testing on other adapters will be required, I believe that the current PR holds no responsibility on their working on the BHoM objects output from a Karamba model conversion.
• Unit test. The provided unit test effectively contribute to the verification of the added functionality. Some improvement is due on some unit tests due to a technical issue with the Karamba Nuget, but this does not affect the functionality, as proven by the test scripts. Therefore, improvements on the unit tests can be done on a separate PR.

[alelom]

@BHoMBot check required

[bhombot-ci]

@alelom to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[bhombot-ci]

Please be advised that the check with reference 11799346399 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 134 additional annotations waiting, made up of 122 errors and 12 warnings.

[bhombot-ci]

The check serialisation has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

This repository is not part of the beta package and does not require a versioning check to be performed.

[bhombot-ci]

This repository is not part of the installer package, and does not require an installer check.

[FraserGreenroyd]

Based on chat with @alelom just now, project-compliance failures are ok currently given the set up, and will necessitate changes to Test_Toolkit instead to make use of $(ProgramData) instead of C:\ProgramData going forward to aid non C: Drive developers.

The code compliance, the use of a resx file is currently not compliant to BHoM guidelines from historic set up reasons, and would traditionally be handled with a Query method getting those warnings/errors instead. However, we're evolving BHoM constantly and our move into ZeroCodeTools also supports a change in how we handle certain elements so we can/should have a discussion on this as we end this milestone and go into the next.

For now though, there isn't a requirement for the check to pass until the toolkit goes into alpha (which I know is also desired to happen soon but won't happen in the next sprint due to beta production) so this is fine.

I have requested dispensation for project-compliance and am happy to grant that given the above.

[bhombot-ci]

FAO: @FraserGreenroyd
@FraserGreenroyd is seeking dispensation on this Pull Request to skip a required check. Please can you provide authorisation for the check to be skipped, or provide assistance as appropriate.

The check they wish to have dispensation on is project-compliance.

If you are providing dispensation on this occasion, please reply with:

@BHoMBot this is a DevOps instruction. I am authorising dispensation to be granted on check ref. 11799346399