Skip to content

Latest commit

 

History

History
47 lines (24 loc) · 3.44 KB

README.md

File metadata and controls

47 lines (24 loc) · 3.44 KB

PicoGK

Welcome to PicoGK

PicoGK ("peacock") is a compact, robust, and fast geometry kernel for Computational Engineering.

PicoGK was developed by Lin Kayser, and is maintained by LEAP 71. PicoGK is open-sourced under the Apache License 2.0.

For more information, please visit https://PicoGK.org

We believe that Computational Engineering will profoundly change the way we design physical objects in the years to come. But it needs a neutral, transparent and free and open-source platform in order to be adopted widely.

By developing and maintaining PicoGK, we hope to make a contribution to accelerate the progress of invention.

Getting started

To get started with PicoGK, please jump over to the documentation and install the latest PicoGK release.

To understand what can be done with PicoGK, what other modules we have, we recommend checking out the LEAP 71 Github Overview Page — this page also has pointers to articles about the fundamentals of Computational Engineering.

9CF66413-8BA1-4E18-9BA7-F5254235B44A

On the shoulders of giants

We are indebted to other Open-Source projects, without which writing PicoGK would have been an impossible task. Most notably we use the Academy Software Foundation's OpenVDB library, which provides the majority of the functionality neccessary to build a robust geometry kernel. In many ways, PicoGK is a thin-yet-powerful layer of functionality on top of OpenVDB.

The PicoGK viewer relies on the GLFW library, for simple cross-platform OpenGL user interface functionality.

PicoGK structure

PicoGK consists of two modules.

  • PicoGK, which is the C#-based project that you have currently open, and

  • PicoGKRuntime, a C++-based runtime library, which is in a separate GitHub project.

PicoGK provides an framework based on Microsoft's open-source C# language. It depends on PicoGKRuntime for the heavy lifting.

PicoGKRuntime exposes a minimal "extern C" interface, which can be implemented by other geometry kernels, including commercial ones.

We encourage other software vendors to support the PicoGKRuntime API and release commercial alternatives to our open-source project. PicoGK was developed as a reliable common interface that you, the engineer, can always rely on as a free and universally available platform to fall back on when creating your own intellectual property.

PicoGK, the C# code, which you have open right now, provides rich functionality based on the PicoGKRuntime interface. It makes it as simple as possible to build computational geometry.

You will, however, ususally not use PicoGK directly to build Computational Engineering Models. We encourage you to look at our other open-source project, the LEAP 71 ShapeKernel, which was written by Josefine Lissner, and forms the basis of all objects we create at LEAP 71 and uses PicoGK as the foundation.

Please head over to our documentation, for how to get started with PicoGK.