diff --git a/docs/conf.py b/docs/conf.py index e6bb064872..8fb6b72d00 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -287,6 +287,7 @@ 'skimage': ('https://scikit-image.org/docs/stable/', None), 'specreduce': ('https://specreduce.readthedocs.io/en/stable/', None), 'specutils': ('https://specutils.readthedocs.io/en/stable/', None), + 'stdatamodels': ('https://stdatamodels.readthedocs.io/en/latest/', None), 'traitlets': ('https://traitlets.readthedocs.io/en/stable/', None)}) # Options for linkcheck diff --git a/docs/imviz/import_data.rst b/docs/imviz/import_data.rst index 5d062b2fc9..7f9dcb4e2d 100644 --- a/docs/imviz/import_data.rst +++ b/docs/imviz/import_data.rst @@ -110,8 +110,7 @@ Roman datamodels You can also load Nancy Grace Roman Space Telescope (hereafter, Roman) data products, which are provided as ASDF files. If an ASDF file has a ``roman`` attribute, Jdaviz will open it with `roman-datamodels `_. -You must run ``pip install roman-datamodels`` separately as it is not automatically installed -by Jdaviz. +In order to load Roman files, you will need to install the :ref:`optional-deps-roman`. .. code-block:: python diff --git a/docs/index.rst b/docs/index.rst index 9978d79e66..a40b7b711b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -56,7 +56,10 @@ Jdaviz Jump to Mosviz .. grid-item-card:: - :img-top: logos/cube.svg + + .. note:: + + New and in development. Logo coming soon! .. button-ref:: rampviz/index :expand: diff --git a/docs/installation.rst b/docs/installation.rst index 032ac85033..dabb8055cb 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -78,6 +78,22 @@ You might also want to enable the ``ipywidgets`` notebook extension, as follows: jupyter nbextension enable --py widgetsnbextension + +.. _optional-deps-roman: + +Optional Dependencies for Roman +------------------------------- + +Dependencies for working with data products from the Roman Space Telescope +are available for optional installation from PyPI with:: + + pip install -U jdaviz[roman] + +or while building from source with:: + + pip install -U .[roman] + + Developer Installation ---------------------- diff --git a/docs/rampviz/import_data.rst b/docs/rampviz/import_data.rst new file mode 100644 index 0000000000..96cdfe3d45 --- /dev/null +++ b/docs/rampviz/import_data.rst @@ -0,0 +1,19 @@ +.. _rampviz-import-api: + +*************************** +Importing Data into Rampviz +*************************** + + +Level 1 ramp products loaded into Rampviz with +:py:meth:`~jdaviz.configs.rampviz.helper.Rampviz.load_data`. Rampviz loads +Level 1 ramp cubes from: + +- JWST when given as paths to "_uncal.fits" files + or :py:class:`~stdatamodels.jwst.datamodels.Level1bModel` data models, or + +- Roman Level 1 ramp files in asdf format or + :py:class:`~roman_datamodels.datamodels.RampModel` data models. + +In order to load Roman files, you will need to install the :ref:`optional-deps-roman`. + diff --git a/docs/rampviz/index.rst b/docs/rampviz/index.rst index 672ec971e3..6a39541f7f 100644 --- a/docs/rampviz/index.rst +++ b/docs/rampviz/index.rst @@ -1,12 +1,13 @@ -.. |cubeviz_logo| image:: ../logos/cube.svg - :height: 42px - .. _rampviz: -###################### -|cubeviz_logo| Rampviz -###################### +####### +Rampviz +####### + +.. warning:: + + Heads up: Rampviz is new, and in active development. Rampviz is a visualization and analysis toolbox for ramp cubes from infrared detectors. It is built on top of the @@ -18,4 +19,5 @@ with ramp files from the Roman Space Telescope and JWST. .. toctree:: :maxdepth: 2 + import_data plugins diff --git a/docs/rampviz/plugins.rst b/docs/rampviz/plugins.rst index ccd94760d8..82301ea32b 100644 --- a/docs/rampviz/plugins.rst +++ b/docs/rampviz/plugins.rst @@ -62,5 +62,6 @@ Slice Ramp Extraction =============== +Coming soon.