|
2 | 2 | [](https://travis-ci.org/laszukdawid/PyEMD) |
3 | 3 | [](https://pyemd.readthedocs.io/) |
4 | 4 | [](https://www.codacy.com/app/laszukdawid/PyEMD?utm_source=github.com&utm_medium=referral&utm_content=laszukdawid/PyEMD&utm_campaign=badger) |
5 | | -[](https://ko-fi.com/A0A110NUD) |
6 | 5 |
|
7 | 6 | # PyEMD |
8 | 7 |
|
9 | 8 | ## Links |
10 | 9 |
|
11 | | -- HTML documentation: <https://pyemd.readthedocs.org> |
| 10 | +- Online documentation: <https://pyemd.readthedocs.org> |
12 | 11 | - Issue tracker: <https://github.com/laszukdawid/pyemd/issues> |
13 | 12 | - Source code repository: <https://github.com/laszukdawid/pyemd> |
14 | 13 |
|
@@ -44,25 +43,26 @@ and extrema interpolation. |
44 | 43 |
|
45 | 44 | ## Installation |
46 | 45 |
|
47 | | -### Recommended |
| 46 | +### PyPi (recommended) |
48 | 47 |
|
49 | | -Simply download this directory either directly from GitHub, or using |
50 | | -command line: |
| 48 | +The quickest way to install package is through `pip`. |
51 | 49 |
|
52 | | -> \$ git clone <https://github.com/laszukdawid/PyEMD> |
| 50 | +> \$ pip install EMD-signal |
53 | 51 |
|
54 | | -Then go into the downloaded project and run from command line: |
| 52 | +### From source |
55 | 53 |
|
56 | | -> \$ python setup.py install |
| 54 | +In case you only want to *use* EMD and its variation, the best way to install PyEMD is through `pip`. |
| 55 | +However, if you are want to modify the code anyhow you might want to download the code and build package yourself. |
| 56 | +The source is publicaly available and hosted on [GitHub](https://github.com/laszukdawid/PyEMD). |
| 57 | +To download the code you can either go to the source code page and click `Code -> Download ZIP`, or use **git** command line |
57 | 58 |
|
58 | | -### PyPi |
| 59 | +> \$ git clone <https://github.com/laszukdawid/PyEMD> |
59 | 60 |
|
60 | | -Packaged obtained from PyPi is/will be slightly behind this project, so |
61 | | -some features might not be the same. However, it seems to be the |
62 | | -easiest/nicest way of installing any Python packages, so why not this |
63 | | -one? |
| 61 | +Installing package from source is done using command line: |
64 | 62 |
|
65 | | -> \$ pip install EMD-signal |
| 63 | +> \$ python setup.py install |
| 64 | +
|
| 65 | +**Note**, however, that this will install it in your current environment. If you are working on many projects, or sharing reources with others, we suggest using [virtual environments](https://docs.python.org/3/library/venv.html). |
66 | 66 |
|
67 | 67 | ## Example |
68 | 68 |
|
|
0 commit comments