From 55c64b827d4e9f2bc819470a12a3eaa9ce40d45c Mon Sep 17 00:00:00 2001 From: Pau Clusella Date: Fri, 3 Feb 2023 10:05:43 +0100 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c44fce1..44e4fc3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# explosive-immunization -Explosive immunization algorithm for network fragmentation introduced in the article Pau Clusella, Peter Grassberger, Francisco J. Pérez-Reche, and Antonio Politi Phys. Rev. Lett. **117**, 208301. +# Explosive immunization +Explosive immunization algorithm for network fragmentation, introduced in the article [Pau Clusella, Peter Grassberger, Francisco J. Pérez-Reche, and Antonio Politi Phys. Rev. Lett. **117**, 208301.](https://doi.org/10.1103/PhysRevLett.117.208301) Please, refer to the paper for details of the algorithm. @@ -18,9 +18,9 @@ To run the code use $ ./exploimmun ``` where -* `m` is a positive integer stating the number of candidates to select at each step of the algorithm. The smaller the `m`, the fastest is the algorithm, but a too small number might result on a bad performance. For networks with a million nodes, `m=1000` might be a good options. +* `m` is a positive integer stating the number of candidates to select at each step of the algorithm. The smaller the `m`, the fastest is the algorithm. However, a too small number might result on a bad performance. For networks with a million nodes, `m=1000` might be a reasonable option. -* `network.txt` is the file where the network is stored. The first line must be only the number of nodes of the networ. The following lines must contain the list of edges with the format. A edge written as `i j` means that there is a link between node `i` and `j`. **The proper format of the file is not checked by the code.** A exemplary file is given in the repository as `ER1e5.txt`. +* `network.txt` is the file where the network is stored. The first line must be just a single number, `N` the number of network nodes. The following lines must contain the list of edges. An edge written as `i j` means that there is a link between node `i` and `j`. **The proper format of the file is not checked by the code so the user should ensure everything is set appropiately.** A exemplary file is given in the repository as `ER1e5.txt`. ## Outputs generated by the algorithm @@ -32,4 +32,4 @@ All the output files are generated in the workspace ## Algorithm parameters -The only parameter the program requires is `m`. The effective degree cut-off is set to 6. The threshold where the second score is invoked is set to 1/sqrt(N). These two parameters can be easily changed from the file `Library/exploimmun.c` +The only parameter the program requires is `m`. The effective degree cut-off is set to 6. The threshold where the second score is invoked is set to $1/\sqrt{N}$. These two parameters can be easily changed from the source file `Library/exploimmun.c`