Skip to content
This repository has been archived by the owner on Oct 14, 2023. It is now read-only.

Commit

Permalink
Added documentation of JupyterLab and plotly extensions, added a link…
Browse files Browse the repository at this point in the history
… to source code and benchmarks in documentation. Fixes #337 #418 #355
  • Loading branch information
shreyasbapat committed Sep 19, 2018
1 parent 9996a1d commit 9454f20
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
16 changes: 16 additions & 0 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,22 @@ you find any, please open an issue in the `issue tracker`_.
.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
.. _`local installations`: http://stackoverflow.com/a/4325047/554319

Using poliastro on JupyterLab
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

After the release of plotly 3.0, plotting orbits using poliastro is easier than ever.

You have to install 2 (two) extensions of JupyterLab to make your experience smooth.

$ jupyter labextension install @jupyter-widgets/jupyterlab-manager

$ jupyter labextension install @jupyterlab/plotly-extension

And as the documentation of JupyterLab Extensions states:

"In order to install JupyterLab extensions, you need to have Node.js version 4 or later installed."


Testing
-------

Expand Down
12 changes: 11 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ poliastro - Astrodynamics in Python
**poliastro** is an open source (MIT) collection of Python functions useful
in Astrodynamics and Orbital Mechanics, focusing on interplanetary applications.
It provides a simple and intuitive API and handles physical quantities with
units. Some of its awesome features are:
units.

View `source code`_ of poliastro!

.. _`source code`: https://github.com/poliastro/poliastro

Some of its awesome features are:

* Analytical and numerical orbit propagation
* Conversion between position and velocity vectors and classical orbital
Expand Down Expand Up @@ -51,6 +57,10 @@ browser using binder, a cloud Jupyter notebook server:
.. _`issue tracker`: https://github.com/poliastro/poliastro/issues
.. _`wiki`: https://github.com/poliastro/poliastro/wiki/

See `benchmarks`_ for the performance analysis of poliastro.

.. _`benchmarks`: https://blog.poliastro.space/poliastro-benchmarks/

poliastro works on recent versions of Python and is released under
the MIT license, hence allowing commercial use of the library.

Expand Down

0 comments on commit 9454f20

Please sign in to comment.