Skip to content

Commit

Permalink
Merge pull request #93 from AntoinePrv/screenshots
Browse files Browse the repository at this point in the history
More screenshots
  • Loading branch information
AntoinePrv committed Jan 10, 2023
2 parents 0d51fc3 + ce3f96d commit 8150461
Show file tree
Hide file tree
Showing 8 changed files with 80 additions and 5 deletions.
31 changes: 31 additions & 0 deletions README.rst
Expand Up @@ -47,6 +47,12 @@ Interactive Plotly plots
.. image:: docs/source/interactive-plotly-plots.png
:alt: Interactive Plotly plots

Rich display of tables
~~~~~~~~~~~~~~~~~~~~~~

.. image:: docs/source/rich-display-tables.png
:alt: Rich display of tables

Rich display of structs
~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -59,6 +65,31 @@ Rich display of LaTeX equations
.. image:: docs/source/rich-display-latex-and-input.png
:alt: Rich display of LaTeX equations

Rich display of images
~~~~~~~~~~~~~~~~~~~~~~

.. image:: docs/source/rich-display-images.png
:alt: Rich display of images

Code completion
~~~~~~~~~~~~~~~

.. image:: docs/source/code-completion.png
:alt: Dropdown completion of a function

Code inspection and contextual help
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: docs/source/code-inspection.png
:alt: Queriyng the help of a function

.. image:: docs/source/contextual-help.png
:alt: Contextual help shown dynamically

Stream support
~~~~~~~~~~~~~~
.. image:: docs/source/stream-support.png
:alt: Input and ouput streams

Installation
------------
Expand Down
Binary file added docs/source/code-completion.png
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/source/code-inspection.png
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/source/contextual-help.png
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/source/rich-display-images.png
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/source/rich-display-tables.png
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/source/stream-support.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 49 additions & 5 deletions docs/source/usage.rst
Expand Up @@ -12,6 +12,26 @@ Usage
Launch the Jupyter notebook with ``jupyter notebook`` or Jupyter lab with ``jupyter lab`` and launch
a new Python notebook by selecting the **xoctave** kernel.

Code completion
---------------

.. image:: code-completion.png
:alt: Dropdown completion of a function

Code inspection and contextual help
-----------------------------------

.. image:: code-inspection.png
:alt: Queriyng the help of a function

.. image:: contextual-help.png
:alt: Contextual help shown dynamically

Stream support
--------------
.. image:: stream-support.png
:alt: Input and ouput streams

Visualisation
=============
Graphical toolkit
Expand All @@ -24,12 +44,18 @@ The ``notebook`` toolkit renders plots as inline images in the notebook.
The render is done natively using OpenGL on the kernel side.
Select this toolkit using ``graphics_toolkit notebook`` in the notebook.

.. image:: native-octave-plots.png
:alt: Native Octave plots

Plotly toolkit
~~~~~~~~~~~~~~
The experimental ``plotly`` toolkit calls `Plotly <https://github.com/plotly/plotly.js>`_
web API to render plot as interactive HTML elements, with zoom, cursors, and hover tooltips.
Select this toolkit using ``graphics_toolkit plotly`` in the notebook.

.. image:: interactive-plotly-plots.png
:alt: Interactive Plotly plots

With Jupyter lab, the plotly extension is also needed.
It can be installed with ``conda``/``mamba`` (or ``pip``)

Expand All @@ -44,9 +70,27 @@ for detailed instructions and troubleshooting.

Other
-----
More visualisations include:

* Matrices shown as tables;
* Structs shown as json;
* Symbolic classes as latex;
* Transfer functions in ``control`` package.
Rich display of tables
~~~~~~~~~~~~~~~~~~~~~~

.. image:: rich-display-tables.png
:alt: Rich display of tables

Rich display of structs
~~~~~~~~~~~~~~~~~~~~~~~

.. image:: rich-display-structs.png
:alt: Rich display of structs

Rich display of LaTeX equations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: rich-display-latex-and-input.png
:alt: Rich display of LaTeX equations

Rich display of images
~~~~~~~~~~~~~~~~~~~~~~

.. image:: rich-display-images.png
:alt: Rich display of images

0 comments on commit 8150461

Please sign in to comment.