Skip to content

Commit 238ae59

Browse files
authored
Merge pull request #28 from ulf1/rename-repo
fix #22 rename to numpy-fracdiff for pypi
2 parents c6745bf + d40138c commit 238ae59

15 files changed

+73
-81
lines changed

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
* sklearn wrapper removed
44
* License changed to MIT
5+
* rename to numpy-fracdiff for pypi
56

67
# 0.2.0 / 2020-03-27
78

README.md

Lines changed: 20 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,19 @@
22
Fractional Difference for Time Series
33

44
## Installation
5-
The `fracdiff` [git repo](http://github.com/ulf1/fracdiff) is a private package that needs to be installed from github
5+
The `numpy-fracdiff` [git repo](http://github.com/ulf1/numpy-fracdiff) is available as [PyPi package](https://pypi.org/project/numpy-fracdiff)
66

77
```
8-
pip install git+ssh://git@github.com/ulf1/fracdiff.git
8+
pip install numpy-fracdiff
9+
pip install git+ssh://git@github.com/ulf1/numpy-fracdiff.git
910
```
1011

11-
with GemFury
12-
13-
```
14-
FURY_AUTH="<deploy token>"
15-
pip install fracdiff --extra-index-url https://${FURY_AUTH}:@pypi.fury.io/kmedian/
16-
```
17-
18-
19-
## Install via requirements.txt
20-
when using `fracdiff==0.2.*` in `requirements.txt`,
21-
add on top of `requirements.txt`:
22-
23-
```
24-
# Access private packages on gemfury
25-
--index-url https://${FURY_AUTH}:@pypi.fury.io/kmedian/
26-
...
27-
```
12+
## Usage
13+
Check the [examples](https://github.com/ulf1/fracdiff/tree/master/examples) folder for notebooks.
2814

29-
Set `FURY_AUTH` with the deploy token before pip commands:
3015

31-
```
32-
FURY_AUTH="<deploy token>" pip install -r requirements.txt
33-
```
34-
35-
## Install a virtual env
16+
## Commands
17+
Install a virtual environment
3618

3719
```
3820
python3.6 -m venv .venv
@@ -41,13 +23,20 @@ pip install --upgrade pip
4123
pip install -r requirements.txt
4224
```
4325

44-
## Usage
45-
Check the [examples](https://github.com/ulf1/fracdiff/tree/master/examples) folder for notebooks.
26+
(If your git repo is stored in a folder with whitespaces, then don't use the subfolder `.venv`. Use an absolute path without whitespaces.)
4627

28+
Python commands
4729

48-
## Commands
30+
* Jupyter for the examples: `jupyter lab`
4931
* Check syntax: `flake8 --ignore=F401 --exclude=$(grep -v '^#' .gitignore | xargs | sed -e 's/ /,/g')`
5032
* Run Unit Tests: `python -W ignore -m unittest discover`
51-
* Remove `.pyc` files: `find . -type f -name "*.pyc" | xargs rm`
52-
* Remove `__pycache__` folders: `find . -type d -name "__pycache__" | xargs rm -rf`
53-
* Publish on GemFury pypi server: `python setup.py sdist && twine upload -r fury dist/*`
33+
* Upload to PyPi with twine: `python setup.py sdist && twine upload -r pypi dist/*`
34+
35+
Clean up
36+
37+
```
38+
find . -type f -name "*.pyc" | xargs rm
39+
find . -type d -name "__pycache__" | xargs rm -r
40+
rm -r .pytest_cache
41+
rm -r .venv
42+
```

examples/profile-apply-weights.ipynb

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"source": [
1919
"import numpy as np\n",
2020
"import numba\n",
21-
"from fracdiff.frac_weights import frac_weights"
21+
"from numpy_fracdiff.frac_weights import frac_weights"
2222
]
2323
},
2424
{
@@ -102,10 +102,10 @@
102102
"name": "stdout",
103103
"output_type": "stream",
104104
"text": [
105-
"CPU times: user 2.95 ms, sys: 2.15 ms, total: 5.1 ms\n",
106-
"Wall time: 11.1 ms\n",
107-
"CPU times: user 607 ms, sys: 8.83 ms, total: 616 ms\n",
108-
"Wall time: 627 ms\n"
105+
"CPU times: user 2.92 ms, sys: 1.33 ms, total: 4.25 ms\n",
106+
"Wall time: 5.49 ms\n",
107+
"CPU times: user 787 ms, sys: 19.4 ms, total: 806 ms\n",
108+
"Wall time: 931 ms\n"
109109
]
110110
}
111111
],
@@ -130,8 +130,8 @@
130130
"name": "stdout",
131131
"output_type": "stream",
132132
"text": [
133-
"874 µs ± 8.7 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each)\n",
134-
"332 µs ± 5.56 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each)\n"
133+
"949 µs ± 101 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each)\n",
134+
"336 µs ± 7.18 µs per loop (mean ± std. dev. of 7 runs, 1000 loops each)\n"
135135
]
136136
}
137137
],

examples/profile-integer-differentiation.ipynb

Lines changed: 38 additions & 37 deletions
Large diffs are not rendered by default.

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ jupyterlab>=1.2.*
1313
matplotlib>=3.1.*
1414
quandl>=3.5.*
1515
pandas>=1.0.*
16+
scipy>=1.4.*

0 commit comments

Comments
 (0)