bump version to 0.2.1

.github/workflows/sphinx_render_docs.yml

@@ -1,11 +1,8 @@
 name: "Sphinx: Render docs"
 
 on:
-  # Triggers the workflow on push or pull request events but only for the main branch
-  push:
-    branches: [ main]
-  pull_request:
-    branches: [ main ]
+  release:
+    types: [published]
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 

CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2024-12-11
+Many improvements have been included in the update. 
+This has changed the API. Please check the documentation and the new examples.
+### Added
+ - `unify_sampling_rate` method to unify the sampling rate of scope channel objects
+ - Impedance `to_` functions to calculate R, L, C from a given impedance channel
+### Updated
+ - Documentation
+
 
 ## [0.2.0] - 2024-12-09
 Many improvements have been included in the update. 
@@ -25,6 +34,7 @@ Initial toolbox functionality
  - Basic functions for modifying data
  - Basic plotting functions
 
-[unreleased]: https://github.com/upb-lea/pySignalScope/compare/0.2.0...HEAD
+[unreleased]: https://github.com/upb-lea/pySignalScope/compare/0.2.1...HEAD
+[0.2.1]: https://github.com/upb-lea/pySignalScope/compare/0.2.0...0.2.1
 [0.2.0]: https://github.com/upb-lea/pySignalScope/compare/0.1.0...0.2.0
 [0.1.0]: https://github.com/upb-lea/pySignalScope/releases/tag/0.1.0

docs/source/conf.py

@@ -20,7 +20,7 @@
 project = 'pySignalScope'
 copyright = '2024, UPB-LEA'
 author = 'UPB-LEA'
-release = '0.2.0'
+release = '0.2.1'
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pysignalscope"
-version = "0.2.0"
+version = "0.2.1"
 authors = [
   { name="LEA - Paderborn University", email="[email protected]" },
 ]

pysignalscope/scope.py

@@ -1258,11 +1258,12 @@ def unify_sampling_rate(*channel_datasets: 'Channel', sample_calc_mode: str, sam
         If the mastermode is 'True' (default), only the first data set is used for  sampling rate calculation.
         This parameter is ignored, if the sample_calc_mode approach is set to 'user'
         For the calculation of the data rate following approaches can be select by parameter 'sample_calc_mode':
-        'avg' = Average sampling rate: The sampling rate shall be calculated by the average distance of the sampling rate.
-        'max' = Maximal sampling rate: The sampling rate shall be calculated by the minimum distance between two sample points.
-        'min' = Minimal sampling rate: The sampling rate shall be calculated by the maximal distance between two sample points.
-        'user' = Sampling rate is defined by the user. This selection raises an error, if the parameter 'sampling_rate'
-                 isn't a valid float value, which corresponds to the sampling frequency.
+
+        * 'avg' = Average sampling rate: The sampling rate shall be calculated by the average distance of the sampling rate.
+        * 'max' = Maximal sampling rate: The sampling rate shall be calculated by the minimum distance between two sample points.
+        * 'min' = Minimal sampling rate: The sampling rate shall be calculated by the maximal distance between two sample points.
+        * 'user' = Sampling rate is defined by the user. This selection raises an error, if the parameter 'sampling_rate' \
+        isn't a valid float value, which corresponds to the sampling frequency.
         """
         # check the parameter
         # type of parameter channel