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

Basic introductory material for GUIDE tutorials #707

Merged
merged 17 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
06ed4f4
Basic introductory material for GUIDE tutorials
garrettmflynn Mar 27, 2024
08874d8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 27, 2024
4cbd483
Merge branch 'main' into tutorial-base
CodyCBakerPhD Mar 27, 2024
06def87
reorganize based on feedback. add screenshots
garrettmflynn Mar 27, 2024
ed4034f
Merge branch 'tutorial-base' of https://github.com/NeurodataWithoutBo…
garrettmflynn Mar 27, 2024
3d485da
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 27, 2024
add418e
Update dataset section name
garrettmflynn Mar 27, 2024
e1e89d4
Merge branch 'tutorial-base' of https://github.com/NeurodataWithoutBo…
garrettmflynn Mar 27, 2024
1c41bab
Update dataset.rst
garrettmflynn Mar 27, 2024
b0e9303
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 27, 2024
cf36f8b
Crop dataset creation screenshot and rename to avoid numbers
garrettmflynn Mar 27, 2024
fe5eecf
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 27, 2024
a318763
Ensure both states of the dataset generation page are captured
garrettmflynn Mar 27, 2024
bf72f6a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 27, 2024
a6e5f71
Add created state screenshot
garrettmflynn Mar 27, 2024
6d23d83
Merge branch 'tutorial-base' of https://github.com/NeurodataWithoutBo…
garrettmflynn Mar 27, 2024
27c864e
Update docs/tutorials/multiple_sessions.rst
garrettmflynn Mar 28, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
*.[oa]
*~

_build
dist
out
tests/screenshots
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ The resulting files are fully compliant with the best practices expected of the
:maxdepth: 2

installation
tutorials/index
format_support
developer_guide
42 changes: 42 additions & 0 deletions docs/tutorials/dataset.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
The Tutorial Dataset
=======================================

Our tutorials focus on converting extracellular electrophysiology data in the SpikeGLX and Phy formats.
To get you started as quickly as possible, we’ve created a way to generate this Neuropixel-like dataset at the click of a button!

.. note::
The **SpikeGLX** data format stores electrophysiology recordings
The **Phy** data format stores spike sorting results.
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved

Navigate to the **Settings** page using the main sidebar and initiate the dataset generation
CodyCBakerPhD marked this conversation as resolved.
Show resolved Hide resolved
by pressing the Generate button in the top-right corner.
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved

This dataset will be organized in the following way:

.. code-block:: bash

dataset/
├── mouse1/
│ ├── mouse1_Session1/
│ │ ├── mouse1_Session1_g0/
│ │ │ ├── mouse1_Session1_g0_imec/
│ │ │ │ ├── mouse1_Session1_g0_imec.ap.bin
│ │ │ │ ├── mouse1_Session1_g0_imec.ap.meta
│ │ │ │ ├── mouse1_Session1_g0_imec.lf.bin
│ │ │ │ └── mouse1_Session1_g0_imec.lf.meta
│ │ │ └── mouse1_Session1_phy/
│ │ │
│ │ └── mouse1_Session2/
│ │ ├── mouse1_Session2_g0/
│ │ │ ...
│ │ └── mouse1_Session2_phy/
│ │ ...
│ │
└── mouse2/
├── mouse2_Session1/
│ ...
└── mouse2_Session2/
...

Now you’re ready to start your first conversion using the NWB GUIDE!
3 changes: 3 additions & 0 deletions docs/tutorials/dataset_publication.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Dataset Publication
=======================================
Coming soon...
21 changes: 21 additions & 0 deletions docs/tutorials/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Tutorials
=======================================
The NWB Graphical User Interface for Data Entry (GUIDE) is a desktop tool for converting neurophysiological data
to the Neurodata Without Borders (NWB) format and uploading to the DANDI Archive. In these tutorials, we detail this
process from initial setup to final upload.

.. toctree::
:maxdepth: 2

single_session
multiple_sessions
dataset_publication
next_steps


**Before you begin, you'll need to generate the tutorial dataset** using the instructions defined here.

.. toctree::
:maxdepth: 2
CodyCBakerPhD marked this conversation as resolved.
Show resolved Hide resolved

dataset
3 changes: 3 additions & 0 deletions docs/tutorials/multiple_sessions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Handling Multiple Sessions
=======================================
garrettmflynn marked this conversation as resolved.
Show resolved Hide resolved
Coming soon...
3 changes: 3 additions & 0 deletions docs/tutorials/next_steps.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
What's Next?
=======================================
Coming soon...
3 changes: 3 additions & 0 deletions docs/tutorials/single_session.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Converting a Single Session
=======================================
Coming soon...
Loading