Skip to content

Commit 2651168

Browse files
rspwarnaarUTrspwarnaarUT
committedMar 14, 2025·
Reverse changelog order
1 parent 5b3d51a commit 2651168

File tree

1 file changed

+173
-171
lines changed

1 file changed

+173
-171
lines changed
 

‎CHANGELOG.md

+173-171
Original file line numberDiff line numberDiff line change
@@ -1,171 +1,16 @@
11
# Change Log
22

3-
## Unreleased
4-
5-
### Added
6-
* First unreleased version of ReSurfEMG, containing:
7-
- Tests,
8-
- Documentation,
9-
- Change log,
10-
- License,
11-
- README,
12-
*
13-
14-
### Changed
15-
16-
*
17-
## Release 0.0.0
18-
19-
### Added
20-
21-
* First version of this Python project to follow the Netherlands eScience Center software development guide, containing (added to this version):
22-
23-
- Code style checking,
24-
- Editorconfig,
25-
- Code of Conduct,
26-
- Contributing guidelines,
27-
- Setup configuration,
28-
- files for installation/building release (pypi, condabuild)
29-
30-
31-
## Release 0.0.4
32-
33-
### Added
34-
35-
* Fourth version of this Python project, containing (added to this version):
36-
37-
- Gating function for ECG removal,
38-
- Improve ICA for heart lead detection,
39-
- Power spectrum function in helper_functions,
40-
- Converter function for Biopac acquired data in converter_functions,
41-
- High envelope function hi_envelope in helper_functions,
42-
- Working pipeline improved (working_pipeline_pre_ml) in helper_functions,
43-
- Slices_jump_slider function produces continous sequential slices over an
44-
array of a certain legnth spaced out by a 'jump' in helper_functions.
45-
46-
## Release 0.0.5
47-
48-
### Added
49-
50-
* Fifth version of this Python project, containing (added to this version):
51-
52-
- Converter functions added to converter_functions module to take other lab formats into an array in the format our library uses
53-
- Preprocessing pipelines for any number of leads, which any subset can be chosen added to multi_lead_type module
54-
- config module added so outside users can easily point towards thier own datasets, includes a new function to make synthetic EMG data, and hash file validation function (moved from converter_functions)
55-
- In repository (technically not part of version): legacy dashboard files removed, notebooks guide added
56-
57-
## Release 0.0.6
58-
59-
### Added
60-
61-
* Sixth version of this Python project, containing (added to this version):
62-
63-
- Reading function Poly5Reader in new tmsisdk_lite module which reads Poly5-files and can produce an array in the format our library uses
64-
- Command line synthetic data creation, data pre-processing and machine learning (new module cli)
65-
- New synthetic data function in config module
66-
- New independent component analysis (ICA) functions which allow processing of any number of leads
67-
- More functions for signal analysis including clinically relevant variations of area under curve and a function (distance_matrix) that produces various mathematical distances which can be used to compare EMG and other signals e.g. ventilator or EMG
68-
69-
70-
## Release 0.0.7
71-
72-
### Added
73-
74-
* Seventh version of this Python project, containing (added to this version):
75-
76-
- Function for looking at time to peak in a curve absolute and relative i.e. times_under_curve()
77-
- Upgrade of CI to include a newer setup-conda action (v1.1.1)
78-
79-
## Release 0.0.8
80-
81-
### Added
82-
83-
* Eight version of this Python project, containing (added to this version):
84-
85-
- Improved function at time to peak in a curve absolute and relative i.e. times_under_curve()
86-
- Function for psuedoslope of take-off i.e. helper_functions.pseudoslope()
87-
- Upgrade of setup.py to pin mne/mne-base, skikit-learn version, other setup file changes
88-
89-
90-
## Release 0.0.9
91-
92-
### Added
93-
94-
* Ninth version of this Python project, containing (added to this version):
95-
96-
- Improved function for entropy in helper_functions module
97-
- Variability over array function (variability_maker) in helper_functions module
98-
- Additional command line functionality to convert certain csv files into files that can be processing in the ReSurfEMG-Dashboard.
99-
- Testing matrix to include Python 3.9
100-
101-
## Release 0.1.0
102-
103-
104-
* Tenth version, first major revision/version:
105-
106-
- Switch of all environments and functionality to run on Python 3.9
107-
- Installation possibility via mamba added (preffered)
108-
- Revision of some notebooks to allow processing of numpy array files directly
109-
- Fixed lack of tkinter in environment yaml
110-
111-
112-
## Release 0.1.2
113-
114-
115-
* Identical to tenth version, first major revision/version:
116-
117-
- created due to technical problems with pypi
118-
119-
## Release 0.1.3
120-
121-
* Version 0.1.3
122-
123-
- changes in setup.py to accomodate conda package version format
124-
- changes to getting started notebook and instructions
125-
- required release now (11 October 2023) for JOSS paper
126-
127-
## Release 0.2.0
128-
129-
* Eleventh version, second major revision
130-
131-
- Refactoring of helper_functions in submodules organized per function
132-
- config
133-
- data_connector
134-
- helper_functions
135-
- machine_learning
136-
- postprocessing
137-
- preprocessing
138-
- Refactor tests accordingly
139-
140-
141-
## Release 0.2.1
142-
143-
* Fix release 0.2.0
144-
145-
- Release 0.2.0 was a refactoring of the code base, but the newly
146-
created submodules were not included in the builds. This is now fixed.
147-
- Small adaptations to config.simulate_ventilator_with_occlusions to
148-
simulate more realistic Pocc manoeuvres.
149-
150-
## Release 0.3.0
151-
152-
* Major revision
153-
154-
- Conversion from setup.py build to pyproject.toml build
155-
- Discontinue Conda package releases
156-
- Include Python 3.10 and 3.11 support
157-
- Introduction of new functions:
158-
- postprocessing.baseline: Moving baseline, Slopesum baseline
159-
- postprocessing.event_detection: On-/Offset detection using baseline crossing, and maximum slope extrapolation.
160-
161-
## Release 0.3.1
3+
## Release 1.0.2
4+
* Patch
5+
- Move ReSurfEMG repo from https://github.com/ReSurfEMG/ReSurfEMG/ to https://github.com/resurfemg-org/ReSurfEMG/
1626

