-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update generated documentation for version 0.0.1
- Loading branch information
1 parent
5dd1518
commit 067af39
Showing
67 changed files
with
25,406 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,245 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en" data-root="https://fslab.org/Sigma.NET/"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta content="IE=edge" http-equiv="X-UA-Compatible"> | ||
| <meta content="width=device-width, initial-scale=1.0" name="viewport"> | ||
| <meta content="Timo Mühlhaus, fslab contributors" name="author"> | ||
| <!-- Opengraph properties (https://ogp.me/) --> | ||
| <meta property="og:site_name" content="Sigma.NET"> | ||
| <meta property="og:title" content="Introduction | ||
| " /> | ||
| <meta property="og:url" content="https://fslab.org/Sigma.NET/script.html"> | ||
| <meta property="og:type" content="website" /> | ||
| <!-- Twitter cards (https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary-card-with-large-image) --> | ||
| <meta name="twitter:card" content="summary_large_image"> | ||
| <meta name="twitter:site" content="https://fslab.org/Sigma.NET/"> | ||
| <meta name="twitter:title" content="Introduction | ||
| "> | ||
|
|
||
| <title>Introduction | ||
| | Sigma.NET</title> | ||
| <link href="https://fonts.googleapis.com" rel="preconnect"> | ||
| <link crossorigin href="https://fonts.gstatic.com" rel="preconnect"> | ||
| <link href="https://fonts.googleapis.com/css2?family=Fira+Code&display=swap" rel="stylesheet"> | ||
| <script src="https://code.iconify.design/iconify-icon/1.0.7/iconify-icon.min.js"></script> | ||
| <link href="https://fslab.org/Sigma.NET/img/favicon.ico" rel="icon" sizes="32x32" type="image/png"/> | ||
| <script type="application/javascript" src="https://fslab.org/Sigma.NET/content/fsdocs-theme-set-dark.js"></script> | ||
| <link href="https://fslab.org/Sigma.NET/content/fsdocs-default.css" rel="stylesheet" type="text/css"/> | ||
| <link href="https://fslab.org/Sigma.NET/content/fsdocs-theme.css" rel="stylesheet" type="text/css"/> | ||
|
|
||
|
|
||
| </head> | ||
| <body class="content"> | ||
| <header> | ||
| <div class="start"> | ||
| <div id="menu-toggle"> | ||
| <iconify-icon class="icon closed" height="22" icon="eva:menu-fill" width="22"></iconify-icon> | ||
| <iconify-icon class="icon open" height="22" icon="mi:close" width="22"></iconify-icon> | ||
| <input type="checkbox" name="mobile-menu" /> | ||
| <ul class="menu"> | ||
| <li class="nav-header">Links</li> | ||
| <li class="nav-item"><a class="nav-link" href="https://github.com/fslaborg/Sigma.NET/blob/master/LICENSE">License</a> | ||
| </li> | ||
| <li class="nav-item"><a class="nav-link" | ||
| href="https://github.com/fslaborg/Sigma.NET/blob/master/RELEASE_NOTES.md">Release | ||
| Notes</a></li> | ||
| <li class="nav-item"><a class="nav-link" href="https://github.com/fslaborg/Sigma.NET/">Source | ||
| Repository</a></li> | ||
| <li class="nav-header"> | ||
| Documentation | ||
| </li> | ||
| <li class="nav-item "> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/2_Basic_Usage.html"> | ||
| Basic Usage | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-item "> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/3_Advanced_Usage.html"> | ||
| Advanced Usage | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-item "> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/4_Render_Settings.html"> | ||
| Render Settings | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-item active"> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/1_Introduction.html"> | ||
| Introduction | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-header"> | ||
| API Reference | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/reference/index.html"> | ||
| All Namespaces | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <a href="https://fslab.org/Sigma.NET/"> | ||
| <img alt="Header menu logo" src="https://fslab.org/Sigma.NET/img/logo.png"> | ||
| <strong>Sigma.NET</strong> | ||
| </a> | ||
| </div> | ||
| <div class="end"> | ||
| <a href="https://github.com/fslaborg/Sigma.NET/" target="_blank"> | ||
| <iconify-icon icon="uil:github" width="26" height="26"></iconify-icon> | ||
| </a> | ||
| <iconify-icon id="search-btn" icon="carbon:search" class="search" width="24" height="24"></iconify-icon> | ||
| <fsdocs-theme-toggle></fsdocs-theme-toggle> | ||
| </div> | ||
| </header> | ||
| <aside id="fsdocs-main-menu"> | ||
| <ul class="menu"> | ||
| <li class="nav-header">Links</li> | ||
| <li class="nav-item"><a class="nav-link" href="https://github.com/fslaborg/Sigma.NET/blob/master/LICENSE">License</a> | ||
| </li> | ||
| <li class="nav-item"><a class="nav-link" | ||
| href="https://github.com/fslaborg/Sigma.NET/blob/master/RELEASE_NOTES.md">Release | ||
| Notes</a></li> | ||
| <li class="nav-item"><a class="nav-link" href="https://github.com/fslaborg/Sigma.NET/">Source | ||
| Repository</a></li> | ||
| <li class="nav-header"> | ||
| Documentation | ||
| </li> | ||
| <li class="nav-item "> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/2_Basic_Usage.html"> | ||
| Basic Usage | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-item "> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/3_Advanced_Usage.html"> | ||
| Advanced Usage | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-item "> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/4_Render_Settings.html"> | ||
| Render Settings | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-item active"> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/1_Introduction.html"> | ||
| Introduction | ||
|
|
||
| </a> | ||
| </li> | ||
| <li class="nav-header"> | ||
| API Reference | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://fslab.org/Sigma.NET/reference/index.html"> | ||
| All Namespaces | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| </aside> | ||
| <main> | ||
| <div id="content"> | ||
| <h1><a name="Introduction" class="anchor" href="#Introduction">Introduction</a></h1> | ||
| <h2><a name="Library-Name" class="anchor" href="#Library-Name">Library Name</a></h2> | ||
| <p>Sigma.NET<br /> | ||
| Sigma.NET.Interactive</p> | ||
| <h2><a name="Description" class="anchor" href="#Description">Description</a></h2> | ||
| <p>Sigma.NET is a powerful and easy-to-use library for visualizing graphs and networks that provides intuitive methods to create, customize, and display various types of graphs, making it suitable for both beginners and advanced users. Additionally, Sigma.NET.Interactive offers interactive visualization options, allowing users to explore and manipulate graphs in real-time for deeper insights and analysis.</p> | ||
| <h3><a name="Graphs" class="anchor" href="#Graphs">Graphs</a></h3> | ||
| <p>A graph is a mathematical structure used to model pairwise relationships between objects. It consists of a set of nodes (also called vertices) and a set of edges (also called links or connections) that connect pairs of nodes. Graphs are widely used in various fields such as computer science, biology, social sciences, and network science to represent and analyze networks.</p> | ||
| <h3><a name="Nodes-Vertices" class="anchor" href="#Nodes-Vertices">Nodes (Vertices)</a></h3> | ||
| <p>Nodes are the individual entities or points in a graph. Each node can represent a different object, such as a person in a social network, a gene in a biological network, or a computer in a communication network. Nodes are typically depicted as dots or circles in a graphical representation.</p> | ||
| <h3><a name="Edges-Links" class="anchor" href="#Edges-Links">Edges (Links)</a></h3> | ||
| <p>Edges are the connections between nodes in a graph. Each edge represents a relationship or interaction between two nodes. Edges can be directed or undirected:</p> | ||
| <ul> | ||
| <li><p><strong>Undirected Edges</strong>: Represent bidirectional relationships where the connection does not have a specific direction (e.g., friendship in a social network).</p></li> | ||
| <li><p><strong>Directed Edges</strong>: Represent unidirectional relationships where the connection has a specific direction (e.g., a follower relationship in Twitter).</p></li> | ||
| <li><p><strong>Weighted Edges</strong>: Represent relationships where the connection carries a value or weight, indicating the strength or capacity of the link (e.g., the cost of traveling between two cities on a map).</p></li> | ||
| <li><p><strong>Unweighted Edges</strong>: Represent relationships where the connection does not have a specific value or weight, treating all links as equal in terms of their significance (e.g., a simple link between nodes in a network graph).</p></li> | ||
| </ul> | ||
| <p>These basic concepts form the foundation for understanding and visualizing graphs.</p> | ||
| <h2><a name="Features" class="anchor" href="#Features">Features:</a></h2> | ||
| <ul> | ||
| <li>Simple and intuitive API</li> | ||
| <li>Customizable node and edge attributes</li> | ||
| <li>Interactive visualization options</li> | ||
| </ul> | ||
| <h2><a name="Installation" class="anchor" href="#Installation">Installation</a></h2> | ||
| <p>Using nuget</p> | ||
| <pre class="fssnip highlighted"><code lang="fsharp"><span class="c">//Sigma.NET and Sigma.NET.Interactive</span> | ||
| <span class="pn">#</span> <span class="s">"nuget: C:/Users/lukas/Documents/GitHub/Project/Sigma.NET/pkg"</span> | ||
| <span class="pp">#r</span> <span class="s">"nuget: Sigma.NET, 0.0.0-dev"</span> | ||
| <span class="pp">#r</span> <span class="s">"nuget: Sigma.NET.Interactive, 0.0.0-dev"</span> | ||
|
|
||
| <span class="k">open</span> <span class="id">Sigma</span><span class="pn">.</span><span class="id">NET</span> | ||
| <span class="k">open</span> <span class="id">Sigma</span><span class="pn">.</span><span class="id">NET</span><span class="pn">.</span><span class="id">Interactive</span> | ||
| </code></pre> | ||
|
|
||
|
|
||
| </div> | ||
| </main> | ||
| <aside id="fsdocs-page-menu"> | ||
| <p id="on-this-page">On this page</p> | ||
| <ul> | ||
| <li class="level-1"> | ||
| <a href="#Introduction"> | ||
| Introduction | ||
| </a> | ||
| </li> | ||
| <li class="level-2"> | ||
| <a href="#Library-Name"> | ||
| Library Name | ||
| </a> | ||
| </li> | ||
| <li class="level-2"> | ||
| <a href="#Description"> | ||
| Description | ||
| </a> | ||
| </li> | ||
| <li class="level-3"> | ||
| <a href="#Graphs"> | ||
| Graphs | ||
| </a> | ||
| </li> | ||
| <li class="level-3"> | ||
| <a href="#Nodes-Vertices"> | ||
| Nodes (Vertices) | ||
| </a> | ||
| </li> | ||
| <li class="level-3"> | ||
| <a href="#Edges-Links"> | ||
| Edges (Links) | ||
| </a> | ||
| </li> | ||
| <li class="level-2"> | ||
| <a href="#Features"> | ||
| Features: | ||
| </a> | ||
| </li> | ||
| <li class="level-2"> | ||
| <a href="#Installation"> | ||
| Installation | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| </aside> | ||
| <dialog> | ||
| <input type="search" placeholder="Search docs" /> | ||
| <div class="results"> | ||
| <ul></ul> | ||
| <p class="empty">Type something to start searching.</p> | ||
| </div> | ||
| </dialog> | ||
| <script type="module" src="https://fslab.org/Sigma.NET/content/fsdocs-tips.js"></script> | ||
| <script type="module" src="https://fslab.org/Sigma.NET/content/fsdocs-theme-toggle.js"></script> | ||
| <script type="module" src="https://fslab.org/Sigma.NET/content/fsdocs-theme.js"></script> | ||
| <script type="module" src="https://fslab.org/Sigma.NET/content/fsdocs-search.js"></script> | ||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.