Karamba3D v3
  • Welcome to Karamba3D
  • New in Karamba3D 3.1
  • See Scripting Guide
  • See Manual 2.2.0
  • 1 Introduction
    • 1.1 Installation
    • 1.2 Licenses
      • 1.2.1 Cloud Licenses
      • 1.2.2 Network Licenses
      • 1.2.3 Temporary Licenses
      • 1.2.4 Standalone Licenses
  • 2 Getting Started
    • 2 Getting Started
      • 2.1 Karamba3D Entities
      • 2.2 Setting up a Structural Analysis
        • 2.2.1 Define the Model Elements
        • 2.2.2 View the Model
        • 2.2.3 Add Supports
        • 2.2.4 Define Loads
        • 2.2.5 Choose an Algorithm
        • 2.2.6 Provide Cross Sections
        • 2.2.7 Specify Materials
        • 2.2.8 Retrieve Results
      • 2.3 The Karamba3D Menu
      • 2.4 User Settings
      • 2.5 Physical Units
      • 2.6 Asynchronous Execution of Karamba3D Components
      • 2.7 Quick Component Reference
  • 3 In Depth Component Reference
    • 3.0 Settings
      • 3.0.1 License
    • 3.1 Model
      • 3.1.1 Assemble Model
      • 3.1.2 Disassemble Model
      • 3.1.3: Modify Model
      • 3.1.4: Connected Parts
      • 3.1.5: Activate Element
      • 3.1.6 Create Linear Element
        • 3.1.6.1 Line to Beam
        • 3.1.6.2 Line to Truss
        • 3.1.6.3 Connectivity to Beam
        • 3.1.6.4: Index to Beam
      • 3.1.7 Create Surface Element
        • 3.1.7.1: Mesh to Shell
        • 3.1.7.2: Mesh to Membrane
      • 3.1.8: Modify Element
      • 3.1.9: Point-Mass
      • 3.1.10: Disassemble Element
      • 3.1.11: Make Element-Set
      • 3.1.12: Orientate Element
      • 3.1.13: Dispatch Elements
      • 3.1.14: Select Elements
      • 3.1.15: Support
    • 3.2: Load
      • 3.2.1: General Loads
      • 3.2.2: Beam Loads
      • 3.2.3: Disassemble Mesh Load
      • 3.2.4 Load-Case-Combinations
        • 3.2.5.1 Load-Case-Combinator
        • 3.2.5.2 Disassemble Load-Case-Combinaton
        • 3.2.5.3 Load-Case-Combination Settings
    • 3.3: Cross Section
      • 3.3.1: Beam Cross Sections
      • 3.3.2: Shell Cross Sections
      • 3.3.3: Spring Cross Sections
      • 3.3.4: Disassemble Cross Section
      • 3.3.5: Eccentricity on Beam and Cross Section
      • 3.3.6: Modify Cross Section
      • 3.3.7: Cross Section Range Selector
      • 3.3.8: Cross Section Selector
      • 3.3.9: Cross Section Matcher
      • 3.3.10: Generate Cross Section Table
      • 3.3.11: Read Cross Section Table from File
    • 3.4: Joint
      • 3.4.1: Beam-Joints
      • 3.4.2: Beam-Joint Agent
      • 3.4.3: Line-Joint
    • 3.5: Material
      • 3.5.1: Material Properties
      • 3.5.2: Material Selection
      • 3.5.3: Read Material Table from File
      • 3.5.4: Disassemble Material
    • 3.6: Algorithms
      • 3.6.1: Analyze
      • 3.6.2: AnalyzeThII
      • 3.6.3: Analyze Nonlinear WIP
      • 3.6.4: Large Deformation Analysis
      • 3.6.5: Buckling Modes
      • 3.6.6: Eigen Modes
      • 3.6.7: Natural Vibrations
      • 3.6.8: Optimize Cross Section
      • 3.6.9: BESO for Beams
      • 3.6.10: BESO for Shells
      • 3.6.11: Optimize Reinforcement
      • 3.6.12: Tension/Compression Eliminator
    • 3.7 Results
      • 3.7.1 General Results
        • 3.7.1.1 ModelView
        • 3.7.1.2 Result Selector
        • 3.7.1.3 Deformation-Energy
        • 3.7.1.4 Element Query
        • 3.7.1.5 Nodal Displacements
        • 3.7.1.6 Principal Strains Approximation
        • 3.7.1.7 Reaction Forces
        • 3.7.1.8 Utilization of Elements
        • 3.7.1.9 ReactionView
      • 3.7.2 Results on Beams
        • 3.7.2.1 BeamView
        • 3.7.2.2 Beam Displacements
        • 3.7.2.3 Beam Forces
        • 3.7.2.4 Node Forces
      • 3.7.3 Results on Shells
        • 3.7.3.1 ShellView
        • 3.7.3.2 Line Results on Shells
        • 3.7.3.3 Result Vectors on Shells
        • 3.7.3.4 Shell Forces
        • 3.7.3.5 Shell Sections
    • 3.8 Export
      • 3.8.1 Export Model to DStV
      • 3.8.2 Json/Bson Export and Import
      • 3.8.3 Export Model to SAF
      • 3.8.4 Export/Import Model to and from Speckle (WIP)
    • 3.9 Utilities
      • 3.9.1: Mesh Breps
      • 3.9.2: Closest Points
      • 3.9.3: Closest Points Multi-dimensional
      • 3.9.4: Cull Curves
      • 3.9.5: Detect Collisions
      • 3.9.6: Get Cells from Lines
      • 3.9.7: Line-Line Intersection
      • 3.9.8: Principal States Transformation
      • 3.9.9: Remove Duplicate Lines
      • 3.9.10: Remove Duplicate Points
      • 3.9.11: Simplify Model
      • 3.9.12: Element Felting
      • 3.9.13: Mapper
      • 3.9.14: Interpolate Shape
      • 3.9.15: Connecting Beams with Stitches
      • 3.9.16: User Iso-Lines and Stream-Lines
      • 3.9.17: Cross Section Properties
      • 3.9.18 Surface To Truss
    • 3.10 Parametric UI
      • 3.10.1: View-Components
      • 3.10.2: Rendered View
  • Troubleshooting
    • 4.1: Miscellaneous Questions and Problems
      • 4.1.0: FAQ
      • 4.1.1: Installation Issues
      • 4.1.2: Purchases
      • 4.1.3: Licensing
      • 4.1.4: Runtime Errors
      • 4.1.5: Definitions and Components
      • 4.1.6: Default Program Settings
    • 4.2: Support
  • Appendix
    • A.1: Release Notes
      • Work in Progress Versions
      • Older Versions
      • Version 2.2.0
      • Version 2.2.0 WIP
      • Version 1.3.3
      • Version 1.3.2 build 190919
      • Version 1.3.2 build 190731
      • Version 1.3.2 build 190709
      • Version 1.3.2
    • A.2: Background information
      • A.2.1: Basic Properties of Materials
      • A.2.2: Additional Information on Loads
      • A.2.3: Tips for Designing Statically Feasible Structures
      • A.2.4: Performance Optimization in Karamba3D
      • A.2.5: Natural Vibrations, Eigen Modes and Buckling
      • A.2.6: Approach Used for Cross Section Optimization
    • A.3: Workflow Examples
    • A.4: Bibliography
