Skip to content

Commit

Permalink
added ss in manual -> formats and generate
Browse files Browse the repository at this point in the history
  • Loading branch information
oxy86 committed Dec 12, 2024
1 parent fd7daff commit 503efb9
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 18 deletions.
11 changes: 8 additions & 3 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,18 @@ import BaseLayout from "../../layouts/BaseLayout.astro";
import { Card, CardGrid } from '@astrojs/starlight/components';
import Mermaid from "../../components/Mermaid.astro";
import { LinkButton } from '@astrojs/starlight/components';
import { Image } from 'astro:assets';

import myImage from '../../assets/images/socnetv-32-lattice-961n-1860e-layout-bc.png';

<BaseLayout title="Home" description="Welcome to SocNetV">


## Free and Open-Source Tool for Social Network Analysis 🌟

![SocNetV Screenshot](/data/uploads/screenshots/25/socnetv-25-131-actors-citation-Degree-Centrality-Radial-Node-size-color-Layout-outDegree-distribution.png)
<Image loading src={myImage} alt="SocNetV automatically created a lattice network of 961 actors and 1860 edges - we have applied the betweenness-centrality radial layout." />

{/* ![SocNetV Screenshot](/data/uploads/screenshots/25/socnetv-25-131-actors-citation-Degree-Centrality-Radial-Node-size-color-Layout-outDegree-distribution.png) */}

SocNetV is a cross-platform, user-friendly free software application for social network analysis and visualization. With SocNetV you can:

