0.2.11

[DominiqueMakowski]

Roadmap

RSP

• Add rsp_segment() (similar to ppg_segment())
• Add the cycle overlay plots to RSP
• Streamline rsp_plot() (same as ppg_plot())

PPG

• Detect PPG diastolic peaks? (between each peak and the next trough)
  • derivatives
  • model
  • PyPPG
• Add PPG amplitude calculation (reduction can be indicative of vasoconstriction in stress, cold)
• Document peak-extraction methods (PPG)
• add more PPG detectors (@peterhcharlton)
• hrv_rsa(): Add method argument to compute only one RSA signal. Do something with warning that will be thrown when using bio_process() on signals < 32 sec where it will complain that the signal is too short to compute RSA with one of these methods.

Misc

• Readme looks ugly but this is a global issue (https://github.com/orgs/community/discussions/113792)
• Fix missing figure in example of hrv() https://neuropsychology.github.io/NeuroKit/functions/hrv.html#sub-domains
• we should also do a global search of " ``...()`` " and replace by " :func:`...` " to have hyperlinks in the docs across functions
• Dynamic plots: @danibene instead of re-plotting with plotly, can't we just turn the existing matplotlib figs as interactive in htmls?
• Fix ECG Analysis bug for sample rate of 500 #593
• Complexity : Check (and eventually copy) improvements done in nolds

[DominiqueMakowski]

at least I think there's a different error now 🥲

[DerAndereJohannes]

The error is due to scipy removing support for wavelets in 1.15 which the pipeline now uses. I have updated this in #1074 .

Looking at the logs however, there is another issue. You updated the python version to 3.13 which the package ts2vg does not seem to support yet (it installs correctly on 3.12) as it resulted in an installation error (although this somehow did not stop the pipeline?

Collecting ts2vg
  Downloading ts2vg-1.2.4.tar.gz (774 kB)
     ------------------------------------- 775.0/775.0 kB 14.1 MB/s eta 0:00:00
  Installing build dependencies: started
  Installing build dependencies: finished with status 'done'
  Getting requirements to build wheel: started
  Getting requirements to build wheel: finished with status 'error'
  error: subprocess-exited-with-error
  
  Getting requirements to build wheel did not run successfully.
  exit code: 1
  
  [36 lines of output]
  Traceback (most recent call last):
    File "C:\hostedtoolcache\windows\Python\3.13.1\x64\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 389, in <module>
      main()
      ~~~~^^
    File "C:\hostedtoolcache\windows\Python\3.13.1\x64\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 373, in main
      json_out["return_val"] = hook(**hook_input["kwargs"])
                               ~~~~^^^^^^^^^^^^^^^^^^^^^^^^
    File "C:\hostedtoolcache\windows\Python\3.13.1\x64\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 143, in get_requires_for_build_wheel
      return hook(config_settings)
    File "C:\Users\runneradmin\AppData\Local\Temp\pip-build-env-75mgcoi7\overlay\Lib\site-packages\setuptools\build_meta.py", line 334, in get_requires_for_build_wheel
      return self._get_build_requires(config_settings, requirements=[])
             ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    File "C:\Users\runneradmin\AppData\Local\Temp\pip-build-env-75mgcoi7\overlay\Lib\site-packages\setuptools\build_meta.py", line 304, in _get_build_requires
      self.run_setup()
      ~~~~~~~~~~~~~~^^
    File "C:\Users\runneradmin\AppData\Local\Temp\pip-build-env-75mgcoi7\overlay\Lib\site-packages\setuptools\build_meta.py", line 320, in run_setup
      exec(code, locals())
      ~~~~^^^^^^^^^^^^^^^^
    File "<string>", line 45, in <module>
    File "<string>", line 39, in main
    File "C:\Users\runneradmin\AppData\Local\Temp\pip-build-env-75mgcoi7\overlay\Lib\site-packages\Cython\Build\Dependencies.py", line 1010, in cythonize
      module_list, module_metadata = create_extension_list(
                                     ~~~~~~~~~~~~~~~~~~~~~^
          module_list,
          ^^^^^^^^^^^^
      ...<4 lines>...
          language=language,
          ^^^^^^^^^^^^^^^^^^
          aliases=aliases)
          ^^^^^^^^^^^^^^^^
    File "C:\Users\runneradmin\AppData\Local\Temp\pip-build-env-75mgcoi7\overlay\Lib\site-packages\Cython\Build\Dependencies.py", line 845, in create_extension_list
      for file in nonempty(sorted(extended_iglob(filepattern)), "'%s' doesn't match any files" % filepattern):
                  ~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    File "C:\Users\runneradmin\AppData\Local\Temp\pip-build-env-75mgcoi7\overlay\Lib\site-packages\Cython\Build\Dependencies.py", line 117, in nonempty
      raise ValueError(error_msg)
  ValueError: 'ts2vg/graph/_base.pyx' doesn't match any files
  [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

Getting requirements to build wheel did not run successfully.
exit code: 1

See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.
Collecting pickleshare

Alternatively, we could try to get rid of the dependency altogether since it seems to be only used by one function. If we made a replication of what we need in this repo it would also save the hassle of controlling for that dependency.

$ rg -i ts2vg
ecg/ecg_findpeaks.py
1229:    # Try loading ts2vg
1231:        import ts2vg
1234:            "NeuroKit error: ecg_findpeaks(): the 'ts2vg' module is required for"
1235:            " this method to run. Please install it first (`pip install ts2vg`)."
1277:            ts2vg.NaturalVG(directed="top_to_bottom")

[DominiqueMakowski]

I'd say let's just skip that test/example for now and we'll reactive it when that dependency gets updated

[DerAndereJohannes]

Looks like the update will come very soon! CarlosBergillos/ts2vg#38

[DerAndereJohannes]

The tests and documentation are able to run again now! Though with new package updates, there are still some functions that need to be updated in our codebase and some tests now fail as our comparison packages now return different results.

I also removed the codebook from the repository since it always gets generated new with every documentation run. But it seems to break it now. I would prefer to find a way that does not include this file in the repository since it will always be out of date. I will get back to this ASAP.

[DerAndereJohannes]

Newest documentation runs on my PC. There seems to have been a timeout error in getting mne data. I will let it sit for now. Main objectives would be to look at the regressions in the unit tests