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

updating docs for v0.1.0 #67

Merged
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
6 changes: 5 additions & 1 deletion .napari/DESCRIPTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,8 @@ Many plugins may be used in the course of published (or publishable) research, a
during conference talks and other public facing events. If you'd like to be cited in
a particular format, or have a DOI you'd like used, you should provide that information here. -->

yt-napari provides plugins to help load data from [yt](https://yt-project.org/) into napari. It includes a graphical data loader, json-based file loading and helper-functions for jupyter notebook interaction. See the [full documentation](https://yt-napari.readthedocs.io) for more details.
yt-napari provides plugins to help load data from [yt](https://yt-project.org/) into napari. It includes a graphical data loader, json-based file loading and helper-functions for jupyter notebook interaction.

![](https://raw.githubusercontent.com/data-exp-lab/yt-napari/main/docs/_static/nb_iso_galaxy_T_rho.png)

See the [full documentation](https://yt-napari.readthedocs.io) for more details.
14 changes: 14 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
## v0.1.0

This release includes some non-backwards compatible changes to the schema. Old
json files will need to be updated.

### New Features

* load 2D slices and 3D regions
* widget reader redesign: add multiple selections!
* yt dataset cacheing to speed up subsequent loads
* improved logging
* test infrastructure updates
* improved development maintenance scripts

## v0.1.0

Changes
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,11 @@ nbscreenshot(viewer)

#### using the yt Reader plugin

To use the yt Reader plugin, click on `Plugins -> yt-napari: yt Reader`. Select a file, specify a field type and field, set the region to sample and then simply click "Load":
To use the yt Reader plugin, click on `Plugins -> yt-napari: yt Reader`. From there, add a region or slice selector then specify a field type and field and bounds to sample between and then simply click "Load":

![Loading a subset of a yt dataset from the napari viewer](./assets/images/readme_ex_003_gui_reader.gif)

To load a different field or section, adjust the values and click "Load" again.
You can add multiple selections and load them all at once or adjust values and click "Load" again.

#### using a json file and schema

Expand Down
Binary file modified assets/images/readme_ex_003_gui_reader.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/nb_iso_galaxy_T_rho.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/readme_ex_003_gui_reader.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Welcome to yt-napari's documentation!

:code:`yt-napari` is a suite of plugins and methods for loading data from :code:`yt` in :code:`napari`. For issues and notes on contributing, see the `github repository <https://github.com/data-exp-lab/yt-napari>`_.

.. image:: _static/readme_ex_003_gui_reader.gif

.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down
Loading