Skip to content

Commit b4426e9

Browse files
author
Beth Proedrou
committed
incorporated the changes requested
1 parent d8855e9 commit b4426e9

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

docs/src/index.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,28 @@ highly efficient dynamic networks by describing the local dynamics on the edges
88
!!! note
99
Complex network systems are composed by the entities that comprise them (the nodes) and the relationships that connect
1010
each entity with one another (the edges). The graphical depictions of such networks are called graphs. The simplest
11-
network (which can be seen in Figure 1) is composed of two entities (so two nodes) who are only connected to each other.
11+
The mathematical structure (used more or less interchangeably with Network) is also called [Graph](https://en.wikipedia.org/wiki/Graph_theory).
12+
The network (which can be seen in the figure below) is composed of two entities (so two nodes) who are only connected to each other.
1213
This connection between the two is the edge of the system. Complex networks are composed of multiple nodes and edges,
1314
with most nodes connected to multiple other nodes with multiple edges *(@Hans: can you created the graph of such a
1415
network and place in here?)*
1516

17+
```
18+
@example
19+
using Graphs, NetworkDynamics, OrdinaryDiffEqTsit5, StableRNGs, GraphMakie, Plots, CairoMakie #hide
20+
using GraphMakie.NetworkLayout #hide
21+
CairoMakie.activate!(type="svg") #hide
22+
g = smallgraph(:bull) #hide
23+
fig, ax, p = graphplot(g; ilabels=["v$i" for i in 1:nv(g)], #hide
24+
elabels=["e$i: $(e.src) ↦ $(e.dst)" for (i, e) in enumerate(edges(g))], #hide
25+
layout=Align(Stress()), figure=(;resolution=(400,200))) #hide
26+
ymin, ymax = extrema(last.(p[:node_pos][])) #hide
27+
ylims!(ax, (ymin-0.11*(ymax-ymin), ymax+0.11*(ymax-ymin)))#hide
28+
hidespines!(ax) #hide
29+
hidedecorations!(ax) #hide
30+
fig #hide
31+
```
32+
1633
The behavior of a node or an edge can be described through the use of a) algebraic equations, b) differential algebraic
1734
equation (DAEs) in mass matrix form or c) ordinary differential equations (ODE).
1835

@@ -48,25 +65,21 @@ If you prefer to look at some concrete code first check out the [Getting Started
4865

4966
## Installation
5067

51-
Install Julia:
52-
- https://julialang.org/install/
68+
1. Install Julia:
69+
- [Julia Installation](https://julialang.org/install/)
5370
- Find your OS and follow the instructions for the installation
5471

55-
Install NetworkDynamics.jl with Julia's package manager:
72+
2. Install NetworkDynamics.jl with Julia's package manager:
5673
```julia-repl
5774
(v1.11) pkg> add NetworkDynamics
5875
```
5976

60-
Next you need to install the Julia package Revise:
61-
```julia-repl
62-
import Pkg; Pkg.add("Revise")
63-
```
64-
65-
Last you need to install the Julia package LiveServer:
77+
3. Install the Julia package LiveServer:
6678
```julia-repl
6779
import Pkg; Pkg.add("LiveServer")
6880
```
6981

82+
To learn more about how to use Julia you can visit: [Modern Julia Workflows](https://modernjuliaworkflows.org/)
7083

7184

7285
## Reproducibility

0 commit comments

Comments
 (0)