shepherd-data 2023.8.7__py3-none-any.whl → 2023.9.0__py3-none-any.whl

shepherd_data/__init__.py

@@ -9,7 +9,7 @@ from shepherd_core import BaseWriter as Writer
 
 from .reader import Reader
 
-__version__ = "2023.8.7"
+__version__ = "2023.9.0"
 
 __all__ = [
     "Reader",

shepherd_data/cli.py

@@ -29,13 +29,13 @@ def path_to_flist(data_path: Path) -> List[Path]:
     """
     data_path = Path(data_path).resolve()
     h5files = []
-    if data_path.is_file() and data_path.suffix == ".h5":
+    if data_path.is_file() and data_path.suffix.lower() == ".h5":
         h5files.append(data_path)
     elif data_path.is_dir():
         flist = os.listdir(data_path)
         for file in flist:
             fpath = data_path / str(file)
-            if not fpath.is_file() or ".h5" != fpath.suffix:
+            if not fpath.is_file() or ".h5" != fpath.suffix.lower():
                 continue
             h5files.append(fpath)
     return h5files

shepherd_data/reader.py

@@ -14,6 +14,7 @@ from matplotlib import pyplot as plt
 from tqdm import trange
 
 from shepherd_core import BaseReader
+from shepherd_core.logger import logger
 
 # import samplerate  # TODO: just a test-fn for now
 
@@ -402,6 +403,7 @@ class Reader(BaseReader):
             f".plot_{start_str}_to_{end_str}.png"
         )
         if plot_path.exists():
+            self._logger.warning("Plot exists, will skip & not overwrite!")
             return
         self._logger.info("Plot generated, will be saved to '%s'", plot_path.name)
         fig = self.assemble_plot(data, width, height)
@@ -429,6 +431,7 @@ class Reader(BaseReader):
             .with_suffix(f".multiplot_{start_str}_to_{end_str}.png")
         )
         if plot_path.exists():
+            logger.warning("Plot exists, will skip & not overwrite!")
             return None
         fig = Reader.assemble_plot(data, width, height)
         plt.savefig(plot_path)

{shepherd_data-2023.8.7.dist-info → shepherd_data-2023.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shepherd-data
-Version: 2023.8.7
+Version: 2023.9.0
 Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
 Home-page: https://pypi.org/project/shepherd-data/
 Author: Ingmar Splitt, Kai Geissdoerfer
@@ -30,13 +30,13 @@ Classifier: Operating System :: OS Independent
 Classifier: Natural Language :: English
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-Requires-Dist: shepherd-core[elf,inventory]
-Requires-Dist: click
 Requires-Dist: h5py
-Requires-Dist: matplotlib
 Requires-Dist: numpy
-Requires-Dist: pandas <2.0.0
 Requires-Dist: pyYAML
+Requires-Dist: shepherd-core[elf,inventory]
+Requires-Dist: click
+Requires-Dist: matplotlib
+Requires-Dist: pandas
 Requires-Dist: scipy
 Requires-Dist: tqdm
 Provides-Extra: dev
@@ -46,86 +46,34 @@ Provides-Extra: test
 Requires-Dist: shepherd-core[test] ; extra == 'test'
 Requires-Dist: pytest-click ; extra == 'test'
 
-# Shepherd - Data
+# Data Module
 
 [![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
 [![Pytest](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml/badge.svg)](https://github.com/orgua/shepherd-datalib/actions/workflows/python-app.yml)
 [![CodeStyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-This Python Module eases the handling of hdf5-recordings used by the [shepherd](https://github.com/orgua/shepherd)-testbed. Users can read, validate and create files and also extract, down-sample and plot information.
-
----
+**Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
 
-**Main Project**: [https://github.com/orgua/shepherd](https://github.com/orgua/shepherd)
+**Source Code**: <https://github.com/orgua/shepherd-datalib>
 
-**Source Code**: [https://github.com/orgua/shepherd-datalib](https://github.com/orgua/shepherd-datalib)
+**Main Project**: <https://github.com/orgua/shepherd>
 
 ---
 
+This Python Module eases the handling of hdf5-recordings used by the [shepherd](https://github.com/orgua/shepherd)-testbed. Users can read, validate and create files and also extract, down-sample and plot information.
+
 ## Installation
 
 ### PIP - Online
 
 ```shell
-pip3 install shepherd-data
-```
-
-### PIP - Offline
-
-- clone repository
-- navigate shell into directory
-- install local module
-
-```shell
-git clone https://github.com/orgua/shepherd-datalib
-cd .\shepherd-datalib
-
-pip3 install ./
+pip3 install shepherd-data -U
 ```
 
-## Development
-
-### PipEnv
-
-- clone repository
-- navigate shell into directory
-- install environment
-- activate shell
-- optional
-  - update pipenv (optional)
-  - add special packages with `-dev` switch
-
+For bleeding-edge-features or dev-work it is possible to install directly from GitHub-Sources (here `dev`-branch):
 
 ```Shell
-git clone https://github.com/orgua/shepherd-datalib
-cd .\shepherd-datalib
-
-pipenv install --dev
-pipenv shell
-
-pipenv update
-pipenv install --dev pytest
-```
-
-### running Testbench
-
-- run pytest
-
-```shell
-pytest
-```
-
-### code coverage (with pytest)
-
-- run coverage
-- check results (in browser `./htmlcov/index.html`)
-
-```shell
-coverage run -m pytest
-
-coverage html
-# or simpler
-coverage report
+pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_data -U
 ```
 
 ## Programming Interface

{shepherd_data-2023.8.7.dist-info → shepherd_data-2023.9.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
-shepherd_data/__init__.py,sha256=2Lye8hg_rONj1Sen7AX0mEe09O2qTB9AmJJj7uudTVI,256
-shepherd_data/cli.py,sha256=FmxBH2CO4xlSzZ6aOp9ljg5b_Y3Ekmz4_seOMVOjgrI,10914
+shepherd_data/__init__.py,sha256=lj8aGFbKv9eiDbpFejyFz7KGQrJtJ_XrgdumbrwZ0q4,256
+shepherd_data/cli.py,sha256=Cj9j_kUoDqkvs6CcV6x_iev48bdmzGsn9HkpVShrsyg,10930
 shepherd_data/debug_resampler.py,sha256=Y4uxSXqWKoyyJ1H6TY1vZKe0pWMK_mjQY0xBr7dC_f4,983
 shepherd_data/ivonne.py,sha256=Y0vwVVwDZCEEy4fHUPMluAN1Wh63TdbkaHH_pGVOtqg,11683
 shepherd_data/mppt.py,sha256=diAHzbb4QlW3ceoRQ20OWMpEcf3-hcnk_rH0BwLB0vU,3599
-shepherd_data/reader.py,sha256=Ipi3SkJxQk1YeRTaiBrhivyxqHuAGfauUkMqPZ56wFU,16657
+shepherd_data/reader.py,sha256=eLk4XrA-tww_2fYHSdQzhn9DPrnFs7LCYMyVGxeC6_Q,16843
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/conftest.py,sha256=BCtm2TbfVf85_AsGOUZLXd6TquicWRMgBq2-q5UA2UM,985
 tests/test_cli.py,sha256=Lha58ILt4inAIX562HeMYonACuWnK7rtAtia-ALIGP8,173
@@ -14,9 +14,9 @@ tests/test_cli_validate.py,sha256=f501lSUiZZ-60Xnb7Nz2Z8cUZGTUfJ6opEcRIDEXTOU,40
 tests/test_examples.py,sha256=e_uc5h_I4wwJnIWuh-PjpSSTICkYemI831iqhxIy_R0,576
 tests/test_ivonne.py,sha256=cIMtpx7tjRFxL9hpr5OPPgroGLzRZxGC4x9Y7vWgze8,1367
 tests/test_reader.py,sha256=Xt__Khgldv8klZJ3OQcMZevC6_3gPH2_TpOorq2ytNI,90
-shepherd_data-2023.8.7.dist-info/METADATA,sha256=lMIw7rl78mzNhgslh-ib6kGqFog_0tu5-wfQV1NlWD0,10391
-shepherd_data-2023.8.7.dist-info/WHEEL,sha256=5sUXSg9e4bi7lTLOHcm6QEYwO5TIF1TNbTSVFVjcJcc,92
-shepherd_data-2023.8.7.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
-shepherd_data-2023.8.7.dist-info/top_level.txt,sha256=Bk61YO7iYS43TSWtwdSKb2moGBvJqJIYfGaZsQsv09M,20
-shepherd_data-2023.8.7.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-shepherd_data-2023.8.7.dist-info/RECORD,,
+shepherd_data-2023.9.0.dist-info/METADATA,sha256=NylPV-B2W3MUtDsGvxuoQ_Tqw9y-WC3ndW7vTEgIN98,9800
+shepherd_data-2023.9.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+shepherd_data-2023.9.0.dist-info/entry_points.txt,sha256=6PBfY36A1xNOdzLiz-Qoukya_UzFZAwOapwmRNnPeZ8,56
+shepherd_data-2023.9.0.dist-info/top_level.txt,sha256=Bk61YO7iYS43TSWtwdSKb2moGBvJqJIYfGaZsQsv09M,20
+shepherd_data-2023.9.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+shepherd_data-2023.9.0.dist-info/RECORD,,

{shepherd_data-2023.8.7.dist-info → shepherd_data-2023.9.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.1)
+Generator: bdist_wheel (0.41.2)
 Root-Is-Purelib: true
 Tag: py3-none-any