{"id":20332470,"url":"https://github.com/permutationlock/libavengraph","last_synced_at":"2025-03-04T12:42:31.808Z","repository":{"id":258536412,"uuid":"864659814","full_name":"permutationlock/libavengraph","owner":"permutationlock","description":"A small library for implementing and visualizing graph algorithms","archived":false,"fork":false,"pushed_at":"2025-03-02T23:47:06.000Z","size":1474,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-03T00:48:05.826Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit-0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/permutationlock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-28T20:11:11.000Z","updated_at":"2025-03-02T23:47:09.000Z","dependencies_parsed_at":"2024-11-07T22:26:34.945Z","dependency_job_id":"8ab00e86-d730-4225-99ce-715678867f00","html_url":"https://github.com/permutationlock/libavengraph","commit_stats":null,"previous_names":["permutationlock/libavengraph"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permutationlock%2Flibavengraph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permutationlock%2Flibavengraph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permutationlock%2Flibavengraph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/permutationlock%2Flibavengraph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/permutationlock","download_url":"https://codeload.github.com/permutationlock/libavengraph/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241851759,"owners_count":20030965,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T20:26:44.858Z","updated_at":"2025-03-04T12:42:31.791Z","avatar_url":"https://github.com/permutationlock.png","language":"C","readme":"# The Aven Graph Library\n\nAn \"adjacency slice\" graph library along with implementations\nof a few [path coloring algorithms for plane graphs][2].\n\n## Code organization\n\nThe header-only graph library is contained in the `include` directory.\nThe majority of the library depends only on a couple files from\nthe simple `libaven` header-only library, which is vendored in the\n`deps` directory.\n\nThe `*/geometry.h` files define functions to construct vector geometry\nfor graph visualization and depend on the headers from\n`libavengl`. The `libavengl` library draws 2D vector\ngraphics using the OpenGL ES 2.0 API.\nThe provided visualization uses GLFW for window creation.\nThe GLFW and `libavengl` libraries and the headers\nfor X11, xkbcommon, and Wayland are vendored in `deps`.\n\n## Building the project\n\nThe visualization should build with no system dependencies other\nthan a C compiler on most modern Windows or Linux systems.\n\nTo build the build system:\n```Shell\nmake\n```\nor\n```Shell\ncc -o build build.c\n```\nwhere `cc` is your favorite C compiler that supports C99 or later [^1].\n\nTo build the algorithm visualization run:\n```\n./build\n```\nThe resulting executables will be in the `build_out` directory.\n\nFor a release build using `clang` or `gcc` run:\n```\n  ./build -ccflags \"-O3 -ffast-math\" -glfw-ccflags \"-O3 -DNDEBUG\"\n```\n\n### Watch mode and hot reloading\n\nTo build and run the visualization in \"watch mode\" you may run:\n```\n  ./build watch\n```\nThe build system will watch for changes to files in `visualization/`. If a\nfile in `visualization/game/` is modified, then the changes will be compiled\ninto a dynamic library and hot loaded into the running application. If\na file in the root of `visualization/` is changed, then the application\nwill close, compile, and run.\n\n### Tikz drawings\n\nA couple rudimentary programs were written to find and draw\nalgorithm examples as a series of Tikz drawings. To build these\nexectuables, run:\n```\n./build tikz\n```\n\n### Benchmarks\n\nTo build and run the algorithm benchmarks you will need ~3GB of\navailable system RAM. To benchmark the threaded algorithms\nyour C compiler must support C11 atomics. An example full benchmark\nrun command for `gcc` or `clang` on Linux would be:\n```\n./build bench -ccflags \"-std=c11 -O3 -march=native -DBENCHMARK_THREADED\"\n```\nThe benchmarks may take up to a few hours to complete.\n \n### Cleaning up\n\nTo clean all build artifacts:\n```\n./build clean\n```\n\n## Online visualization\n\nThe visualization compiled with Emscripten is [available online][1].\n\n## License\n\nThe copyright Aven Bross 2024 and the license provided in `LICENSE.MIT`\napply to each text file that does\nnot contain its own separate license and copyright.\n\n[^1]: Most common C compilers will be configured by default: `gcc`, `clang`,\nand `tcc` on Linux, and `gcc.exe`, `clang.exe`, and `cl.exe` on Windows\nshould be supported out-of-the-box.\nOtherwise you will need to define the various flags yourself.\nRun `./build -h` for a full rundown of what needs to be configured,\nand see `crpoc_make.sh`, `emcc_make.sh`, `zig_make.sh`, and `zig_make.bat`\nfor examples.\n\n[1]: https://musing.permutationlock.com/static/triangulate/visualization.html\n[2]: https://github.com/permutationlock/implpathcol_paper\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermutationlock%2Flibavengraph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpermutationlock%2Flibavengraph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpermutationlock%2Flibavengraph/lists"}