Files
ConformalLabpp/README.md
Tarik Moussa d134add5a6 update readme
2026-03-07 11:25:56 +02:00

47 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# conformallab++
conformallab++ is a modern C++ reimplementation of the ConformalLab software by Stefan Sechelmann for experiments in discrete conformal geometry and related mesh transformations.
It builds on wellestablished opensource libraries such as **CGAL**, **Eigen**, and **Boost** for robust geometric data structures and efficient numerical computations, and uses singleheader libraries **CLI11** and **json.hpp** for a lightweight commandline interface and configuration handling. In addition, **libigl**s OpenGL viewer stack based on **GLFW** provides portable windowing and input handling, while the separate **libiglglad** component supplies a generated OpenGL function loader for the required core profile, making interactive visualization easy to integrate.
## Status
This project is in an early prototype stage.
API, file formats and commandline interface are all subject to change.
## Features (placeholder)
- Discrete conformal geometry utilities (placeholder)
- Mesh and graph data structures built on CGAL (placeholder)
- Linear algebra and optimization routines using Eigen (placeholder)
- Highlevel operations and helpers based on Boost (placeholder)
- Commandline tools with CLI11 and JSON configuration (placeholder)
## Getting started
### Prerequisites
- A C++20 compiler (e.g. `g++` or `clang++`)
- CMake version 3.20
### Clone the repository
```bash
git clone https://codeberg.org/user2595/ConformalLabpp
cd conformallabpp/code
```
### Configure and build
```bash
cmake -S . -B build && cmake --build build
```
### Run the binare
```bash
./bin/conformallab_core --input ./data/off/simple_cupe.off
```
### License
conformallabpp is released under the MIT License (see LICENSE).