Skip to content

Commit

Permalink
improve tutorials (#1738)
Browse files Browse the repository at this point in the history
  • Loading branch information
bendichter authored Jul 25, 2023
1 parent 12522d5 commit 65c25ab
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 4 deletions.
4 changes: 4 additions & 0 deletions docs/gallery/domain/ecephys.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
It is recommended to cover :ref:`basics` before this tutorial.
.. note:: It is recommended to check if your source data is supported by
`NeuroConv Extracellular Electrophysiology Gallery <https://neuroconv.readthedocs.io/en/main/conversion_examples_gallery/conversion_example_gallery.html#extracellular-electrophysiology>`_.
If it is supported, it is recommended to use NeuroConv to convert your data.
The following examples will reference variables that may not be defined within the block they are used in. For
clarity, we define them here:
"""
Expand Down
4 changes: 4 additions & 0 deletions docs/gallery/domain/ophys.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
It is recommended to cover :ref:`basics` before this tutorial.
.. note:: It is recommended to check if your source data is supported by
`NeuroConv Optical Physiology Gallery <https://neuroconv.readthedocs.io/en/main/conversion_examples_gallery/conversion_example_gallery.html#optical-physiology>`_.
If it is supported, it is recommended to use NeuroConv to convert your data.
The following examples will reference variables that may not be defined within the block they are used in. For
clarity, we define them here:
"""
Expand Down
10 changes: 6 additions & 4 deletions docs/gallery/general/plot_file.py
Original file line number Diff line number Diff line change
Expand Up @@ -275,10 +275,9 @@
####################
# :py:class:`~pynwb.base.TimeSeries` objects can be added directly to :py:class:`~pynwb.file.NWBFile` using:
#
# * :py:meth:`~pynwb.file.NWBFile.add_acquisition` to add *acquisition* data (raw, acquired data that should never
# change),
# * :py:meth:`~pynwb.file.NWBFile.add_stimulus` to add *stimulus* data, or
# * :py:meth:`~pynwb.file.NWBFile.add_stimulus_template` to store *stimulus templates*.
# * :py:meth:`.NWBFile.add_acquisition` to add *acquisition* data (raw, acquired data that should never change),
# * :py:meth:`.NWBFile.add_stimulus` to add *stimulus* data, or
# * :py:meth:`.NWBFile.add_stimulus_template` to store *stimulus templates*.
#

nwbfile.add_acquisition(time_series_with_timestamps)
Expand Down Expand Up @@ -383,6 +382,7 @@
name="behavior", description="processed behavioral data"
)
behavior_module.add(position_obj)
behavior_module

####################
#
Expand Down Expand Up @@ -617,6 +617,8 @@

nwbfile.add_time_intervals(sleep_stages)

sleep_stages.to_dataframe()

####################
# Now we overwrite the file with all of the data

Expand Down
Binary file modified docs/source/_static/trials_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 65c25ab

Please sign in to comment.