Skip to content

Update README.md #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juwiragiye wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ Installing
==========
The package can be installed via Pip:

`pip install pygfl`
```sh
pip install pygfl
```

or directly from source:

```
```sh
python setup.py build
python setup.py install
```
Expand All @@ -37,7 +39,7 @@ Note that the installation has not been tested on anything other than Mac OS X a

If you have trouble installing with pip due to linker errors with GSL and conda, you can solve this by adding your GSL headers to the include and library paths. E.g. in conda3:

```
```sh
conda install -c conda-forge gsl
export C_INCLUDE_PATH=/opt/anaconda3/envs/{environment name}/include/
export LIBRARY_PATH=/opt/anaconda3/envs/{environment name}/lib/
Expand All @@ -47,7 +49,7 @@ Running
=======
The simplest way to run the script is via the command-line `graphfl` script. You just give it a CSV of your data that you wish to smooth and a CSV of your edges, one edge per row:

```
```sh
graphfl example/data.csv example/edges.csv --o example/smoothed.csv
```

Expand All @@ -57,7 +59,7 @@ Calling within Python
=====================
To call the solver within a Python program, the simplest way is to use the `easy.solve_gfl` method:

```
```py
import numpy as np
from pygfl.easy import solve_gfl

Expand Down