Skip to content

Commit e9bd543

Browse files
InterdisciplinaryPhysicsTeamClaudMorpitmonticone
committed
Enrich README and docs
Co-Authored-By: Claudio Moroni <[email protected]> Co-Authored-By: Pietro Monticone <[email protected]>
1 parent 0b4a183 commit e9bd543

File tree

3 files changed

+19
-18
lines changed

3 files changed

+19
-18
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
**MultilayerGraphs.jl** is a Julia package for the creation, manipulation and analysis of the structure, dynamics and functions of multilayer graphs.
1919

20-
## Overview
20+
## 🌐 Overview
2121

2222
A multilayer graph is a graph consisting of multiple standard subgraphs called *layers* which can be interconnected through [bipartite graphs](https://en.wikipedia.org/wiki/Bipartite_graph) called *interlayers* composed of the vertex sets of two different layers and the edges between them. The vertices in each layer represent a single set of nodes, although not all nodes have to be represented in every layer.
2323

@@ -39,7 +39,7 @@ MultilayerGraphs.jl features multilayer-specific methods and metrics including t
3939

4040
Finally, MultilayerGraphs.jl has been integrated within the [JuliaDynamics](https://github.com/JuliaDynamics) ecosystem so that any `Multilayer(Di)Graph` can be utilised as an argument to the `GraphSpace` constructor in [Agents.jl](https://github.com/JuliaDynamics/Agents.jl).
4141

42-
## Installation
42+
## 🔰 Installation
4343

4444
To install the latest stable release of MultilayerGraphs.jl, make sure you have [installed](https://julialang.org/downloads/) Julia v1.8 or later and run the following command:
4545

@@ -55,7 +55,7 @@ using Pkg
5555
Pkg.add(url="https://github.com/JuliaGraphs/MultilayerGraphs.jl")
5656
```
5757

58-
## Usage
58+
## 🔍 Usage
5959

6060
Let's begin by importing the necessary dependencies and setting the relevant constants.
6161

@@ -244,23 +244,23 @@ modularity(
244244
)
245245
```
246246

247-
## Future Developments
247+
## 🎯 Future Developments
248248

249249
All the information regarding the future developments of MultilayerGraphs.jl can be found in the [issues](https://github.com/JuliaGraphs/MultilayerGraphs.jl/issues).
250250

251-
## How to Contribute
251+
## 🛠 How to Contribute
252252

253253
The ongoing development of this package would greatly benefit from the valuable feedback of the esteemed members of the [JuliaGraph](https://github.com/orgs/JuliaGraphs/people) community, as well as from graph theorists, network scientists, and any users who may have general questions or suggestions.
254254

255255
We therefore encourage you to participate in [discussions](https://github.com/JuliaGraphs/MultilayerGraphs.jl/discussions), raise [issues](https://github.com/JuliaGraphs/MultilayerGraphs.jl/issues), or submit [pull requests](https://github.com/JuliaGraphs/MultilayerGraphs.jl/pulls). Your contributions are welcome!
256256

257-
## How to Cite
257+
## 🎓 How to Cite
258258

259259
If you utilize this package in your project, please consider citing this repository using the citation information provided in [`CITATION.bib`](https://github.com/JuliaGraphs/MultilayerGraphs.jl/blob/main/CITATION.bib).
260260

261261
This will help to give appropriate credit to the [contributors](https://github.com/JuliaGraphs/MultilayerGraphs.jl/graphs/contributors) and support the continued development of the package.
262262

263-
## Announcements
263+
## 📢 Announcements
264264

265265
### v0.1
266266

@@ -278,7 +278,7 @@ MultilayerGraphs.jl (v1.1) and its features were announced on the following plat
278278
- [Forem](https://forem.julialang.org/inphyt/ann-multilayergraphsjl-v11-multilayer-network-science-in-julia-2oa3);
279279
- [Twitter](https://twitter.com/In_Phy_T/status/1612460371939581955).
280280

281-
## Related Packages
281+
## 📦 Related Packages
282282

283283
### R
284284

@@ -300,7 +300,7 @@ Here is a list of software packages for the creation, manipulation, analysis and
300300

301301
At the best of our knowledge there are currently no software packages dedicated to the creation, manipulation and analysis of multilayer graphs implemented in the [Julia language](https://julialang.org) apart from MultilayerGraphs.jl itself.
302302

303-
## References
303+
## 📚 References
304304

305305
1. De Domenico et al. (2013) [Mathematical Formulation of Multilayer Networks](https://doi.org/10.1103/PhysRevX.3.041022). *Physical Review X*;
306306
2. Kivelä et al. (2014) [Multilayer networks](https://doi.org/10.1093/comnet/cnu016). *Journal of Complex Networks*;

docs/make.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ makedocs(;
1919
canonical="https://juliagraphs.org/MultilayerGraphs.jl",
2020
assets=String[],
2121
),
22-
pages=["Home" => "index.md", "API" => "API.md"],
22+
pages=["🏠 Home" => "index.md",
23+
"🛠 API" => "API.md"],
2324
clean=false,
2425
)
2526

docs/src/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ CurrentModule = MultilayerGraphs
1616

1717
**MultilayerGraphs.jl** is a Julia package for the creation, manipulation and analysis of the structure, dynamics and functions of multilayer graphs.
1818

19-
## Overview
19+
## 🌐 Overview
2020

2121
A multilayer graph is a graph consisting of multiple standard subgraphs called *layers* which can be interconnected through [bipartite graphs](https://en.wikipedia.org/wiki/Bipartite_graph) called *interlayers* composed of the vertex sets of two different layers and the edges between them. The vertices in each layer represent a single set of nodes, although not all nodes have to be represented in every layer.
2222

@@ -43,7 +43,7 @@ A multilayer graph is composed of layers, i.e. graphs whose vertices represent t
4343
The documentation is organized as follows: you will find a comprehensive [Tutorial](@ref) below, complemented by an [API](@ref) page. The API page is organized in two sections: the [End-User](@ref) section lists all the methods intended for the user who does not need to write code that is also compatible with other libraries in the Graphs.jl's ecosystem, while the [Developer](@ref) section contains methods that allow MultilayerGraphs.jl to be used as any package that extend Graphs.jl . Bot section are further stratified by topic.
4444
The tutorial below will be focused on the end-used experience, as developer methods often have very similar signature and will be better addressed in a future developer-oriented guide, should the community manifest the need of it.
4545

46-
## Installation
46+
## 🔰 Installation
4747

4848
To install the latest stable release of MultilayerGraphs.jl, make sure you have [installed](https://julialang.org/downloads/) Julia v1.8 or later and run the following command:
4949

@@ -59,7 +59,7 @@ using Pkg
5959
Pkg.add(url="https://github.com/JuliaGraphs/MultilayerGraphs.jl")
6060
```
6161

62-
## Tutorial
62+
## 🔍 Tutorial
6363

6464
Here we illustrate how to define, handle and analyse a `MultilayerGraph` (the directed version is completely analogous).
6565

@@ -974,19 +974,19 @@ Read a complete list of analytical methods exclusive to multilayer graphs in the
974974

975975
All the information regarding the future developments of MultilayerGraphs.jl can be found in the [issues](https://github.com/JuliaGraphs/MultilayerGraphs.jl/issues).
976976

977-
## How to Contribute
977+
## 🛠 How to Contribute
978978

979979
The ongoing development of this package would greatly benefit from the valuable feedback of the esteemed members of the [JuliaGraph](https://github.com/orgs/JuliaGraphs/people) community, as well as from graph theorists, network scientists, and any users who may have general questions or suggestions.
980980

981981
We therefore encourage you to participate in [discussions](https://github.com/JuliaGraphs/MultilayerGraphs.jl/discussions), raise [issues](https://github.com/JuliaGraphs/MultilayerGraphs.jl/issues), or submit [pull requests](https://github.com/JuliaGraphs/MultilayerGraphs.jl/pulls). Your contributions are most welcome!
982982

983-
## How to Cite
983+
## 🎓 How to Cite
984984

985985
If you utilize this package in your project, please consider citing this repository using the citation information provided in [`CITATION.bib`](https://github.com/JuliaGraphs/MultilayerGraphs.jl/blob/main/CITATION.bib).
986986

987987
This will help to give appropriate credit to the [contributors](https://github.com/JuliaGraphs/MultilayerGraphs.jl/graphs/contributors) and support the continued development of the package.
988988

989-
## Announcements
989+
## 📢 Announcements
990990

991991
### v0.1
992992

@@ -1004,7 +1004,7 @@ MultilayerGraphs.jl (v1.1) and its features were announced on the following plat
10041004
- [Forem](https://forem.julialang.org/inphyt/ann-multilayergraphsjl-v11-multilayer-network-science-in-julia-2oa3);
10051005
- [Twitter](https://twitter.com/In_Phy_T/status/1612460371939581955).
10061006

1007-
## Related Packages
1007+
## 📦 Related Packages
10081008

10091009
### R
10101010

@@ -1026,7 +1026,7 @@ Here is a list of software packages for the creation, manipulation, analysis and
10261026

10271027
At the best of our knowledge there are currently no software packages dedicated to the creation, manipulation and analysis of multilayer graphs implemented in the [Julia language](https://julialang.org) apart from MultilayerGraphs.jl itself.
10281028

1029-
## References
1029+
## 📚 References
10301030

10311031
1. De Domenico et al. (2013) [Mathematical Formulation of Multilayer Networks](https://doi.org/10.1103/PhysRevX.3.041022). *Physical Review X*;
10321032
2. Kivelä et al. (2014) [Multilayer networks](https://doi.org/10.1093/comnet/cnu016). *Journal of Complex Networks*;

0 commit comments

Comments
 (0)