Skip to content
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

Update README.md #155

Merged
merged 3 commits into from
Apr 12, 2024
Merged

Update README.md #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10215c6
Update README.md
JFadanni Apr 4, 2024
395a079
Update intro.rst
JFadanni Apr 5, 2024
d6f7dd3
Update README.md
JFadanni Apr 8, 2024
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
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
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

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wording of this sentence isn't correct. For one, it is the latest officially supported version rather than "the old". If feel strongly that there needs to be an explanation that this package is hosted on pypi then please reprahse it. Otherwise, I think this sentence doesn't add much to the doc and can be deleted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll fix the sentence and adjust the paragraph to improve the consistency of the instruction for the installation from source

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll fix the sentence and adjust the paragraph to improve the consistency of the instruction for the installation from source

Done

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, was traveling. Looks good!

### 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 .
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Thank you for point out that setup hasn't been supported for a while.


**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
View file
Open in desktop
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