Expand All @@ -77,15 +82,15 @@ SocNetV is a cross-platform, user-friendly free software application for social
- [Layout models](/manual/visualization) based on prominence indices (e.g., circular, level, nodal sizes by centrality score) or on force-directed placement (e.g., [Kamada-Kawai](/manual/visualization#kamada-kawai-layout), [Fruchterman-Reingold](/manual/visualization#fruchterman-reingold-layout)).
- [Multirelational network loading and editing](/manual/gui#relations).
- Random network creation using various models ([Barabási–Albert Scale-Free](/manual/generate/#scale-free-s-f-networks), [Erdős–Rényi](/manual/generate/#erd%C5%91sr%C3%A9nyi-er-networks), [Watts-Strogatz Small-World](/manual/generate/#small-world-sw-networks), d-regular, ring lattice, etc.).
- [Famous social network analysis datasets](/manual/generate/#datasets-recreating-famous-datasets), such as Padgett's Florentine families.
- [Famous social network analysis datasets](/manual/generate/#recreating-famous-datasets), such as Padgett's Florentine families.
- Built-in [web crawler](/manual/generate/#web-crawler-networks-of-webpages) to automatically create "social networks" from links found in a given URL.
- Comprehensive [documentation](/documentation) available both online and inside the application.

---

## Latest version 📥

<p><a href="https://github.com/socnetv/app/releases" target="_blank" rel="nofollow nopener"><img src="https://img.shields.io/github/release/socnetv/app.svg" /></a></p>
<p><a href="https://github.com/socnetv/app/releases" target="_blank" rel="nofollow nopener"><img alt="SocNetV latest version" src="https://img.shields.io/github/release/socnetv/app.svg" /></a></p>

Installers, packages and executables for Windows, macOS and Linux are available on the [Downloads](../downloads) page.

Expand Down
51 changes: 36 additions & 15 deletions src/content/docs/manual/formats.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ GraphML is a highly versatile and widely adopted XML-based format designed for g

#### Example 1: A simple GraphML File

Below is an example of a simple directed graph with two nodes and one edge:
Below is an example of a simple social network in GraphML, an undirected graph with two 11 nodes and 12 edges:

```xml
<?xml version="1.0" encoding="UTF-8"?>
Expand Down Expand Up @@ -113,6 +113,10 @@ graph TD
n8 --> n10
`} />

And here's the visualization of the above example using **SocNetV** where we have applied an FDP layout (*Kamada-Kawai*) for the node location and a prominence-based model (*Betweenness Centrality*) for the node sizes/colors:

![SocNetV visualizing a simple undirected graph with two 11 nodes and 12 edges from a GraphML file](/data/uploads/screenshots/32/socnetv-32-example-graphml.png)

### How to Use GraphML Files in SocNetV

#### Loading GraphML Files
Expand Down Expand Up @@ -206,7 +210,10 @@ graph [
- **Edges**: The edges connect nodes using the `source` and `target` attributes. For example, an edge from node `1` (Alice) to node `2` (Bob) has a weight of `1.0`. Similarly, other edges are defined with weights that indicate the strength of the connection.
- **Graph Properties**: The `directed 1` property at the beginning of the graph indicates that the graph is directed. If this value were set to `0`, the graph would be undirected.

#### Mermaid Visualization
#### Visualization

This Mermaid diagram visualizes the directed graph described in the GML example. It captures the relationships between "Alice", "Bob", and "Charlie", along with the weights assigned to the edges.


<Mermaid code={`
graph TD
Expand All @@ -215,7 +222,11 @@ graph TD
Charlie -->|2.0| Alice
`} />

This Mermaid diagram visualizes the directed graph described in the GML example. It captures the relationships between "Alice", "Bob", and "Charlie", along with the weights assigned to the edges.
And here's the visualization in SocNetV:


![SocNetV visualizing a network from an example GML file](/data/uploads/screenshots/32/socnetv-32-example-gml.png)


### How to Use GML in SocNetV

Expand Down Expand Up @@ -279,15 +290,21 @@ digraph mydot {
- **Edges**: Directed edges are defined using `->`, such as `a -> b`. Attributes like `weight` and `color` can also be applied to edges.
- **Clusters and Groups**: Nodes are grouped by attribute definitions, making visualization more intuitive.

##### Mermaid Visualization:
##### Visualization:

This Mermaid diagram replicates the structure of the example GraphViz file, illustrating the directed relationships between nodes.

<Mermaid code={`
graph TD
a --> b --> c --> d
d --> e --> a --> f --> j --> k --> l --> o
`} />

This diagram replicates the structure of the example GraphViz file, illustrating the directed relationships between nodes.

In SocNetV, the same network can be visualized in many ways. For instance, in the screenshot below, we have applied a prominence-based layout (Eccentricity):

![SocNetV visualizing a network from an example GraphViz file](/data/uploads/screenshots/32/socnetv-32-example-dot.png)


### How to Use GraphViz Files in SocNetV

Expand Down Expand Up @@ -409,7 +426,9 @@ Note that this matrix is not symmetric.
- **Weighted**: In this example, the matrix is **weighted**, with values like 1 and 2 indicating the strength of the connections. Unweighted matrices would use binary values (0 and 1).
- **Symmetry**: The adjacency matrix is symmetric for undirected graphs, meaning `A[i][j] = A[j][i]`.

#### Mermaid Visualization:
#### Visualization:

This Mermaid diagram visualizes the graph represented by the adjacency matrix. The nodes 1, 2, 3, and 4 are connected with weighted edges, as indicated by the matrix.

<Mermaid code={`
graph TD
Expand All @@ -419,8 +438,6 @@ graph TD
3 -->|1| 4
`} />

This Mermaid diagram visualizes the graph represented by the adjacency matrix. The nodes 1, 2, 3, and 4 are connected with weighted edges, as indicated by the matrix.




Expand Down Expand Up @@ -509,7 +526,10 @@ SocNetV supports importing Pajek project files, which usually have a `.net` or `
- **Arcs**: The `*Arcs` section defines directed edges between nodes. Each line specifies a source node, target node, weight (e.g., `1`, `-1`), and an optional color.
- **Edges**: The `*Edges` section defines undirected edges, similar to `*Arcs`, with the same format.

#### Mermaid Visualization:
#### Visualization:

This Mermaid diagram visualizes the graph described in the Pajek file, showing the directed and undirected relationships between nodes.


<Mermaid code={`
graph TD
Expand All @@ -522,7 +542,6 @@ graph TD
pe5 -->|1| pe3
`} />

This Mermaid diagram visualizes the graph described in the Pajek file, showing the directed and undirected relationships between nodes.

### Handling Multiple Matrices in Pajek Files

Expand Down Expand Up @@ -637,7 +656,10 @@ DATA:
- **Labels**: The `LABELS` section lists the names of the nodes (e.g., Alice, Bob, Charlie, David).
- **Data**: The `DATA` section provides the adjacency matrix for the network. For instance, the value `1` at position `(1, 2)` indicates a connection between Alice and Bob, with a weight of `1`.

#### Mermaid Visualization:
#### Visualization:

This diagram visualizes the relationships described in the full matrix format, showing both the weights and the direction of edges.


<Mermaid code={`
graph TD
Expand All @@ -649,7 +671,6 @@ graph TD
Charlie -->|1| David
`} />

This diagram visualizes the relationships described in the full matrix format, showing both the weights and the direction of edges.

---

Expand Down Expand Up @@ -679,7 +700,7 @@ DATA:
- **Labels**: The `LABELS` section lists node names, just like in the full matrix example.
- **Data**: The `DATA` section lists edges in the form `source target weight`. For instance, `1 2 1` means Alice (node 1) is connected to Bob (node 2) with a weight of 1.

#### Mermaid Visualization:
#### Visualization:

<Mermaid code={`
graph TD
Expand Down Expand Up @@ -756,7 +777,7 @@ The edge list format is one of the simplest and most commonly used formats for r
- **Nodes**: Each pair of numbers in the edge list represents an edge between two nodes. For instance, `1 2` indicates an edge from node `1` to node `2`.
- **Unvalued**: This example is **unvalued**, meaning the edges have no weight associated with them. A `1` is implicitly understood as the connection between the nodes.

#### Mermaid Visualization:
#### Visualization:

<Mermaid code={`
graph TD
Expand All @@ -782,7 +803,7 @@ This Mermaid diagram visualizes the unvalued edge list. It shows a simple direct
- **Nodes and Weights**: Each line in the edge list represents a connection between two nodes, with the third column representing the weight of the edge. For example, `1 2 0.5` means there is an edge from node `1` to node `2` with a weight of `0.5`.
- **Valued Edges**: This example is **valued**, meaning the edges are weighted with numerical values.

#### Mermaid Visualization:
#### Visualization:

<Mermaid code={`
graph TD
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/manual/generate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@ To recreate a dataset:
</Steps>


![SocNetV visualizing Padgett's Florentine Families](/data/uploads/screenshots/32/socnetv-32-example-padgett-families.png)


---

## Random Network Creation
Expand Down

0 comments on commit 503efb9

Please sign in to comment.