Skip to content

Commit 4228350

Browse files
committed
readme format changed
1 parent 0f0eee1 commit 4228350

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# fracdiff
1+
[![PyPI version](https://badge.fury.io/py/numpy-fracdiff.svg)](https://badge.fury.io/py/numpy-fracdiff)
2+
3+
# numpy-fracdiff
24
Fractional Difference for Time Series
35

46
## Installation
57
The `numpy-fracdiff` [git repo](http://github.com/ulf1/numpy-fracdiff) is available as [PyPi package](https://pypi.org/project/numpy-fracdiff)
68

7-
```
9+
```sh
810
pip install numpy-fracdiff
911
pip install git+ssh://[email protected]/ulf1/numpy-fracdiff.git
1012
```
@@ -13,10 +15,11 @@ pip install git+ssh://[email protected]/ulf1/numpy-fracdiff.git
1315
Check the [examples](https://github.com/ulf1/fracdiff/tree/master/examples) folder for notebooks.
1416

1517

16-
## Commands
17-
Install a virtual environment
18+
## Appendix
1819

19-
```
20+
### Install a virtual environment
21+
22+
```sh
2023
python3.6 -m venv .venv
2124
source .venv/bin/activate
2225
pip install --upgrade pip
@@ -25,16 +28,16 @@ pip install -r requirements.txt
2528

2629
(If your git repo is stored in a folder with whitespaces, then don't use the subfolder `.venv`. Use an absolute path without whitespaces.)
2730

28-
Python commands
31+
### Python commands
2932

3033
* Jupyter for the examples: `jupyter lab`
3134
* Check syntax: `flake8 --ignore=F401 --exclude=$(grep -v '^#' .gitignore | xargs | sed -e 's/ /,/g')`
3235
* Run Unit Tests: `pytest`
3336
* Upload to PyPi with twine: `python setup.py sdist && twine upload -r pypi dist/*`
3437

35-
Clean up
38+
### Clean up
3639

37-
```
40+
```sh
3841
find . -type f -name "*.pyc" | xargs rm
3942
find . -type d -name "__pycache__" | xargs rm -r
4043
rm -r .pytest_cache

0 commit comments

Comments
 (0)