Skip to content

Commit

Permalink
Add outline of the user workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
oruebel committed Aug 27, 2024
1 parent 603c8ed commit 3ea7a6d
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/pages/1_userdocs.dox
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@
* with a particular data acquisition software via AqNWB.
*
* - @subpage install_page
* - \subpage getting_started_page
* - @subpage hdf5io
*/
35 changes: 35 additions & 0 deletions docs/pages/userdocs/getting_started.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/**
* @page getting_started_page Getting Started
*
* Once you have completed \ref install_page you are ready to start with your project.
*
* \section getting_started_linking Linking AqNWB to your Project
*
* Coming soon
*
* \section getting_started_acquisition_workflow Acquiring Data with AqNWB
*
* \subsection Main Steps
*
* 1. **Create the I/O object:** : The I/O object, e.g., \ref AQNWB::HDF5::HDF5IO "HDF5IO", is responsible
* for writing/reading data to/from disk.
* 2. **Create the RecordingContainer (optional):** The \ref AQNWB::NWB::RecordingContainers "RecordingContainers"
* class is used to help manage data \ref AQNWB::NWB::Container "Container" objects used for recording. This is not
* required but is particularly useful when recording multiple signals to the same file.
* 3. **Create and initialize the NWBFile:** \ref AQNWB::NWB::NWBFile "NWBFile" is main \ref AQNWB::NWB::Container "Container"
* for creating and managing contents of an NWB file. After creating the object we need to call
* \ref AQNWB::NWB::NWBFile::initialize "NWBFile.initialize(...)" to setup the main outline of the file.
* 4. **Create the Containers for recording:**
* 5. **Start the recording:**
* 6. **Record data:**
* 7. **Stop the recording:**
* 8. **Clean up:** Delete the references to the object you created, e.g., the I/O object, NWBFile, and RecordingContainer
*
* \subsection Code Example
*
* Coming soon
*
*
*
*
*/

0 comments on commit 3ea7a6d

Please sign in to comment.