Skip to content

Commit

Permalink
Merge pull request #724 from NeurodataWithoutBorders/minor-tutorial-u…
Browse files Browse the repository at this point in the history
…pdates

Tutorial Updates based on Ryan's feedback
  • Loading branch information
CodyCBakerPhD authored Apr 3, 2024
2 parents 0169568 + 1906396 commit c3b899b
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/tutorials/dataset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Navigate to the **Settings** page using the main sidebar. Then press the **Gener

Press the Generate button on the Settings page to create the dataset.

The generated data will populate in the `~/NWB_GUIDE/test_data` directory and include a `data` folder with the original data as well as a `dataset` folder that duplicates this `data` across multiple subjects and sessions.
The generated data will populate in the ``~/NWB_GUIDE/test_data`` directory and include a ``data`` folder with the original data as well as a ``dataset`` folder that duplicates this ``data`` across multiple subjects and sessions.

.. code-block:: bash
Expand Down
12 changes: 11 additions & 1 deletion docs/tutorials/next_steps.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
What's Next?
=======================================
Coming soon...

Considerations when Using Your Own Data
---------------------------------------
When using your own data, there are a few things to consider:

Choosing an Output Location
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Choosing a good output location is important for two reasons, namely **conversion speed** and **disk space**.

1. SSDs will be much faster than HDDs. We’d recommend moving the output location to an SSD if available.
2. If you don’t have much disk space available on your main drive, we recommend changing the output location to a drive that has ample space.
15 changes: 4 additions & 11 deletions docs/tutorials/single_session.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Converting a Single Session

As a researcher, you’ve just completed an experimental session and you’d like to convert your data to NWB right away.

Upon launching the GUIDE, you'll begin on the Conversions page. If you’re opening the application for the first time, there should be no pipelines listed on this page.
Upon launching the GUIDE, you'll begin on the Convert page. If you’re opening the application for the first time, there should be no pipelines listed on this page.

.. figure:: ../assets/tutorials/home-page.png
:align: center
Expand All @@ -19,13 +19,6 @@ Project Setup

The Project Setup page will have you define two pieces of information about your pipeline: the **name** and, optionally, the **output location** for your NWB files.

.. note::
Choosing a good output location is important for two reasons, namely **conversion speed** and **disk space**.

1. SSDs will be much faster than HDDs. We’d recommend moving the output location to an SSD if available.
2. If you don’t have much disk space available on your main drive, we recommend changing the output location to a drive that has ample space.


You’ll notice that the name property has a red asterisk next to it, which identifies it as a required property.

.. figure:: ../assets/tutorials/single/info-page.png
Expand Down Expand Up @@ -59,7 +52,7 @@ Next, you’ll specify the data formats you’re working with on the Data Format
:align: center
:alt: Date Formats page

The tutorial we're working with uses the SpikeGLX and Phy formats, a common output for NeuroPixel recordings and subsequent spike sorting. To specify that your pipeline will handle these files, you’ll press the “Add Format” button.
The tutorial we're working with uses the SpikeGLX and Phy formats, a common output for Neuropixels recordings and subsequent spike sorting. To specify that your pipeline will handle these files, you’ll press the “Add Format” button.

.. figure:: ../assets/tutorials/single/format-options.png
:align: center
Expand Down Expand Up @@ -92,7 +85,7 @@ Source Data Information
^^^^^^^^^^^^^^^^^^^^^^^
On this page, specify the relevant **.bin** (Spikeglx) file and **phy** folder so that the GUIDE can find this source data to complete the conversion.

As discussed in the :doc:`Dataset Generation </tutorials/dataset>` tutorial, these can be found in the `~/NWB_GUIDE/test-data/data` directory.
As discussed in the :doc:`Dataset Generation </tutorials/dataset>` tutorial, these can be found in the ``~/NWB_GUIDE/test-data/data`` directory.

You can either click the file selector to navigate to the file or drag-and-drop into the GUIDE from your file navigator.

Expand All @@ -112,7 +105,7 @@ The Session Start Time in the General Metadata section is already specified beca
:alt: Metadata page with invalid Subject information


However, we still need to add the Subject information—as noted by the red accents around that item. Let’s say that our subject is a male mouse with an age of P30D.
However, we still need to add the Subject information—as noted by the red accents around that item. Let’s say that our subject is a male mouse with an age of P30D, which represents 30 days old.

.. figure:: ../assets/tutorials/single/metadata-subject-complete.png
:align: center
Expand Down
2 changes: 1 addition & 1 deletion pyflask/manageNeuroconv/manage_neuroconv.py
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@ def generate_test_data(output_path: str):
spikeglx_output_folder = base_path / "spikeglx"
phy_output_folder = base_path / "phy"

# Define NeuroPixel-like values for sampling rates and conversion factors
# Define Neuropixels-like values for sampling rates and conversion factors
duration_in_s = 3.0
number_of_units = 50
number_of_channels = 385 # Have to include 'sync' channel to be proper SpikeGLX. TODO: artificiate sync pulses
Expand Down

0 comments on commit c3b899b

Please sign in to comment.