Powered by GitBook
On this page
  • Installation via Installer Program
  • Installation via the YAK Package Manager
  • Rhino6, Rhino7 and Rhino8 in parallel
  • Silent Installation
  • Automate installation
  1. 1 Introduction

1.1 Installation

PreviousNew in Karamba3D 3.1Next1.2 Licenses

Last updated 16 days ago

These are the prerequisites for installing Karamba3D:

  • Rhino 6.0 (PC only), Rhino 7.0 or Rhino 8.0.

  • Grasshopper

  • Windows 10 or above / macOS 12 or above

In case you do not possess , download a fully featured, free trial version.

Installation via Installer Program

The installation procedure lets you set the physical units used for calculation. By default Karamba3D assumes input to be in SI units (e.g. meters for point coordinates). You can switch to Imperial units either on installation or later via the Grasshopper/Karamba3D menu under "Physical Units". When using Imperial Units coordinates will be interpreted to be in “feet”, force in “kips”, material strength in “ksi” and so on.

Upon successful installation you should see a Karamba3D tab when you open Grasshopper in Rhino. Additionally, as a default setting a shortcut to the installation folder will be placed on your desktop. Double-click on the Karamba3D desktop-icon will get you to the standard installation directory which is in the Plug-ins-folder of your Rhino installation directory.

Karamba3D license can be activated as cloud or network licenses. Standalone licenses are only valid for workshops or universities.

Installation via the YAK Package Manager

Karamba3D can only be installed via msi-file or yak. If both are installed at the same time, the 'Karamba3DGetLicense'-command will not work. If you happen to have installed both: uninstall them and remove the Karamba3DLicense-plugin in Rhino via Options/Plug-ins, unhooking 'Enabled' and restarting Rhino.

