{"id":22576999,"url":"https://github.com/luk036/netoptim-cpp","last_synced_at":"2025-03-28T15:45:07.103Z","repository":{"id":145972097,"uuid":"386161983","full_name":"luk036/netoptim-cpp","owner":"luk036","description":"Network Optimization C++ Code","archived":false,"fork":false,"pushed_at":"2025-03-26T11:07:51.000Z","size":277,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T12:23:58.041Z","etag":null,"topics":["cmake","cpp20","header-only","network-optimization"],"latest_commit_sha":null,"homepage":"https://luk036.github.io/netoptim-cpp/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luk036.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-07-15T04:26:08.000Z","updated_at":"2025-03-26T11:08:00.000Z","dependencies_parsed_at":"2024-01-15T06:42:07.492Z","dependency_job_id":"ed5c62dd-4a73-43b2-a235-61a40acb2a29","html_url":"https://github.com/luk036/netoptim-cpp","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":"TheLartians/ModernCppStarter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luk036%2Fnetoptim-cpp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luk036%2Fnetoptim-cpp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luk036%2Fnetoptim-cpp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luk036%2Fnetoptim-cpp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luk036","download_url":"https://codeload.github.com/luk036/netoptim-cpp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246057978,"owners_count":20717030,"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":["cmake","cpp20","header-only","network-optimization"],"created_at":"2024-12-08T04:10:50.647Z","updated_at":"2025-03-28T15:45:07.095Z","avatar_url":"https://github.com/luk036.png","language":"C++","readme":"[![Actions Status](https://github.com/luk036/netoptim-cpp/workflows/MacOS/badge.svg)](https://github.com/luk036/netoptim-cpp/actions)\n[![Actions Status](https://github.com/luk036/netoptim-cpp/workflows/Windows/badge.svg)](https://github.com/luk036/netoptim-cpp/actions)\n[![Actions Status](https://github.com/luk036/netoptim-cpp/workflows/Ubuntu/badge.svg)](https://github.com/luk036/netoptim-cpp/actions)\n[![Actions Status](https://github.com/luk036/netoptim-cpp/workflows/Style/badge.svg)](https://github.com/luk036/netoptim-cpp/actions)\n[![Actions Status](https://github.com/luk036/netoptim-cpp/workflows/Install/badge.svg)](https://github.com/luk036/netoptim-cpp/actions)\n[![codecov](https://codecov.io/gh/luk036/netoptim-cpp/branch/master/graph/badge.svg)](https://codecov.io/gh/luk036/netoptim-cpp)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://repository-images.githubusercontent.com/254842585/4dfa7580-7ffb-11ea-99d0-46b8fe2f4170\" height=\"175\" width=\"auto\" /\u003e\n\u003c/p\u003e\n\n# 🖧 netoptim\n\nThis is a networkx inspired modern cpp project.\n\n## ✨ Features\n\n- [Modern CMake practices](https://pabloariasal.github.io/2018/02/19/its-time-to-do-cmake-right/)\n- Header-only library\n- Integrated test suite\n- Continuous integration via [GitHub Actions](https://help.github.com/en/actions/)\n- Code coverage via [codecov](https://codecov.io)\n- Code formatting enforced by [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and [cmake-format](https://github.com/cheshirekow/cmake_format) via [Format.cmake](https://github.com/TheLartians/Format.cmake)\n- Reproducible dependency management via [CPM.cmake](https://github.com/TheLartians/CPM.cmake)\n- Installable target with automatic versioning information and header generation via [PackageProject.cmake](https://github.com/TheLartians/PackageProject.cmake)\n- Automatic [documentation](https://thelartians.github.io/ModernCppStarter) and deployment with [Doxygen](https://www.doxygen.nl) and [GitHub Pages](https://pages.github.com)\n- Support for [sanitizer tools, and more](#additional-tools)\n\n## Usage\n\n### Adjust the template to your needs\n\n- Use this repo [as a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).\n- Replace all occurrences of \"NetOptim\" in the relevant CMakeLists.txt with the name of your project\n  - Capitalization matters here: `NetOptim` means the name of the project, while `netoptim` is used in file names.\n  - Remember to rename the `include/netoptim` directory to use your project's lowercase name and update all relevant `#include`s accordingly.\n- Replace the source files with your own\n- For header-only libraries: see the comments in [CMakeLists.txt](CMakeLists.txt)\n- Add [your project's codecov token](https://docs.codecov.io/docs/quick-start) to your project's github secrets under `CODECOV_TOKEN`\n- Happy coding!\n\nEventually, you can remove any unused files, such as the standalone directory or irrelevant github workflows for your project.\nFeel free to replace the License with one suited for your project.\n\nTo cleanly separate the library and subproject code, the outer `CMakeList.txt` only defines the library itself while the tests and other subprojects are self-contained in their own directories.\nDuring development it is usually convenient to [build all subprojects at once](#build-everything-at-once).\n\n### Build and run the standalone target\n\nUse the following command to build and run the executable target.\n\n```bash\ncmake -S. -B build\ncmake --build build\n./build/standalone/NetOptim --help\n```\n\n### Build and run test suite\n\nUse the following commands from the project's root directory to run the test suite.\n\n```bash\ncmake -S. -B build\ncmake --build build\ncd build/test\nCTEST_OUTPUT_ON_FAILURE=1 ctest\n\n# or maybe simply call the executable:\n./build/test/NetOptimTests\n```\n\nTo collect code coverage information, run CMake with the `-DENABLE_TEST_COVERAGE=1` option.\n\n### Run clang-format\n\nUse the following commands from the project's root directory to check and fix C++ and CMake source style.\nThis requires _clang-format_, _cmake-format_ and _pyyaml_ to be installed on the current system.\n\n```bash\ncmake -S. -B build/test\n\n# view changes\ncmake --build build --target format\n\n# apply changes\ncmake --build build --target fix-format\n```\n\nSee [Format.cmake](https://github.com/TheLartians/Format.cmake) for details.\n\n### Build the documentation\n\nThe documentation is automatically built and [published](https://luk036.github.io/netoptim-cpp) whenever a [GitHub Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) is created.\nTo manually build documentation, call the following command.\n\n```bash\ncmake -S . -B build\ncmake --build build --target GenerateDocs\n# view the docs\nopen build/documentation/doxygen/html/index.html\n```\n\nTo build the documentation locally, you will need Doxygen, jinja2 and Pygments on installed your system.\n\n### Additional tools\n\nThe test and standalone subprojects include the [tools.cmake](cmake/tools.cmake) file which is used to import additional tools on-demand through CMake configuration arguments.\nThe following are currently supported.\n\n#### Sanitizers\n\nSanitizers can be enabled by configuring CMake with `-DUSE_SANITIZER=\u003cAddress | Memory | MemoryWithOrigins | Undefined | Thread | Leak | 'Address;Undefined'\u003e`.\n\n#### Static Analyzers\n\nStatic Analyzers can be enabled by setting `-DUSE_STATIC_ANALYZER=\u003cclang-tidy | iwyu | cppcheck\u003e`, or a combination of those in quotation marks, separated by semicolons.\nBy default, analyzers will automatically find configuration files such as `.clang-format`.\nAdditional arguments can be passed to the analyzers by setting the `CLANG_TIDY_ARGS`, `IWYU_ARGS` or `CPPCHECK_ARGS` variables.\n\n#### Ccache\n\nCcache can be enabled by configuring with `-DUSE_CCACHE=\u003cON | OFF\u003e`.\n\n## Related projects and alternatives\n\n- [**ModernCppStarter \u0026 PVS-Studio Static Code Analyzer**](https://github.com/viva64/pvs-studio-cmake-examples/tree/master/modern-cpp-starter): Official instructions on how to use the ModernCppStarter with the PVS-Studio Static Code Analyzer.\n- [**lefticus/cpp_starter_project**](https://github.com/lefticus/cpp_starter_project/): A popular C++ starter project, created in 2017.\n- [**filipdutescu/modern-cpp-template**](https://github.com/filipdutescu/modern-cpp-template): A recent starter using a more traditional approach for CMake structure and dependency management.\n- [**vector-of-bool/pitchfork**](https://github.com/vector-of-bool/pitchfork/): Pitchfork is a Set of C++ Project Conventions.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluk036%2Fnetoptim-cpp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluk036%2Fnetoptim-cpp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluk036%2Fnetoptim-cpp/lists"}