shepherd-data 2023.8.8__tar.gz → 2023.9.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/PKG-INFO +22 -63
  2. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/README.md +8 -62
  3. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/setup.cfg +6 -6
  4. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data/__init__.py +1 -1
  5. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data/cli.py +2 -2
  6. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data/reader.py +3 -0
  7. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data.egg-info/PKG-INFO +22 -63
  8. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data.egg-info/requires.txt +4 -4
  9. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/pyproject.toml +0 -0
  10. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data/debug_resampler.py +0 -0
  11. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data/ivonne.py +0 -0
  12. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data/mppt.py +0 -0
  13. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data.egg-info/SOURCES.txt +0 -0
  14. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data.egg-info/dependency_links.txt +0 -0
  15. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data.egg-info/entry_points.txt +0 -0
  16. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data.egg-info/top_level.txt +0 -0
  17. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/shepherd_data.egg-info/zip-safe +0 -0
  18. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/__init__.py +0 -0
  19. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/conftest.py +0 -0
  20. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_cli.py +0 -0
  21. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_cli_downsample.py +0 -0
  22. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_cli_extract.py +0 -0
  23. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_cli_plot.py +0 -0
  24. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_cli_validate.py +0 -0
  25. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_examples.py +0 -0
  26. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_ivonne.py +0 -0
  27. {shepherd_data-2023.8.8 → shepherd_data-2023.9.0}/tests/test_reader.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: shepherd_data
3
- Version: 2023.8.8
3
+ Version: 2023.9.0
4
4
  Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
5
5
  Home-page: https://pypi.org/project/shepherd-data/
6
6
  Author: Ingmar Splitt, Kai Geissdoerfer
@@ -30,25 +30,38 @@ Classifier: Operating System :: OS Independent
30
30
  Classifier: Natural Language :: English
31
31
  Requires-Python: >=3.7
32
32
  Description-Content-Type: text/markdown
33
+ Requires-Dist: h5py
34
+ Requires-Dist: numpy
35
+ Requires-Dist: pyYAML
36
+ Requires-Dist: shepherd-core[elf,inventory]
37
+ Requires-Dist: click
38
+ Requires-Dist: matplotlib
39
+ Requires-Dist: pandas
40
+ Requires-Dist: scipy
41
+ Requires-Dist: tqdm
33
42
  Provides-Extra: dev
43
+ Requires-Dist: shepherd-core[dev]; extra == "dev"
44
+ Requires-Dist: pandas-stubs; extra == "dev"
34
45
  Provides-Extra: test
46
+ Requires-Dist: shepherd-core[test]; extra == "test"
47
+ Requires-Dist: pytest-click; extra == "test"
35
48
 
36
- # Shepherd - Data
49
+ # Data Module
37
50
 
