Skip to content

Add detailed descriptions for NWB and conversion approaches sections #61

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
11 changes: 9 additions & 2 deletions content/converting-data-to-nwb/_index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
---
title: "Converting Data To NWB"

### What is NWB?
about_nwb:
enable: true
content: "The goal of NWB is to package experiment data with the metadata necessary to analyze the data. All of the data from a particular session goes into a single file. This includes the neurophysiology data itself, but also includes other data such as information about the data acquisition, experiment design, experimental subject, and behavior of that subject. The NWB core schema defines data containers for common data objects in neurophysiology data, including: extracellular electrophysiology (e.g., Neuropixels probes), optical physiology (e.g., two-photon imaging), intracellular electrophysiology (e.g., patch clamping), and behavior."
image: "/images/nwb-data-and-metadata.png"
additional_info: "All of these data types and relationships are defined in the [NWB Schema](https://nwb-schema.readthedocs.io/) using the [HDMF specification language](https://hdmf-schema-language.readthedocs.io). NWB is faced with the challenge of supporting a large variety of different experiment types, so the data types and relationships can get quite complex. For this reason, the NWB development team provides tools and APIs, described below, to help users easily and efficiently read and write NWB files."

### List
list:
enable: true
title: "Neurodata Without Borders (NWB) is a data standard for neurophysiology. Converting data to NWB involves:"
title: "Converting neurophysiology data to NWB involves:"
items:
- item: "Reading data and metadata from source files"
- item: "Adding necessary metadata"
- item: "Writing data and metadata to NWB following best practices"
- item: "Packaging large datasets for optimal cloud deployment"
content: "The NWB ecosystem offers various solutions, ranging from automated no-code tools to fine-grained programmatic options. Below we provide an overview of the main tools. For a more detailed introduction to data conversion please see the [data conversion user guide](https://nwb-overview.readthedocs.io/en/latest/conversion_tutorial/user_guide.html)."
content: "The following sections start with the most automated and convenient approaches and proceed to more programming-heavy and customizable solutions. Each tool offers different levels of flexibility and control, allowing you to choose the right approach for your specific needs."

### Available Tools
available_tools_section:
Expand Down
22 changes: 22 additions & 0 deletions layouts/converting-data-to-nwb/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,28 @@ <h1 class="inter-700 text-48 text-white text-center z-4">{{ .Title | markdownify
</section>
{{/* End Hero Section */}}

{{/* About NWB Section */}}
{{ with .Params.about_nwb }}
{{ if .enable }}
<section class="py-5 bg-dark-100">
<div class="container-lg d-flex flex-column row-gap-4">
{{ with .content }}
<p class="inter-400 text-16 dark-700 mb-0">{{ . | markdownify }}</p>
{{ end }}
{{ with .image }}
<div class="text-center my-4">
<img src="{{ . }}" alt="NWB Data and Metadata" class="img-fluid rounded shadow">
</div>
{{ end }}
{{ with .additional_info }}
<p class="inter-400 text-16 dark-700 mb-0">{{ . | markdownify }}</p>
{{ end }}
</div>
</section>
{{ end }}
{{ end }}
{{/* End About NWB Section */}}

{{/* List Section */}}
{{ with .Params.list }}
{{ if .enable }}
Expand Down
Binary file added static/images/nwb-data-and-metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading