Skip to content

Commit f85e529

Browse files
committed
update index.md
1 parent 8d11532 commit f85e529

File tree

1 file changed

+10
-46
lines changed

1 file changed

+10
-46
lines changed

docs/src/index.md

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,53 +5,22 @@ between the [Graphs.jl](https://github.com/JuliaGraphs/Graphs.jl) and the
55
[DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl) packages and facilitates the simulation of
66
highly efficient dynamic networks by describing the local dynamics of the edges and vertices of the network.
77

8-
!!! note
9-
**Complex Networks in a glance**
10-
Complex network systems are composed by the entities that comprise them (the nodes) and the relationships that
11-
connect each entity with one another (the edges). The mathematical structure is called
12-
[Graph](https://en.wikipedia.org/wiki/Graph_theory) and it is used more or less interchangeably with the word
13-
Network).
14-
15-
In this graph of a simple 5-node network
16-
```@example
17-
using Graphs, GraphMakie, CairoMakie #hide
18-
using GraphMakie.NetworkLayout #hide
19-
CairoMakie.activate!(type="svg") #hide
20-
g = smallgraph(:bull) #hide
21-
fig, ax, p = graphplot(g; ilabels=["v$i" for i in 1:nv(g)], #hide
22-
elabels=["e$i: $(e.src) ↦ $(e.dst)" for (i, e) in enumerate(edges(g))], #hide
23-
layout=Align(Stress()), figure=(;resolution=(830,450))) #hide
24-
ymin, ymax = extrema(last.(p[:node_pos][])) #hide
25-
ylims!(ax, (ymin-0.11*(ymax-ymin), ymax+0.11*(ymax-ymin)))#hide
26-
hidespines!(ax) #hide
27-
hidedecorations!(ax) #hide
28-
fig #hide
29-
```
30-
we can see that it is composed of nodes (v1 to v5) who are connected to each other. The lines connecting the nodes with
31-
each other ( e1: 1-->2, e2: 1-->3, e3: 2-->3, e4: 2-->4, e5: 3-->5) are called edges. Complex networks are composed of
32-
multiple nodes and edges, with most nodes connected to multiple other nodes with multiple edges.
33-
34-
(@Hans after rereading the text I realised that the information about the core of the package and the behaviours of the
35-
nodes and edges does not belong in the introduction but rather in the mathematical model, so I moved it. If you are ok
36-
with this just delete this comment)
8+
The core idea of this package is to define the **global dynamics** of a complex network in terms of **local dynamics**: each node and each edge exhibits some local dynamics defined as an input-output system.
9+
The graph topology describes, how the local dynamical systems are interconnected. To learn more check out the docs on the [mathematical model](@ref) behind NetworkDynamics.jl.
10+
For basic terminology see the Wikipedia article on [Graph Theory](https://en.wikipedia.org/wiki/Graph_theory).
3711

3812
Main features:
39-
- Clear separation of local dynamics and topology: you can easily change the topology of your system or switch out
40-
dynamic components)
41-
- High performance when working with heterogeneous models: you can have different local dynamics in different parts of
42-
your network)
43-
- [Symbolic Indexing](@ref) into solutions and states: NetworkDynamics keeps track of the states of each individual
44-
subsystem.
45-
- Diverse execution schemes: NetworkDynamics exploits the known interdependencies between components to auto
46-
parallelize execution, even on GPUs!
13+
- Clear separation of local dynamics and topology: you can easily change the topology of your system or switch out dynamic components.
14+
- High performance when working with heterogeneous models: you can have different local dynamics in different parts of your network.
15+
- [Symbolic Indexing](@ref) into solutions and states: NetworkDynamics keeps track of the states of each individual subsystem.
16+
- Diverse execution schemes: NetworkDynamics exploits the known interdependencies between components to auto parallelize execution, even on GPUs!
4717
- Equation based models: you can model local dynamics using
48-
[ModelingToolkit.jl](https://docs.sciml.ai/ModelingToolkit/dev/) and them combine them into larger networks using
49-
`NetworkDynamics.jl`!
18+
[ModelingToolkit.jl](https://docs.sciml.ai/ModelingToolkit/dev/) and then combine them into larger networks using `NetworkDynamics.jl`!
5019

5120

5221
## Where to begin?
53-
To learn how to implement your own models and understand the underlying modelling ideas of NetworkDynamics you should
54-
first read the [Mathematical Model](@ref) section, followed by section [Network Construction](@ref).
22+
To learn how to implement your own models and understand the underlying modeling ideas of NetworkDynamics you should
23+
first read the [Mathematical Model](@ref) section, followed by the [Network Construction](@ref) section.
5524

5625
If you prefer to look at some concrete code first check out the [Getting Started](@ref) tutorial!
5726

@@ -67,11 +36,6 @@ If you prefer to look at some concrete code first check out the [Getting Started
6736
(v1.11) pkg> add NetworkDynamics
6837
```
6938

70-
3. Install the Julia package LiveServer:
71-
```julia-repl
72-
import Pkg; Pkg.add("LiveServer")
73-
```
74-
7539
To learn more about how to use Julia you can visit: [Modern Julia Workflows](https://modernjuliaworkflows.org/)
7640

7741

0 commit comments

Comments
 (0)