163-
* Minor revision
164-
- Bug fixes in:
165-
- postprocessing.event_detection: On-/Offset detection using baseline crossing, and maximum slope extrapolation.
7+
## Release 1.0.1
8+
* Patch
9+
- Fix: config file generation from template showed unexpected behaviour in overwriting existing config files and failing when not_pushed did not exist.
10+
- postprocessing.features methods time_to_peak and pseudo_slope methods smoothed by default. Changed to smoothing on smooth=True
11+
- Add subpackages and modules to init files for smoother imports
16612

16713
## Release 1.0.0
168-
16914
* Major revision
17015
- Refactor ReSurfEMG library
17116
- cli
@@ -325,12 +170,169 @@
325170
- --> legacy.calc_open_sampent
326171
- --> legacy.entropy_maker
327172

328-
## Release 1.0.1
329-
* Patch
330-
- Fix: config file generation from template showed unexpected behaviour in overwriting existing config files and failing when not_pushed did not exist.
331-
- postprocessing.features methods time_to_peak and pseudo_slope methods smoothed by default. Changed to smoothing on smooth=True
332-
- Add subpackages and modules to init files for smoother imports
173+
## Release 0.3.1
174+
175+
* Minor revision
176+
- Bug fixes in:
177+
- postprocessing.event_detection: On-/Offset detection using baseline crossing, and maximum slope extrapolation.
178+
179+
180+
## Release 0.3.0
181+
182+
* Major revision
183+
184+
- Conversion from setup.py build to pyproject.toml build
185+
- Discontinue Conda package releases
186+
- Include Python 3.10 and 3.11 support
187+
- Introduction of new functions:
188+
- postprocessing.baseline: Moving baseline, Slopesum baseline
189+
- postprocessing.event_detection: On-/Offset detection using baseline crossing, and maximum slope extrapolation.
190+
191+
## Release 0.2.1
192+
193+
* Fix release 0.2.0
194+
195+
- Release 0.2.0 was a refactoring of the code base, but the newly
196+
created submodules were not included in the builds. This is now fixed.
197+
- Small adaptations to config.simulate_ventilator_with_occlusions to
198+
simulate more realistic Pocc manoeuvres.
199+
200+
201+
## Release 0.2.0
202+
203+
* Eleventh version, second major revision
204+
205+
- Refactoring of helper_functions in submodules organized per function
206+
- config
207+
- data_connector
208+
- helper_functions
209+
- machine_learning
210+
- postprocessing
211+
- preprocessing
212+
- Refactor tests accordingly
213+
214+
## Release 0.1.3
215+
216+
* Version 0.1.3
217+
218+
- changes in setup.py to accomodate conda package version format
219+
- changes to getting started notebook and instructions
220+
- required release now (11 October 2023) for JOSS paper
221+
222+
## Release 0.1.2
223+
224+
225+
* Identical to tenth version, first major revision/version:
226+
227+
- created due to technical problems with pypi
228+
229+
## Release 0.1.0
230+
231+
232+
* Tenth version, first major revision/version:
233+
234+
- Switch of all environments and functionality to run on Python 3.9
235+
- Installation possibility via mamba added (preffered)
236+
- Revision of some notebooks to allow processing of numpy array files directly
237+
- Fixed lack of tkinter in environment yaml
238+
239+
## Release 0.0.9
240+
241+
### Added
242+
243+
* Ninth version of this Python project, containing (added to this version):
244+
245+
- Improved function for entropy in helper_functions module
246+
- Variability over array function (variability_maker) in helper_functions module
247+
- Additional command line functionality to convert certain csv files into files that can be processing in the ReSurfEMG-Dashboard.
248+
- Testing matrix to include Python 3.9
249+
250+
251+
252+
253+
## Release 0.0.8
254+
255+
### Added
256+
257+
* Eight version of this Python project, containing (added to this version):
258+
259+
- Improved function at time to peak in a curve absolute and relative i.e. times_under_curve()
260+
- Function for psuedoslope of take-off i.e. helper_functions.pseudoslope()
261+
- Upgrade of setup.py to pin mne/mne-base, skikit-learn version, other setup file changes
262+
263+
264+
## Release 0.0.7
265+
266+
### Added
267+
268+
* Seventh version of this Python project, containing (added to this version):
269+
270+
- Function for looking at time to peak in a curve absolute and relative i.e. times_under_curve()
271+
- Upgrade of CI to include a newer setup-conda action (v1.1.1)
272+
273+
## Release 0.0.6
274+
275+
### Added
276+
277+
* Sixth version of this Python project, containing (added to this version):
278+
279+
- Reading function Poly5Reader in new tmsisdk_lite module which reads Poly5-files and can produce an array in the format our library uses
280+
- Command line synthetic data creation, data pre-processing and machine learning (new module cli)
281+
- New synthetic data function in config module
282+
- New independent component analysis (ICA) functions which allow processing of any number of leads
283+
- More functions for signal analysis including clinically relevant variations of area under curve and a function (distance_matrix) that produces various mathematical distances which can be used to compare EMG and other signals e.g. ventilator or EMG
284+
285+
## Release 0.0.5
286+
287+
### Added
288+
289+
* Fifth version of this Python project, containing (added to this version):
290+
291+
- Converter functions added to converter_functions module to take other lab formats into an array in the format our library uses
292+
- Preprocessing pipelines for any number of leads, which any subset can be chosen added to multi_lead_type module
293+
- config module added so outside users can easily point towards thier own datasets, includes a new function to make synthetic EMG data, and hash file validation function (moved from converter_functions)
294+
- In repository (technically not part of version): legacy dashboard files removed, notebooks guide added
295+
296+
## Release 0.0.4
297+
298+
### Added
299+
300+
* Fourth version of this Python project, containing (added to this version):
301+
302+
- Gating function for ECG removal,
303+
- Improve ICA for heart lead detection,
304+
- Power spectrum function in helper_functions,
305+
- Converter function for Biopac acquired data in converter_functions,
306+
- High envelope function hi_envelope in helper_functions,
307+
- Working pipeline improved (working_pipeline_pre_ml) in helper_functions,
308+
- Slices_jump_slider function produces continous sequential slices over an
309+
array of a certain legnth spaced out by a 'jump' in helper_functions.
310+
311+
## Release 0.0.0
312+
313+
### Added
314+
315+
* First version of this Python project to follow the Netherlands eScience Center software development guide, containing (added to this version):
316+
317+
- Code style checking,
318+
- Editorconfig,
319+
- Code of Conduct,
320+
- Contributing guidelines,
321+
- Setup configuration,
322+
- files for installation/building release (pypi, condabuild)
323+
324+
## Unreleased
325+
326+
### Added
327+
* First unreleased version of ReSurfEMG, containing:
328+
- Tests,
329+
- Documentation,
330+
- Change log,
331+
- License,
332+
- README,
333+
*
334+
335+
### Changed
336+
337+
*
333338

334-
## Release 1.0.2
335-
* Patch
336-
- Move ReSurfEMG repo from https://github.com/ReSurfEMG/ReSurfEMG/ to https://github.com/resurfemg-org/ReSurfEMG/

0 commit comments

Comments
 (0)
Please sign in to comment.