38
51
  [![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
39
52
  [![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)
40
53
  [![CodeStyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
41
54
 
42
- 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.
43
-
44
- ---
55
+ **Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
45
56
 
46
- **Main Project**: [https://github.com/orgua/shepherd](https://github.com/orgua/shepherd)
57
+ **Source Code**: <https://github.com/orgua/shepherd-datalib>
47
58
 
48
- **Source Code**: [https://github.com/orgua/shepherd-datalib](https://github.com/orgua/shepherd-datalib)
59
+ **Main Project**: <https://github.com/orgua/shepherd>
49
60
 
50
61
  ---
51
62
 
63
+ 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.
64
+
52
65
  ## Installation
53
66
 
54
67
  ### PIP - Online
@@ -57,64 +70,10 @@ This Python Module eases the handling of hdf5-recordings used by the [shepherd](
57
70
  pip3 install shepherd-data -U
58
71
  ```
59
72
 
60
- ### PIP - Offline
61
-
62
- - clone repository
63
- - navigate shell into directory
64
- - install local module
65
-
66
- ```shell
67
- git clone https://github.com/orgua/shepherd-datalib
68
- cd .\shepherd-datalib
69
-
70
- pip3 install ./ -U
71
- ```
72
-
73
- ## Development
74
-
75
- ### PipEnv
76
-
77
- - clone repository
78
- - navigate shell into directory
79
- - install environment
80
- - activate shell
81
- - optional
82
- - update pipenv (optional)
83
- - add special packages with `-dev` switch
84
-
73
+ For bleeding-edge-features or dev-work it is possible to install directly from GitHub-Sources (here `dev`-branch):
85
74
 
86
75
  ```Shell
87
- git clone https://github.com/orgua/shepherd-datalib
88
- cd .\shepherd-datalib
89
-
90
- pipenv install --dev
91
- pipenv shell
92
-
93
- pipenv update
94
- pipenv install --dev pytest
95
- ```
96
-
97
- ### running Testbench
98
-
99
- - run pytest
100
- - alternative:
101
-
102
- ```shell
103
- pytest
104
- pytest --stepwise
105
- ```
106
-
107
- ### code coverage (with pytest)
108
-
109
- - run coverage
110
- - check results (in browser `./htmlcov/index.html`)
111
-
112
- ```shell
113
- coverage run -m pytest
114
-
115
- coverage html
116
- # or simpler
117
- coverage report
76
+ pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_data -U
118
77
  ```
119
78
 
120
79
  ## Programming Interface
@@ -1,19 +1,19 @@
1
- # Shepherd - Data
1
+ # Data Module
2
2
 
3
3
  [![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
4
4
  [![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)
5
5
  [![CodeStyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
6
6
 
7
- 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.
8
-
9
- ---
7
+ **Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
10
8
 
11
- **Main Project**: [https://github.com/orgua/shepherd](https://github.com/orgua/shepherd)
9
+ **Source Code**: <https://github.com/orgua/shepherd-datalib>
12
10
 
13
- **Source Code**: [https://github.com/orgua/shepherd-datalib](https://github.com/orgua/shepherd-datalib)
11
+ **Main Project**: <https://github.com/orgua/shepherd>
14
12
 
15
13
  ---
16
14
 
15
+ 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.
16
+
17
17
  ## Installation
18
18
 
19
19
  ### PIP - Online
@@ -22,64 +22,10 @@ This Python Module eases the handling of hdf5-recordings used by the [shepherd](
22
22
  pip3 install shepherd-data -U
23
23
  ```
24
24
 
25
- ### PIP - Offline
26
-
27
- - clone repository
28
- - navigate shell into directory
29
- - install local module
30
-
31
- ```shell
32
- git clone https://github.com/orgua/shepherd-datalib
33
- cd .\shepherd-datalib
34
-
35
- pip3 install ./ -U
36
- ```
37
-
38
- ## Development
39
-
40
- ### PipEnv
41
-
42
- - clone repository
43
- - navigate shell into directory
44
- - install environment
45
- - activate shell
46
- - optional
47
- - update pipenv (optional)
48
- - add special packages with `-dev` switch
49
-
25
+ For bleeding-edge-features or dev-work it is possible to install directly from GitHub-Sources (here `dev`-branch):
50
26
 
51
27
  ```Shell
52
- git clone https://github.com/orgua/shepherd-datalib
53
- cd .\shepherd-datalib
54
-
55
- pipenv install --dev
56
- pipenv shell
57
-
58
- pipenv update
59
- pipenv install --dev pytest
60
- ```
61
-
62
- ### running Testbench
63
-
64
- - run pytest
65
- - alternative:
66
-
67
- ```shell
68
- pytest
69
- pytest --stepwise
70
- ```
71
-
72
- ### code coverage (with pytest)
73
-
74
- - run coverage
75
- - check results (in browser `./htmlcov/index.html`)
76
-
77
- ```shell
78
- coverage run -m pytest
79
-
80
- coverage html
81
- # or simpler
82
- coverage report
28
+ pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_data -U
83
29
  ```
84
30
 
85
31
  ## Programming Interface
@@ -37,15 +37,15 @@ zip_safe = True
37
37
  include_package_data = True
38
38
  python_requires = >= 3.7
39
39
  install_requires =
40
- shepherd-core[elf,inventory]
41
- click
42
40
  h5py
43
- matplotlib # full-version
44
41
  numpy
45
- pandas<2.0.0 # full-version
46
42
  pyYAML
47
- scipy # full-version
48
- tqdm # full-version
43
+ shepherd-core[elf,inventory]
44
+ click
45
+ matplotlib
46
+ pandas # V2 is OK
47
+ scipy
48
+ tqdm
49
49
 
50
50
  [options.extras_require]
51
51
  dev =
@@ -9,7 +9,7 @@ from shepherd_core import BaseWriter as Writer
9
9
 
10
10
  from .reader import Reader
11
11
 
12
- __version__ = "2023.8.8"
12
+ __version__ = "2023.9.0"
13
13
 
14
14
  __all__ = [
15
15
  "Reader",
@@ -29,13 +29,13 @@ def path_to_flist(data_path: Path) -> List[Path]:
29
29
  """
30
30
  data_path = Path(data_path).resolve()
31
31
  h5files = []
32
- if data_path.is_file() and data_path.suffix == ".h5":
32
+ if data_path.is_file() and data_path.suffix.lower() == ".h5":
33
33
  h5files.append(data_path)
34
34
  elif data_path.is_dir():
35
35
  flist = os.listdir(data_path)
36
36
  for file in flist:
37
37
  fpath = data_path / str(file)
38
- if not fpath.is_file() or ".h5" != fpath.suffix:
38
+ if not fpath.is_file() or ".h5" != fpath.suffix.lower():
39
39
  continue
40
40
  h5files.append(fpath)
41
41
  return h5files
@@ -14,6 +14,7 @@ from matplotlib import pyplot as plt
14
14
  from tqdm import trange
15
15
 
16
16
  from shepherd_core import BaseReader
17
+ from shepherd_core.logger import logger
17
18
 
18
19
  # import samplerate # TODO: just a test-fn for now
19
20
 
@@ -402,6 +403,7 @@ class Reader(BaseReader):
402
403
  f".plot_{start_str}_to_{end_str}.png"
403
404
  )
404
405
  if plot_path.exists():
406
+ self._logger.warning("Plot exists, will skip & not overwrite!")
405
407
  return
406
408
  self._logger.info("Plot generated, will be saved to '%s'", plot_path.name)
407
409
  fig = self.assemble_plot(data, width, height)
@@ -429,6 +431,7 @@ class Reader(BaseReader):
429
431
  .with_suffix(f".multiplot_{start_str}_to_{end_str}.png")
430
432
  )
431
433
  if plot_path.exists():
434
+ logger.warning("Plot exists, will skip & not overwrite!")
432
435
  return None
433
436
  fig = Reader.assemble_plot(data, width, height)
434
437
  plt.savefig(plot_path)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: shepherd-data
3
- Version: 2023.8.8
3
+ Version: 2023.9.0
4
4
  Summary: Programming- and CLI-Interface for the h5-dataformat of the Shepherd-Testbed
5
5
  Home-page: https://pypi.org/project/shepherd-data/
6
6
  Author: Ingmar Splitt, Kai Geissdoerfer
@@ -30,25 +30,38 @@ Classifier: Operating System :: OS Independent
30
30
  Classifier: Natural Language :: English
31
31
  Requires-Python: >=3.7
32
32
  Description-Content-Type: text/markdown
33
+ Requires-Dist: h5py
34
+ Requires-Dist: numpy
35
+ Requires-Dist: pyYAML
36
+ Requires-Dist: shepherd-core[elf,inventory]
37
+ Requires-Dist: click
38
+ Requires-Dist: matplotlib
39
+ Requires-Dist: pandas
40
+ Requires-Dist: scipy
41
+ Requires-Dist: tqdm
33
42
  Provides-Extra: dev
43
+ Requires-Dist: shepherd-core[dev]; extra == "dev"
44
+ Requires-Dist: pandas-stubs; extra == "dev"
34
45
  Provides-Extra: test
46
+ Requires-Dist: shepherd-core[test]; extra == "test"
47
+ Requires-Dist: pytest-click; extra == "test"
35
48
 
36
- # Shepherd - Data
49
+ # Data Module
37
50
 
38
51
  [![PyPiVersion](https://img.shields.io/pypi/v/shepherd_data.svg)](https://pypi.org/project/shepherd_data)
39
52
  [![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)
40
53
  [![CodeStyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
41
54
 
42
- 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.
43
-
44
- ---
55
+ **Documentation**: <https://orgua.github.io/shepherd/external/shepherd_data.html>
45
56
 
46
- **Main Project**: [https://github.com/orgua/shepherd](https://github.com/orgua/shepherd)
57
+ **Source Code**: <https://github.com/orgua/shepherd-datalib>
47
58
 
48
- **Source Code**: [https://github.com/orgua/shepherd-datalib](https://github.com/orgua/shepherd-datalib)
59
+ **Main Project**: <https://github.com/orgua/shepherd>
49
60
 
50
61
  ---
51
62
 
63
+ 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.
64
+
52
65
  ## Installation
53
66
 
54
67
  ### PIP - Online
@@ -57,64 +70,10 @@ This Python Module eases the handling of hdf5-recordings used by the [shepherd](
57
70
  pip3 install shepherd-data -U
58
71
  ```
59
72
 
60
- ### PIP - Offline
61
-
62
- - clone repository
63
- - navigate shell into directory
64
- - install local module
65
-
66
- ```shell
67
- git clone https://github.com/orgua/shepherd-datalib
68
- cd .\shepherd-datalib
69
-
70
- pip3 install ./ -U
71
- ```
72
-
73
- ## Development
74
-
75
- ### PipEnv
76
-
77
- - clone repository
78
- - navigate shell into directory
79
- - install environment
80
- - activate shell
81
- - optional
82
- - update pipenv (optional)
83
- - add special packages with `-dev` switch
84
-
73
+ For bleeding-edge-features or dev-work it is possible to install directly from GitHub-Sources (here `dev`-branch):
85
74
 
86
75
  ```Shell
87
- git clone https://github.com/orgua/shepherd-datalib
88
- cd .\shepherd-datalib
89
-
90
- pipenv install --dev
91
- pipenv shell
92
-
93
- pipenv update
94
- pipenv install --dev pytest
95
- ```
96
-
97
- ### running Testbench
98
-
99
- - run pytest
100
- - alternative:
101
-
102
- ```shell
103
- pytest
104
- pytest --stepwise
105
- ```
106
-
107
- ### code coverage (with pytest)
108
-
109
- - run coverage
110
- - check results (in browser `./htmlcov/index.html`)
111
-
112
- ```shell
113
- coverage run -m pytest
114
-
115
- coverage html
116
- # or simpler
117
- coverage report
76
+ pip install git+https://github.com/orgua/shepherd-datalib.git@dev#subdirectory=shepherd_data -U
118
77
  ```
119
78
 
120
79
  ## Programming Interface
@@ -1,10 +1,10 @@
1
- shepherd-core[elf,inventory]
2
- click
3
1
  h5py
4
- matplotlib
5
2
  numpy
6
- pandas<2.0.0
7
3
  pyYAML
4
+ shepherd-core[elf,inventory]
5
+ click
6
+ matplotlib
7
+ pandas
8
8
  scipy
9
9
  tqdm
10
10