You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Visualization plugins include:
23
23
- Peristimulus time histograms
24
24
- ...
25
25
26
-
For a table of Neurodata Types and their corresponding Neurosift plugins, see [neurodata_types.md](doc/neurodata_types.md).
26
+
For a list of available plugins, see [neurodata_types.md](doc/neurodata_types.md).
27
27
28
28
Beyond plots and graphs, Neurosift lets you browse the hierarchical structure of NWB files.
29
29
@@ -57,20 +57,20 @@ You can also [install and run Neurosift locally for development purposes](doc/de
57
57
58
58
In addition to the frontend, there is also a [Python package called neurosift](https://pypi.org/project/neurosift/) that provides a command-line interface for viewing local NWB files. See the instructions above. The source code for this package is in the [python directory](python).
59
59
60
+
## Where to find documentation
61
+
62
+
***Quick start:** If you are new to Neurosift, we recommend that you follow the links at the top of this README. Basic usage in the browser does not require installation. If you're looking for a quick way to view a local NWB file, see the instructions above.
63
+
***Supported Neurodata types:** For a table of Neurodata Types and their corresponding Neurosift plugins, see [neurodata_types.md](doc/neurodata_types.md).
64
+
***Development environment:** If you want to set up a development environment for updating current features or adding new ones, see [setting up a development environment](doc/development_environment.md). We welcome feedback and code contributions. Please submit a pull request or open an issue.
65
+
***API documentations:** API documentation is not available at this point, but you the development environment documentation provides guidance on how to explore the source code.
66
+
***Adding annotations (experimental):** For information on how to add annotations to NWB files, see [neurosift_annotations.md](doc/neurosift_annotations.md). This is an experimental feature that is still under development.
67
+
60
68
## Seeking help
61
69
62
70
Please report any issues or suggest features on the [GitHub issue tracker](https://github.com/flatironinstitute/neurosift/issues).
63
71
64
72
You can also use [Discussions](https://github.com/flatironinstitute/neurosift/discussions) to ask questions about how to use Neurosift or enhance your experience with it, share ideas and feedback that can help improve Neurosift, or discuss any related topics.
65
73
66
-
## For developers
67
-
68
-
We welcome feedback and code contributions. Please submit a pull request or open an issue.
69
-
70
-
To set up a development environment for updating current features or adding new ones, see [setting up a development environment](./doc/development_environment.md).
71
-
72
-
[This page](https://neurosift.app/?p=/tests) has a table of tests for many of the view plugins.
73
-
74
74
## License
75
75
76
76
Neurosift is licensed under the terms of the Apache License 2.0.
0 commit comments