YAK is the Package Manager for Rhino. It can automatically download and install plug-ins required for a specific Grasshopper definition. Thus one possibility of installing Karamba3D is to open a GH definition with some Karamba3D components in it. Alternatively the package manager can be started in Rhino by typing 'PackageManager' in the command window. Make sure to activate 'Include pre-releases' in the window that pops-up. Under YAK Karamba3D comes as 'karambaGH' which installs the FULL version of Karamba3D.

The Rhino8 Package Manager installs the .NETCore version of Karamba3D under Windows to the folder %appdata%\AppData\Roaming\McNeel\Rhinoceros\packages\8.0 - which is different from where it is placed by the msi-installer.

When starting Grasshopper for the first time after a YAK-installation of Karamba3D, a window with copyright notice and terms and conditions will appear.

Copyright notice and license agreement can be found on Windows under C:\ProgramData\Karamba3D\.

The path to Karamba3D depends on whether installation was done via the msi-installer or YAK. This means that scripts which make use of the Karamba3D API may be broken. In case of GH C# scripting components one needs to adapt the path via "Manage Assemblies..." in the components context menu.

Rhino6, Rhino7 and Rhino8 in parallel

You can install the Rhino 6, 7 and 8 versions of Karamba3D simultaneously by installing one with the msi installer, and the other with the Package Manager.

Silent Installation

To install Karamba3D on remote machines without triggering the installer’s graphical user interface, you can use the msiexec.exe tool from the Windows Command Prompt. First, navigate to the directory containing the Karamba3D installer, then run a command like the following in a single line:

msiexec.exe /i karamba3d_2_0_0_RH6.msi /passive ADDLOCAL=DLLs,LicensePlugin,SIUnits,LicensePublicKey,Tables,Examples

This installs Karamba3D with SI units (SIUnits), cross-section and material tables (Tables), and example files (Examples).

License Setup Without GUI

A static license can be provided without using a graphical interface. Simply rename your license file to licensePRO.lic and place it in the License folder under: ...\Rhino\Plug-ins\Karamba.

Using msiexec on Windows together with Karamba3D:

The basic syntax for msiexec is:

msiexec /option <required parameter> [optional parameter]

Install Options for msiexec:

To install a package, you can use the /i option followed by the path to the package:

msiexec /i "C:\path\to\karamba.msi"

Other install options include:

  • /a: Administrative installation.

  • /ju: Advertise the product to the current user.

  • /jm: Advertise the product to all users.

  • /x: Uninstall the package

Installation Options via ADDLOCAL

You can customize the installation by specifying components using the ADDLOCAL parameter:

  • DLLs: Installs the FEM kernel DLLs.

  • LicensePlugin: Adds the Rhino plugin used for license activation.

  • SIUnit or IMPUnits: Sets the default unit system (modifiable later in Grasshopper via the Karamba3D menu).

  • LicensePublicKey: Installs the public key required to validate the license.

  • Tables: Installs cross-section and material tables.

  • Examples: Installs sample Grasshopper definitions.

Automate installation

The following files and folder will be copied to your machine during installation:

  • “karamba.dll” and “libiomp5md.dll” to C:\Windows.

  • “karambaCommon.dll”, “karamba.gha” and the Karamba-folder to the “Plug-ins”-folder of Rhino. The Karamba3D-folder contains material- and cross section libraries, examples, the karamba.ini- file and the license-folder. This is typically C:\Program Files\Rhinoceros 6\Plug-ins or C:\Program Files\Rhino 6\Plug-ins.

  • If not already present the C++ runtime libraries of Visual Studio 2019 will be copied to your machine.

Karamba3D is installed for all users by default. In order to get Karamba3D running without the installer simply copy the above files and the Karamba3D-folder from one machine to the next. Unless deselected, the installer places a Karamba3D-icon on the desktop. Double-click on it to open the Karamba3D-folder.

one of the installers and double-click on the msi-file.

For there exist two installer files: one for .NETFramework and on for .NETCore. By default Rhino 8 runs on .NETCore. In orer to run old plug-ins, Rhino 8 can be switched to .NETFramework mode with the command 'SetDotNetRuntime'. In these situations the .NETFramework version of Karamba3D can be used.

If Karamba3D does not show up, please refer to our guide.

To run Karamba3D in Rhino8 for Mac, make sure to enable .

Download
Rhino8
troubleshooting
1.2.1 Cloud Licenses
1.2.4 Standalone Licenses
1.2.2 Network Licenses
Rhino
Rosetta