The Aardvark Platform | Gallery | Packages&Repositories
This repository hosts guided walkthrough examples and lecture notes for the open-source The Aardvark Platform for visual computing, real-time graphics and visualization. You can find additional academic articles, paper concepts and videos related to Aardvark in This repository's wiki. For technical documentation regarding Aardvark, please see the aardvark.docs wiki.
The Aardvark ecosystem
Aardvark Platform consists of these central resources:
- Aardvark.Base: Aardvark.Base provides fundamental algorithms and datastructures for math and system interop, including Vectors, Matrices, and image loaders. Technical documentation for Aardvark.Base is hosted in the Aardvark.Base wiki. The packages built with Aardvark.Base are listed in Packages&Repositories.
- Aardvark.Rendering: Aardvark.Rendering is high-performance incremental renderer with a functional input language and a very high degree of flexibility. You can find example projects in the Gallery, and tons of demo code in the Aardvark.Rendering Examples folder. The examples include HelloWorld, n-body using compute shaders, RTX Ray Tracing and large scale rendering with reversed depth. Technical documentation related to Aardvark.Rendering is located in the Aardvark.Rendering wiki.
- Aardvark.Media: Aardvark.Media is a purely functional web-based user interface library and application development system using the Elm concept. Aardvark.Media includes Aardvark.Rendering to provide serverside rendering capability. Many examples projects in the Gallery use Aardvark.Media. Tons of code examples and user interface primitives are presented in the Aardvark.Media Examples folder. Documentation for Aardvark.Media is hosted in the Aardvark.Media wiki, including a complete guided walkthrough through Aardvark.Media application development.
Purpose of this repository
The code in this repository showcases the interplay of the different Aardvark Platform repositories (which can be found in the Packages&Repositories at the top of this readme). This demo repository is considered supplementary documentation for the other repositories, which are more technically oriented. In this demo repository, you can find a guided Aardvark walkthrough (also in video form in the wiki) and more academic observations about various Aardvark components.
Aardvark is used in industry and research projects, which are also linked in the Gallery. A selection of examples: Hilite lighting design, Hilite Architectural Visualization, Pro3D. Topics discussing technical aspects of Aardvark can be found in the aardvark.docs wiki. Our lecture notes and videos can be found in this repository's wiki. We invite you to ask further questions in our discord server.
How to build this demo repository
You need the .NET SDK installed. Your editor (Visual Studio, Jetbrains Rider, VS Code) should have F# language support installed. We use dotnet+paket as build system.
Clone the repository and run build.cmd or ./build.sh.
How to create a new Aardvark Project
Choose one of these options:
- Check out the template repository and follow the readme.
- Install the Aardvark Dotnet Template and run
dotnet new. - Clone and modify an existing example, such as Aardvark.Rendering examples or Aardvark.Media examples.
Using aardvark libraries in your project
We deploy our packages on Nuget and Github Packages. For dependency management, we use paket. A list of Aardvark packages is located at Packages&Repositories.