Skip to content
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

Start a user guide #177

Merged
merged 1 commit into from
Jun 21, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions docs/guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Guide
.. toctree::
:maxdepth: 1

user_guide
third_party
38 changes: 38 additions & 0 deletions docs/guide/user_guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
User guide
==========

Overview
--------
``napari-matplotlib`` contains a number of different ``napari`` Widgets. Each
widget is designed to map one or more ``napari`` Layers on to a ``matplotlib`` plot.
As an example, the `~.HistogramWidget` is used to
map one or more Image layers on to a 1D histogram plot.

The widgets split into two categories:

Layer plotting
~~~~~~~~~~~~~~
These widgets plot the data stored directly in napari layers.
Currently available are widgets to plot:

- 1D histograms
- 2D scatter plots (switching to 2D histograms for a large number of points)
- 1D slice line plots

To use these:

1. Open the desired widget using the ``Plugins > napari-matplotlib`` menu in napari.
2. Select the required number of layers using the napari layers list in the bottom left-hand side of the window.

Features plotting
~~~~~~~~~~~~~~~~~
These widgets plot the data stored in the ``.features`` attribute of individual napari layers.
Currently available are:

- 2D scatter plots of two features against each other.

To use these:

1. Open the desired widget using the ``Plugins > napari-matplotlib`` menu in napari.
2. Select a single layer that has a features table using the napari layers list in the bottom left-hand side of the window.
3. Use the drop down menu(s) under the Matplotlib figure to select the feature(s) to plot.