CimNet

Version: 0.1.4

CimNet is a pure C++ library for simulations on complex networks. It follows the standard of C++11.

CimNet provides features below:

• easy-to-use tools for creation and modification of complex networks;
• storing self-defined data into nodes and edges;
• several implementations of typical networks;
• the ability to inherit and expand your own network structures.

Install

CimNet has no necessary to be installed. Follow these steps to code with CimNet:

1. Clone this repository;
2. Copy the directory cimnet to your project;
3. Add /path/to/your/project to include directory configuration. If you use g++ as your project compiler, compile single file with

g++ xxx.cc -o xxx.out -std=c++11 -O2 -I /path/to/your/project

Simple usage

Construct a regular network with 10 nodes and 3 clockwise links for each node. Then we print network info and neighbors of node 1.

#include "cimnet/network.h"

int main(void) {
    RegularNetwork<> net(10, 3);
    std::cout << net << std::endl;
    std::cout << "Neighbors of node 1: ";
    for (auto n : net.neighbors(1))
        std::cout << n << " ";
    std::cout << std::endl;
    return 0;
}

Public documentation could be found at docs/zh-cn.md. (We only have Chinese version currently. You may need some translator to read.)

Documentation was written by Haroopad. (You may have better experience if you installed it.)

Contributor

Developer: Xintao Hu (@hxt-tg, email: [email protected])

Review & part of docs: Jialong Sun (@jl-sun) email: [email protected])

Bug reports

Report bugs in GitHub issues.

License

CimNet is released under the GNU General Public License Version 3 (GPLv3).

Copyright (C) 2022 CimNet Developers
Xintao Hu <[email protected]>