Skip to content

Commit 2457a97

Browse files
authored
Update README.rst
1 parent d196376 commit 2457a97

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

README.rst

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,34 @@ Installation
99

1010
.. code-block:: sh
1111
12-
$ python3 -m pip install git+https://github.com/jmarinllao/diffuPy.git@master
12+
$ python3 -m pip install git+https://github.com/multipaths/DiffuPy.git@master
1313
1414
2. or in editable mode with:
1515

1616
.. code-block:: sh
1717
18-
$ git clone https://github.com/jmarinllao/diffuPy.git
18+
$ git clone https://github.com/multipaths/DiffuPy.git
1919
$ cd diffupy
2020
$ python3 -m pip install -e .
2121
22-
How to Use
23-
----------
22+
Command Line Interface
23+
----------------------
24+
The following commands can be used directly use from your terminal:
25+
26+
1. **Run a diffusion analysis**
27+
The following command will run a diffusion method on a given network with the given data
28+
29+
.. code-block:: sh
30+
31+
$ python3 -m diffupy diffuse --network="<path-to-network-file>" --input="<path-to-data-file>" --method="<method>"
2432
25-
1. **Generate Kernel**
2633
27-
Generates the kernel of a given graph.
34+
2. **Generate a kernel with one of the seven methods implemented**
35+
Generates the regularised Laplian kernel of a given graph.
2836

2937
.. code-block:: sh
3038
31-
$ python3 -m diffupy kernel
39+
$ python3 -m diffupy kernel --network="<path-to-network-file>"
3240
3341
3442
References

0 commit comments

Comments
 (0)