Skip to content

Commit 1cfa63a

Browse files
committed
doc: reference to conda-forge
1 parent 4fc4001 commit 1cfa63a

File tree

2 files changed

+48
-6
lines changed

2 files changed

+48
-6
lines changed

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
[![DocStatus](https://readthedocs.org/projects/pyemd/badge/?version=latest)](https://pyemd.readthedocs.io/)
33
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f56b6fc3f855476dbaebd3c02ae88f3e)](https://www.codacy.com/gh/laszukdawid/PyEMD/dashboard?utm_source=github.com&utm_medium=referral&utm_content=laszukdawid/PyEMD&utm_campaign=Badge_Grade)
44
[![DOI](https://zenodo.org/badge/65324353.svg)](https://zenodo.org/badge/latestdoi/65324353)
5+
[![Conda](https://anaconda.org/conda-forge/emd-signal/badges/version.svg)](https://anaconda.org/conda-forge/emd-signal/badges/version.svg)
56

67
# PyEMD
78

@@ -50,13 +51,35 @@ and extrema interpolations.
5051

5152
## Installation
5253

54+
**Note**: Downloadable package is called `emd-signal`.
55+
5356
### PyPi (recommended)
5457

5558
The quickest way to install package is through `pip`.
5659

57-
> \$ pip install EMD-signal
60+
```sh
61+
pip install EMD-signal
62+
```
63+
64+
or with [uv]() you can do
65+
66+
```sh
67+
uv add emd-signal
68+
#or
69+
# uv pip install EMD-signal
70+
```
71+
72+
In this way you install the latest stable release of PyEMD hosted on [PyPi](https://pypi.org/project/emd/).
73+
74+
### Conda
75+
76+
PyEMD (as `emd-signal`) is available for Conda via conda-forge channel
5877

59-
In this way you install the latest stable release of PyEMD hosted on PyPi
78+
```sh
79+
conda install -c conda-forge emd-signal
80+
```
81+
82+
Source: [https://anaconda.org/conda-forge/emd-signal](https://anaconda.org/conda-forge/emd-signal)
6083

6184
### From source
6285

@@ -65,20 +88,27 @@ However, if you want the latest version of PyEMD, anyhow you might want to downl
6588
The source is publicaly available and hosted on [GitHub](https://github.com/laszukdawid/PyEMD).
6689
To download the code you can either go to the source code page and click `Code -> Download ZIP`, or use **git** command line
6790

68-
> \$ git clone <https://github.com/laszukdawid/PyEMD>
91+
```sh
92+
git clone https://github.com/laszukdawid/PyEMD
93+
```
6994

7095
Installing package from source is done using command line:
7196

72-
> \$ python3 -m pip install .
97+
```sh
98+
python3 -m pip install .
99+
```
73100

74101
after entering the PyEM directory created by `git`.
75102

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

78-
>\$ python3 -m pip install git+https://github.com/laszukdawid/PyEMD.git
105+
```sh
106+
python3 -m pip install git+https://github.com/laszukdawid/PyEMD.git
107+
```
79108

80109
**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).
81110
If you want to make your installation editable use the `-e` flag for [pip](https://packaging.python.org/en/latest/tutorials/installing-packages/)
111+
82112
## Example
83113

84114
More detailed examples are included in the
@@ -186,7 +216,9 @@ and suggestions.
186216

187217
To enable JIT in your PyEMD, please install with `jit` option, i.e.
188218

189-
> \$ pip install EMD-signal[jit]
219+
```sh
220+
pip install EMD-signal[jit]
221+
```
190222

191223
### EMD2D/BEMD
192224

@@ -208,6 +240,7 @@ IMFs_2D = emd2d(img)
208240
## F.A.Q
209241

210242
### Why is EEMD/CEEMDAN so slow?
243+
211244
Unfortunately, that's their nature. They execute EMD multiple times every time with slightly modified version. Added noise can cause a creation of many extrema which will decrease performance of the natural cubic spline. For some tweaks on how to deal with that please see [Speedup tricks](https://pyemd.readthedocs.io/en/latest/speedup.html) in the documentation.
212245

213246
## Contact

doc/intro.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ Once the package is installed it should be accessible in your Python as `PyEMD`,
3232

3333
>>> from PyEMD import EMD
3434

35+
Conda
36+
`````
37+
38+
If you are using `conda` and prefer to install packages from `conda-forge` channel, you can do so with ::
39+
40+
$ conda install -c conda-forge emd-signal
41+
42+
This will install the package and all dependencies from the `conda-forge` channel.
43+
3544
Research (github)
3645
`````````````````
3746

0 commit comments

Comments
 (0)