Skip to content

Commit

Permalink
added note on optional pip install arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
mennthor committed Dec 14, 2021
1 parent 6eb0c95 commit d3dd004
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ Just clone the repository and invoke `pip`:

```bash
git clone https://github.com/mennthor/awkde
pip install [--user] -e ./awkde
pip install [--user] [-e] ./awkde
```
Note: `--user` and `-e` are optional. Use `--user` to install in your user site-package directory (recommended) and `-e` if you want to only link the files to the site-package directories, so that when you make any changes in your local copy, you don't have to reinstall all the time.

Try to run the `example/examply.py`:

Expand All @@ -20,7 +21,7 @@ cd awkde/example
python example.py
```

You should get this screen (you need matplotlib for the plot):
You should get this plot in the examples folder (you need matplotlib for the plot):

![example plot](example/example.png)

Expand Down Expand Up @@ -61,4 +62,4 @@ For information on Silverman or Scott rule, see [2] or [3].
## References
- [1] B. Wang and X. Wang, "Bandwidth Selection for Weighted Kernel Density Estimation", Sep. 2007, DOI: 10.1214/154957804100000000.
- [2] D.W. Scott, "Multivariate Density Estimation: Theory, Practice, and Visualization", John Wiley & Sons, New York, Chicester, 1992.
- [3] B.W. Silverman, "Density Estimation for Statistics and Data Analysis", Vol. 26, Monographs on Statistics and Applied Probability, Chapman and Hall, London, 1986.
- [3] B.W. Silverman, "Density Estimation for Statistics and Data Analysis", Vol. 26, Monographs on Statistics and Applied Probability, Chapman and Hall, London, 1986.

0 comments on commit d3dd004

Please sign in to comment.