graaf
A general-purpose lightweight C++ graph library
File Explorer
Download Latest Version (.zip)- algorithm-documentation-template.md
- benchmark-algorithm-template.md
- core-class-template.md
- feature_request.md
- new-algorithm-template.md
- documentation.yml
- greetings.yml
- main-ci.yml
- pull-request.yml
- release.yml
- stale.yml
- dependabot.yml
- release.yml
- _category_.json
- bron_kerbosch.md
- _category_.json
- greedy-graph-coloring.md
- welsh-powell.md
- _category_.json
- dfs-based.md
- _category_.json
- kruskal.md
- prim.md
- _category_.json
- a-star.md
- bellman-ford.md
- bfs-based-shortest-path.md
- dijkstra.md
- floyd-warshall.md
- _category_.json
- kosarajus.md
- tarjan.md
- topological-sort.md
- _category_.json
- breadth-first-search.md
- depth-first-search.md
- intro.md
- _category_.json
- dot-serialization.md
- shortest-path.md
- transport-example.md
- intro.md
- _category_.json
- architecture.md
- creating-your-first-graph.md
- using-algorithms.md
- _category_.json
- alternative-methods.md
- installation.md
- intro.md
- index.tsx
- styles.module.css
- custom.css
- index.module.css
- index.tsx
- dot-serialization-graph.png
- example_shortest_path_unweighted.png
- example_shortest_path_weighted.png
- example_traversed_graph_BFS.png
- example_usage.png
- shortest-path-graph.png
- shortest_path.png
- Cycles.png
- Graph.png
- docusaurus-social-card.jpg
- docusaurus.png
- favicon.ico
- graaf.png
- graph_example.png
- hacktoberfest-logo.png
- jetbrains-logo.svg
- logo.svg
- undraw_docusaurus_mountain.svg
- undraw_docusaurus_react.svg
- undraw_docusaurus_tree.svg
- .nojekyll
- .gitignore
- babel.config.js
- docusaurus.config.js
- package.json
- README.md
- sidebars.js
- tsconfig.json
- yarn.lock
- main.cpp
- main.cpp
- main.cpp
- CMakeLists.txt
- README.md
- bron_kerbosch.h
- bron_kerbosch.tpp
- greedy_graph_coloring.h
- greedy_graph_coloring.tpp
- welsh_powell.h
- welsh_powell.tpp
- dfs_cycle_detection.h
- dfs_cycle_detection.tpp
- breadth_first_search.h
- breadth_first_search.tpp
- common.h
- depth_first_search.h
- depth_first_search.tpp
- kruskal.h
- kruskal.tpp
- prim.h
- prim.tpp
- a_star.h
- a_star.tpp
- bellman_ford.h
- bellman_ford.tpp
- bfs_shortest_path.h
- bfs_shortest_path.tpp
- common.h
- common.tpp
- dijkstra_shortest_path.h
- dijkstra_shortest_path.tpp
- dijkstra_shortest_paths.h
- dijkstra_shortest_paths.tpp
- floyd_warshall.h
- floyd_warshall.tpp
- common.h
- kosaraju.h
- kosaraju.tpp
- tarjan.h
- tarjan.tpp
- dfs_topological_sorting.h
- dfs_topological_sorting.tpp
- utils.h
- utils.tpp
- dot.h
- dot.tpp
- vertex_properties.h
- vertex_properties.tpp
- edge.h
- edge.tpp
- graph.h
- graph.tpp
- tree.h
- tree.tpp
- types.h
- README.md
- graaf.pc.in
- add_edge_benchmark.cpp
- add_vertex_benchmark.cpp
- benchmark.cpp
- bron_kerbosch_benchmark.cpp
- CMakeLists.txt
- bron_kerbosch_test.cpp
- greedy_coloring_test.cpp
- welsh_powell_test.cpp
- dfs_cycle_detection_test.cpp
- breadth_first_search_test.cpp
- depth_first_search_test.cpp
- kruskal_test.cpp
- prim_test.cpp
- a_star_test.cpp
- bellman_ford_test.cpp
- bfs_shortest_path_test.cpp
- dijkstra_shortest_path_test.cpp
- dijkstra_shortest_paths_test.cpp
- floyd_warshall_test.cpp
- kosaraju_test.cpp
- tarjan_test.cpp
- dfs_topological_sorting_test.cpp
- utils_test.cpp
- dot_test.cpp
- vertex_properties_test.cpp
- directed_graph_test.cpp
- graph_test.cpp
- graph_traits_test.cpp
- tree_test.cpp
- undirected_graph_test.cpp
- weighted_graph_test.cpp
- fixtures.h
- scenarios.h
- scenarios.tpp
- CMakeLists.txt
- benchmark_visualization.py
- requirements.txt
- .clang-format
- .Dockerignore
- .gitattributes
- .gitignore
- CMakeLists.txt
- CODE_OF_CONDUCT.md
- codecov.yml
- CONTRIBUTING.md
- Dockerfile
- LICENSE.md
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/bobluppes/graaf
Downloads the entire project code from GitHub to your computer.
cd graaf
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t graaf .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 graaf
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. CMake
MediumPrerequisites
mkdir build && cd build
Creates a folder to hold the build output and moves into it.
cmake ..
Analyzes the source code and generates build configuration files (must be run inside the build folder).
make
Compiles the code based on the generated build configuration to produce an executable.
Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).
4. Python
EasyPrerequisites
pip install -r tools/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <์คํํ ํ์ผ๋ช
>.py # README์์ ์ ํํ ์คํ ํ์ผ๋ช
์ ํ์ธํ์ธ์
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)