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.

Sign up for GitHub

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

Jump to bottom

DOC: readme tweaks #2113

Merged
merged 4 commits into from
Mar 24, 2023
Merged

DOC: readme tweaks #2113

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6279084
Simple readme tweaks
bmorris3 Mar 24, 2023
75966de
Minor edits
pllim Mar 24, 2023
cbc0db2
capitalization
bmorris3 Mar 24, 2023
a5910a2
Update README.rst
bmorris3 Mar 24, 2023
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
10 changes: 7 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,14 @@ The power of ``jdaviz`` is that it can integrated into your Jupyter notebook wor
from jdaviz import Specviz

specviz = Specviz()
specviz.app
specviz.show()

To learn more about the various ``jdaviz`` application configurations and loading data, see the
`specviz <https://jdaviz.readthedocs.io/en/latest/specviz/import_data.html>`_, `cubeviz <https://jdaviz.readthedocs.io/en/latest/cubeviz/import_data.html>`_, `mosviz <https://jdaviz.readthedocs.io/en/latest/mosviz/import_data.html>`_, or `imviz <https://jdaviz.readthedocs.io/en/latest/imviz/import_data.html>`_ tools.
`Specviz <https://jdaviz.readthedocs.io/en/latest/specviz/import_data.html>`_,
`Cubeviz <https://jdaviz.readthedocs.io/en/latest/cubeviz/import_data.html>`_,
`Mosviz <https://jdaviz.readthedocs.io/en/latest/mosviz/import_data.html>`_,
`Imviz <https://jdaviz.readthedocs.io/en/latest/imviz/import_data.html>`_,
or `Specviz2D <https://jdaviz.readthedocs.io/en/latest/specviz2d/import_data.html>`_ tools.

``jdaviz`` also provides a directory of `sample notebooks <https://jdaviz.readthedocs.io/en/latest/sample_notebooks.html>`_ to test the application, located in the ``notebooks`` sub-directory
of the git repository. ``CubevizExample.ipynb`` is provided as an example that loads a JWST data cube with the
Expand Down Expand Up @@ -132,7 +136,7 @@ Cite ``jdaviz`` via our Zenodo record: https://doi.org/10.5281/zenodo.5513927.
Contributing
------------

We love contributions! jdaviz is open source,
We love contributions! ``jdaviz`` is open source,
built on open source, and we'd love to have you hang out in our community.

**Imposter syndrome disclaimer**: We want your help. No, really.
Expand Down