Update README.md #85
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| #  | ||
|
|
||
|
|
||
| [](https://unfoldtoolbox.github.io/UnfoldMakie.jl/dev) | ||
| [](https://github.com/unfoldtoolbox/UnfoldMakie.jl/actions) | ||
|
|
@@ -22,33 +23,96 @@ The supportet visualizations are: | |
| - Topoplot series | ||
| - Parallel Coordinates Plot | ||
|
|
||
| <details> | ||
| <summary>Click to see example plots</summary> | ||
|
|
||
|
There was a problem hiding this comment. we need to update this plot @vladdez do we have a more exciting and more importantly, higher resolution plot? We also shoudnt hide it, it is a plotting library. Maybe we can shrink it, and not show all plot types? There was a problem hiding this comment. Shrinking it would be nice, I hid it cause it was taking up a looooooot of space |
||
|  | ||
|
|
||
| </details> | ||
|
|
||
| ## Discover the Unfold-Family & Friends | ||
|
|
||
| <details> | ||
| <summary>Click to expand</summary> | ||
|
|
||
| | | Link to Toolbox| | ||
| |---|---| | ||
| Regression modeling of EEG data! | ](https://github.com/unfoldtoolbox/Unfold.jl/assets/10183650/757575d0-aeb9-4d94-a5f8-832f13dcd2dd) | ||
| Simulate your own EEG data! | ](https://github.com/unfoldtoolbox/Unfold.jl/assets/10183650/328a4ccd-8860-4b13-9fb6-64d3df9e2091) | ||
| Easily load BIDS formatted EEG data! |](https://github.com/unfoldtoolbox/Unfold.jl/assets/10183650/2956ca20-9c48-4066-9e50-c5d25c50f0d1) | ||
| Decoding of EEG data made easy | ](https://github.com/unfoldtoolbox/Unfold.jl/assets/10183650/802002c0-a1f2-4236-9123-562684d39dcf) | ||
| Statistically test your models! | ](https://github.com/unfoldtoolbox/Unfold.jl/assets/10183650/4c8f2b5a-ea84-4ee3-82f9-01ef05b4f4c6) | ||
| You are here | ](https://github.com/unfoldtoolbox/Unfold.jl/assets/10183650/37af35a0-c99c-4374-827b-40fc37de7c2b) | ||
| Julia interface to MNE-Python via PythonCall | [PyMNE.jl](https://github.com/beacon-biosignals/PyMNE.jl/tree/main) | ||
| </details> | ||
|
|
||
| ## Install | ||
|
|
||
| ### Installing Julia | ||
|
|
||
| <details> | ||
| <summary>Click to expand</summary> | ||
|
|
||
| The recommended way to install julia is [juliaup](https://github.com/JuliaLang/juliaup). | ||
| It allows you to, e.g., easily update Julia at a later point, but also test out alpha/beta versions etc. | ||
|
|
||
| TL:DR; If you dont want to read the explicit instructions, just copy the following command | ||
|
|
||
| #### Windows | ||
|
|
||
| AppStore -> JuliaUp, or `winget install julia -s msstore` in CMD | ||
|
|
||
| #### Mac & Linux | ||
|
|
||
| `curl -fsSL https://install.julialang.org | sh` in any shell | ||
| </details> | ||
|
|
||
| ### Installing Unfold | ||
|
|
||
| ```julia | ||
| using Pkg | ||
| Pkg.add("UnfoldMakie") | ||
| ``` | ||
|
|
||
| ## Quickstart | ||
|
|
||
| ```julia | ||
| using UnfoldMakie | ||
| using CairoMakie | ||
|
|
||
| # TBA | ||
| ``` | ||
|
|
||
| ## Contributions | ||
|
|
||
| Contributions are very welcome. These could be typos, bugreports, feature-requests, speed-optimization, new solvers, better code, better documentation. | ||
|
|
||
| ### How-to Contribute | ||
|
|
||
| You are very welcome to raise issues and start pull requests! | ||
|
|
||
| ### Adding Documentation | ||
|
|
||
| 1. We recommend to write a Literate.jl document and place it in `docs/_literate/FOLDER/FILENAME.jl` with `FOLDER` being `HowTo`, `Explanation`, `Tutorial` or `Reference` ([recommended reading on the 4 categories](https://documentation.divio.com/)). | ||
| 2. Literate.jl converts the `.jl` file to a `.md` automatically and places it in `doc/src/_literate/FILENAME.jl`. | ||
| 3. Edit [make.jl](https://github.com/unfoldtoolbox/Unfold.jl/blob/main/docs/make.jl) with a reference to `doc/src/_literate/FILENAME.jl` | ||
|
|
||
| ## Citation | ||
|
|
||
| If you make use of theses visualizations, please cite: | ||
|
|
||
| [](https://doi.org/10.5281/zenodo.6531996) | ||
|
|
||
| ## Contributors (alphabetically) | ||
|
|
||
|
There was a problem hiding this comment. So far only because I updated the readme, no? Didn't think that would justify being on the list 👀 |
||
| - **Daniel Baumgartner** | ||
| - **Benedikt Ehinger** | ||
| - **Sören Döring** | ||
| - **Niklas Gärtner** | ||
| - **Vladimir Mikheev** | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| Funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) – project ID 251654672 – TRR 161 (project D05) | ||
|
|
||
| Funded by Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under Germany´s Excellence Strategy – EXC 2075 – 390740016 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Circular topoplots are missing
also the text above is suboptimal, we should remove the lines
The toolbox requires a Makie-Backend to be loaded, e.g.
using CairoMakieSome plotting functions require data-frames, with fields like
:estimateor:time.Or at least send them down to the quick start or something