Skip to content

Commit

Permalink
Merge branch 'main' into user-tests-update-posttutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
garrettmflynn committed Apr 9, 2024
2 parents 70d69c7 + 871997b commit e9d14a2
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
2 changes: 2 additions & 0 deletions docs/conf_extlinks.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"pynwb-docs": ("https://pynwb.readthedocs.io/en/stable/%s", "%s"),
"matnwb-src": ("https://github.com/NeurodataWithoutBorders/matnwb/%s", "%s"),
"nwb-overview": ("https://nwb-overview.readthedocs.io/en/latest/%s", "%s"),
"guide-issues": ("https://github.com/NeurodataWithoutBorders/nwb-guide/issues/%s", "%s"),
"request-format-support": ("https://github.com/catalystneuro/neuroconv/issues/new?assignees=&labels=enhancement%%2Cdata+interfaces&projects=&template=format_request.yml&title=%%5BNew+Format%%5D%%3A+%s", "%s"),
"path-expansion-guide": ("https://neuroconv.readthedocs.io/en/main/user_guide/expand_path.html%s", "%s"),
"dandi-staging": ("https://gui-staging.dandiarchive.org/%s", "%s"),
"dandi-archive": ("https://dandiarchive.org/%s", "%s"),
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/multiple_sessions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This page helps you automatically identify source data for multiple subjects / s
File locations are specified as **format strings** that define source data paths of each selected data format.

.. note::
Format strings are one component of NeuroConv's **path expansion language**, which has some nifty features for manually specifying complex paths. Complete documentation of the path expansion feature of NeuroConv can be found :path-expansion-guide:`here <>` .
Format strings are one component of NeuroConv's **path expansion language**, which has some nifty features for manually specifying complex paths. Complete documentation of the path expansion feature of NeuroConv can be found :path-expansion-guide:`here <>`.

While you don’t have to specify format strings for all of the pipeline’s data formats, we’re going to find all of our data here for this tutorial. You'll always be able to confirm or manually select the final paths on the Source Data page later in the workflow.

Expand Down
22 changes: 15 additions & 7 deletions docs/tutorials/next_steps.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
What's Next?
=======================================
============
Congratulations on finishing your first set of conversions using the NWB GUIDE using example data! The next big step is to make a pipeline for your own data.

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

To submit any feedback on the tutorial or your experience with the GUIDE, feel free to open an :guide-issues:`issue <>` on our GitHub page.

If you do not see your data format listed on the Data Formats page or our :doc:`support table </format_support>` , please submit a request using :request-format-support:`this form <>`.


Considerations for Real-World Use
---------------------------------
When using the GUIDE to convert data from your own experiments, there are a few things to keep in mind...

Choosing an Output Location
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Choosing a good output location is important for two reasons, namely **conversion speed** and **disk space**.
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.
1. SSDs will be much faster than HDDs. We’d recommend moving the output location to an SSD if available.
2. On-board (PCI slot) disk drives will be much faster than most conventional external USB drives. We recommend using an on-board disk drive whenever possible.
3. 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.

0 comments on commit e9d14a2

Please sign in to comment.