Skip to content

Commit 53d3aaf

Browse files
committed
make release-tag: Merge branch 'master' into stable
2 parents cf63a7b + 7454f3b commit 53d3aaf

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

HISTORY.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
11
# History
2+
3+
## 0.0.1 - 2020-11-30
4+
5+
First release to PyPI.
6+
7+
This release comes with the first version of the `contributing` module, which makes it easier
8+
to create new primitives and to test those with the demo data included in this package.
9+
10+
This release also includes the following User Guides:
11+
12+
* [PRIMITIVES.md](https://github.com/signals-dev/SigPro/blob/master/PRIMITIVES.md): Information
13+
about the primitive families, their expected input and output.
14+
* [USAGE.md](https://github.com/signals-dev/SigPro/blob/master/USAGE.md): Instructions about how
15+
to usee the three main functionalities of `SigPro`.
16+
* [DEVELOPMENT.md](https://github.com/signals-dev/SigPro/blob/master/DEVELOPMENT.md): Step by step
17+
guide about how to write a valid `SigPro` primitive and contribute it to either `SigPro` or
18+
your own library.
19+
20+
### Features
21+
22+
* Demo data: Available demo data to test primitives.
23+
* First primitives: The following list of primitives were added:
24+
* `sigpro.aggregations.amplitude.statistical.crest_factor`
25+
* `sigpro.aggregations.amplitude.statistical.kurtosis`
26+
* `sigpro.aggregations.amplitude.statistical.mean`
27+
* `sigpro.aggregations.amplitude.statistical.rms`
28+
* `sigpro.aggregations.amplitude.statistical.skew`
29+
* `sigpro.aggregations.amplitude.statistical.std`
30+
* `sigpro.aggregations.amplitude.statistical.var`
31+
* `sigpro.transformations.amplitude.identity.identity`
32+
* `sigpro.transformations.frequency.fft.fft`
33+
* `sigpro.transformations.frequency.fft.fft_real`
34+
* `sigpro.transformations.frequency_time.stft.stft`
35+
* `sigpro.transformations.frequency_time.stft.stft_real`
36+
* Contributing module.
37+
* Documentation on how to contribute new primitives and how to run those.

0 commit comments

Comments
 (0)