Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge Doc sprint2212 #402

Merged
merged 37 commits into from
Dec 23, 2022
Merged

Merge Doc sprint2212 #402

merged 37 commits into from
Dec 23, 2022

Conversation

tensionhead
Copy link
Contributor

  • selections
  • welch's method
  • new theme: sphinx-book-theme

tensionhead and others added 30 commits November 25, 2022 15:37
- added a legend and changed to freqanalysis

On branch doc-sprint2212
Changes to be committed:
	modified:   doc/source/user/work-flow.mmd
- better png

Changes to be committed:
	deleted:    doc/source/user/WorkFlow.png
	modified:   doc/source/user/concepts.rst
	new file:   doc/source/user/workFlow.png
Changes to be committed:
	modified:   doc/source/README.rst
	modified:   doc/source/quickstart/quickstart.rst
	modified:   doc/source/user/concepts.rst
	new file:   doc/source/user/selectdata.rst
- this completes the draft for #382

Changes to be committed:
	new file:   doc/source/_static/select_example1.png
	new file:   doc/source/_static/select_example2.png
	new file:   doc/source/scripts/select_example.py
	modified:   doc/source/user/selectdata.rst
Changes to be committed:
	modified:   doc/source/user/data_basics.rst
Changes to be committed:
	modified:   doc/source/user/selectdata.rst
Changes to be committed:
	modified:   doc/source/quickstart/quickstart.rst
Changes to be committed:
	modified:   doc/source/conf.py
	modified:   doc/source/user/concepts.rst
Changes to be committed:
	modified:   doc/source/README.rst
	modified:   doc/source/user/concepts.rst
Changes to be committed:
	new file:   doc/source/user/parallel.rst
Changes to be committed:
	modified:   doc/source/quickstart/quickstart.rst
	modified:   doc/source/user/selectdata.rst
Changes to be committed:
	new file:   doc/source/_static/synth_data_spec.png
	renamed:    doc/source/user/workFlow.png -> doc/source/_static/workFlow.png
	modified:   doc/source/scripts/synth_data1.py
	modified:   doc/source/user/concepts.rst
	modified:   doc/source/user/synth_data.rst
	deleted:    doc/source/user/synth_data_plot.png
	deleted:    doc/source/user/synth_data_spec.png
… and welch

Changes to be committed:
	modified:   doc/source/README.rst
	new file:   doc/source/tutorials/freqanalysis.rst
	modified:   doc/source/tutorials/resampling.rst
- now we have a nice sidebar
- uncluttered user API

Changes to be committed:
	modified:   doc/source/README.rst
	modified:   doc/source/conf.py
	modified:   doc/source/setup.rst
	modified:   doc/source/tutorials/resampling.rst
	modified:   doc/source/user/parallel.rst
	modified:   doc/source/user/user_api.rst
	modified:   poetry.lock
	modified:   pyproject.toml
	modified:   syncopy/statistics/timelockanalysis.py
- also activated graphviz extension for inheritance graph rendering

Changes to be committed:
	modified:   doc/source/conf.py
	modified:   poetry.lock
	modified:   pyproject.toml

Generate 10 seconds of white noise, sampled at 1000 Hz:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great that we have at least one example now @dfsp-spirit :)

@codecov
Copy link

codecov bot commented Dec 23, 2022

Codecov Report

Base: 68.62% // Head: 68.66% // Increases project coverage by +0.04% 🎉

Coverage data is based on head (3f24615) compared to base (1b0176b).
Patch has no changes to coverable lines.

❗ Current head 3f24615 differs from pull request most recent head d5209dc. Consider uploading reports for the commit d5209dc to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #402      +/-   ##
==========================================
+ Coverage   68.62%   68.66%   +0.04%     
==========================================
  Files          79       79              
  Lines        9564     9588      +24     
  Branches     1951     1954       +3     
==========================================
+ Hits         6563     6584      +21     
- Misses       2500     2503       +3     
  Partials      501      501              
Impacted Files Coverage Δ
syncopy/specest/freqanalysis.py 68.99% <ø> (ø)
syncopy/statistics/timelockanalysis.py 67.30% <ø> (+0.96%) ⬆️
syncopy/datatype/methods/definetrial.py 82.43% <0.00%> (-1.47%) ⬇️
syncopy/tests/conftest.py 52.63% <0.00%> (-1.43%) ⬇️
syncopy/plotting/_helpers.py 84.50% <0.00%> (-1.21%) ⬇️
syncopy/io/save_spy_container.py 70.54% <0.00%> (-0.79%) ⬇️
syncopy/tests/helpers.py 100.00% <0.00%> (ø)
syncopy/statistics/spike_psth.py 95.40% <0.00%> (+0.05%) ⬆️
syncopy/nwanalysis/AV_compRoutines.py 74.31% <0.00%> (+0.23%) ⬆️
... and 5 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

- we don't need setting manual labels
- spy.get_defaults() is redundant as any non-set parameter will be the default

Changes to be committed:
	modified:   doc/source/tutorials/welch.rst
	modified:   syncopy/specest/freqanalysis.py
Changes to be committed:
	modified:   doc/source/_static/welch_basic_power.png
	new file:   doc/source/_static/welch_raw_fft_power.png
	modified:   doc/source/tutorials/welch.rst
@tensionhead tensionhead merged commit 6b89908 into dev Dec 23, 2022
@tensionhead tensionhead mentioned this pull request Jan 2, 2023
@tensionhead tensionhead deleted the doc-sprint2212 branch January 3, 2023 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants