diff --git a/CHANGES.rst b/CHANGES.rst index de050b7..091c7c0 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,4 +1,4 @@ -0.5.0 (unreleased) +1.0.0 (unreleased) ------------------ * Update jdaviz requirement to 4.0 to include upstream improvements including API hints. [#121, #133] diff --git a/README.rst b/README.rst index de2e513..226068e 100644 --- a/README.rst +++ b/README.rst @@ -27,11 +27,6 @@ :alt: Powered by lightkurve Badge -Early Development Software Warning ----------------------------------- -LCviz is still very early on in development and is not currently recommended for use. - - License ------- diff --git a/docs/images/api_hint_screenshot.png b/docs/images/api_hint_screenshot.png new file mode 100644 index 0000000..386c58d Binary files /dev/null and b/docs/images/api_hint_screenshot.png differ diff --git a/docs/images/launch_screenshot.png b/docs/images/launch_screenshot.png new file mode 100644 index 0000000..a6b1b8f Binary files /dev/null and b/docs/images/launch_screenshot.png differ diff --git a/docs/index.rst b/docs/index.rst index d1285ca..9a3830d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,11 @@ notebook), built on top of `Jdaviz `_ and `lightk lcviz.load_data(lc) lcviz.show() + +.. figure:: images/launch_screenshot.png + :alt: Screenshot of lcviz + + It aims to provide tools for the analysis of periodic and semi-periodic variability from stationary sources (exoplanets, eclipsing binaries, ellipsoidal variables, pulsating stars, rotating stars, etc) in high-cadence photometric data sets, specifically - but not limited to - Kepler, K2, and TESS. @@ -35,4 +40,5 @@ Reference/API installation.rst plugins.rst + plugin_api.rst reference/api.rst diff --git a/docs/installation.rst b/docs/installation.rst index 6785f21..91efcec 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -4,22 +4,16 @@ Installation ============ -.. note:: - - ``lcviz`` is undergoing constant development. We encourage users to always update - to the latest version. In general, it is good practice to install the development - version following the instructions below as full released versions may lag behind. - User Installation ----------------- Create Your Local Environment ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Some of Jdaviz's dependencies require non-Python packages to work +Some dependencies require non-Python packages to work (particularly the front-end stack that is part of the Jupyter ecosystem). We recommend using `Miniconda `_ -to easily manage a compatible Python environment for ``jdaviz``; it should work +to easily manage a compatible Python environment for ``lcviz``; it should work with most modern shells, except CSH/TCSH. You may want to consider installing ``lcviz`` in a new virtual or conda environment @@ -33,13 +27,7 @@ to avoid version conflicts with other packages you may have installed, for examp Pip Install ^^^^^^^^^^^ -As noted above, we typically recommend installing the latest development version: - -.. code-block:: bash - - pip install git+https://github.com/spacetelescope/lcviz --upgrade - -A normal install will also work by installing the latest release version: +To install the latest stable release: .. code-block:: bash @@ -48,9 +36,6 @@ A normal install will also work by installing the latest release version: Common Issues ^^^^^^^^^^^^^ -If you encounter problems while following these installation instructions, -please consult :ref:`known installation issues `. - Note that ``lcviz`` requires Python 3.10 or newer. If your ``pip`` corresponds to an older version of Python, it will raise an error that it cannot find a valid package. @@ -63,7 +48,6 @@ instead of ``pip``: conda install bottleneck conda install -c conda-forge notebook conda install -c conda-forge jupyterlab - conda install -c conda-forge voila You might also want to enable the ``ipywidgets`` notebook extension, as follows: @@ -83,7 +67,7 @@ and ``username`` is your GitHub username. This is a one-setup setup: .. code-block:: bash git clone git@github.com:username/lcviz.git - cd jdaviz + cd lcviz git remote add upstream git@github.com:spacetelescope/lcviz.git git fetch upstream main git fetch upstream --tags diff --git a/docs/plugin_api.rst b/docs/plugin_api.rst new file mode 100644 index 0000000..1011da8 --- /dev/null +++ b/docs/plugin_api.rst @@ -0,0 +1,20 @@ +.. _plugin-apis: + +********************* +Accessing Plugin APIs +********************* + +Each plugin object is wrapped by a public user API which enables interacting with the plugin from +the notebook directly. The plugin API object for each plugin is accessible through ``viz.plugins``. +For example: + +.. code-block:: python + + plugin = viz.plugins['Plot Options'] + plugin.open_in_tray() + plugin.show('popout') + +When running in a notebook or lab environment, plugins provide API hints directly in the UI. To enable these, toggle the ``<>`` button in the top of the plugin. + +.. figure:: images/api_hint_screenshot.png + :alt: Screenshot of API hints in the UI \ No newline at end of file