Skip to content

Commit

Permalink
Update README.md (#155)
Browse files Browse the repository at this point in the history
* Update README.md

Fixed pip command for installation from source

* Update intro.rst

fixed instruction for installation from sources

* Update README.md

Fixed wrong wording
  • Loading branch information
JFadanni authored Apr 12, 2024
1 parent 5a19e26 commit 90886e1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,21 +56,29 @@ The quickest way to install package is through `pip`.

> \$ pip install EMD-signal
In this way you install the latest stable release of PyEMD hosted on PyPi

### From source

In case, if you only want to *use* EMD and its variations, the best way to install PyEMD is through `pip`.
However, if you want to modify the code, anyhow you might want to download the code and build package yourself.
However, if you want the latest version of PyEMD, anyhow you might want to download the code and build package yourself.
The source is publicaly available and hosted on [GitHub](https://github.com/laszukdawid/PyEMD).
To download the code you can either go to the source code page and click `Code -> Download ZIP`, or use **git** command line

> \$ git clone <https://github.com/laszukdawid/PyEMD>
Installing package from source is done using command line:

> \$ python setup.py install
> \$ python3 -m pip install .
**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).
after entering the PyEM directory created by `git`.

A quicker way to install PyEMD from source is done using `pip` and `git` in the same command:

>\$ python3 -m pip install git+https://github.com/laszukdawid/PyEMD.git
**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).
If you want to make your installation editable use the `-e` flag for [pip](https://packaging.python.org/en/latest/tutorials/installing-packages/)
## Example

More detailed examples are included in the
Expand Down
6 changes: 5 additions & 1 deletion doc/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,11 @@ In case you like using command line and want a copy-paste line ::

Once the code is downloaded, enter package's directory and execute ::

$ python setup.py install
$ python -m pip install .

Or you can do it at once with ::

$ python -m pip install git+https://github.com/laszukdawid/PyEMD.git

This will download all required dependencies and will install PyEMD in your environment.
Once it's done do a sanity check with quick import and version print: ::
Expand Down

0 comments on commit 90886e1

Please sign in to comment.