Skip to content

Commit

Permalink
Update 0.1.6
Browse files Browse the repository at this point in the history
  • Loading branch information
nvlinhvn committed May 19, 2024
1 parent 7da7ed4 commit 3acb4ef
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 10 deletions.
6 changes: 1 addition & 5 deletions HSTransform.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: HSTransform
Version: 0.1.5
Version: 0.1.6
Summary: A Package to Compute S-transform with Hyperbolic Window
Home-page: https://github.com/nvlinhvn/HSTransform
Author: Linh V Nguyen
Expand All @@ -11,10 +11,6 @@ Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.21.2
Requires-Dist: scipy>=1.7.1
Requires-Dist: pandas>=1.3.3
Requires-Dist: pytest>=6.2.5

# Hyperbolic S-Transform

Expand Down
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,18 @@ HS Transform requires the following Python packages:

## 3. How to Install

You can install HS Transform using pip:
After that, you can install HS Transform using pip:

```
pip install HSTransform
```

You can also install all dependencies and package in 1 statement

```
pip install numpy scipy pandas matplotlib pytest HSTransform
```

## 4. Run tests

After installation, you can test the package using the included test scripts:
Expand All @@ -42,7 +48,17 @@ After installation, you can test the package using the included test scripts:

Here’s an example of how to use HS Transform to analyze a signal with voltage disturbance and power system fault:

It's noted sometimes you need to include the installed HSTransform package location into sys

```python
import sys
import os

# Add the package directory to sys.path
package_path = os.path.abspath('/usr/local/Caskroom/miniconda/base/envs/YOUR_ENVIRONMENT/lib/python3.10/site-packages/')
if package_path not in sys.path:
sys.path.insert(0, package_path)

from hstransform import HSTransform

# Create input signal (for example: Voltage signal)
Expand Down
2 changes: 0 additions & 2 deletions build/lib/hstransform/hstransform.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,5 +131,3 @@ def fit_transform(self,
s[k // fsamplingrate, :] = ifft(h[minf + k + 1:minf + k + n+1] * w_hy)

return s


2 changes: 1 addition & 1 deletion build/lib/tests/test_hstransform.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"""
import numpy as np
import pytest
from HSTransform.hstransform import HSTransform
from hstransform import HSTransform

def test_hyperbolic_gaussian():
"""
Expand Down
Binary file added dist/HSTransform-0.1.6-py3-none-any.whl
Binary file not shown.
Binary file added dist/HSTransform-0.1.6.tar.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

setup(
name='HSTransform',
version='0.1.5',
version='0.1.6',
url='https://github.com/nvlinhvn/HSTransform',
packages=find_packages(),
license='MIT',
Expand Down

0 comments on commit 3acb4ef

Please sign in to comment.