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

Improve documentation on Jupyter and JupyterLab #337

Closed
astrojuanlu opened this issue Mar 9, 2018 · 12 comments
Closed

Improve documentation on Jupyter and JupyterLab #337

astrojuanlu opened this issue Mar 9, 2018 · 12 comments
Milestone

Comments

@astrojuanlu
Copy link
Member

astrojuanlu commented Mar 9, 2018

🐞 Problem

JupyterLab is a new environment, and some extra steps are needed to get things working: in particular, the user needs NodeJS and two extensions, @jupyter-widgets/jupyterlab-manager and @jupyterlab/plotly-extension for 3D.

Also, it's not clear in which versions of IPython/Jupyter is %matplotlib inline needed, and that deserves some documentation as well.

🎯 Goal

Make it easier for newcomers to have a poliastro environment up and running.

📋 Steps to solve the problem

  • Comment below about what you've started working on.
  • Add, commit, push your changes
  • Submit a pull request and add this in comments - Addresses #<put issue number here>
  • Ask for a review in comments section of pull request
  • Celebrate your contribution to this project 🎉
@shreyasbapat
Copy link
Member

Where exactly do you plan to put this? Like under what section?

@astrojuanlu
Copy link
Member Author

What about "Getting started"?

shreyasbapat added a commit to shreyasbapat/poliastro that referenced this issue Jul 29, 2018
shreyasbapat added a commit to shreyasbapat/poliastro that referenced this issue Jul 31, 2018
shreyasbapat added a commit to shreyasbapat/poliastro that referenced this issue Aug 3, 2018
shreyasbapat added a commit to shreyasbapat/poliastro that referenced this issue Aug 5, 2018
shreyasbapat added a commit to shreyasbapat/poliastro that referenced this issue Aug 5, 2018
shreyasbapat added a commit to shreyasbapat/poliastro that referenced this issue Aug 5, 2018
@astrojuanlu
Copy link
Member Author

By the way: next version of nbconvert will finally have support for ipywidgets >= 7, which means: dynamic widgets in static HTML!

jupyter/nbconvert#636 (comment)

So, after it's released, we can start testing using widgets more.

On the other hand, there's an ongoing discussion on whether Jupyter should save the widget status by default or not:

jupyter-widgets/ipywidgets#1632 (comment)

Which, IMHO, is the final tweak that's needed for them to be as usable as the old HTML static output (see also python-visualization/folium#874 (comment))

@astrojuanlu
Copy link
Member Author

nbconvert 5.4 is around the corner:

jupyter/nbconvert#869

@shreyasbapat
Copy link
Member

@astrojuanlu
Copy link
Member Author

@astrojuanlu
Copy link
Member Author

I mean... You added those! #459

@shreyasbapat
Copy link
Member

Not all of them :/
One that's not added: (Most Crucial)

FigureWidget support

jupyter labextension install plotlywidget@0.7.0

@shreyasbapat
Copy link
Member

Moreover, there is nothing like plotly extension mentioned over there :/

@astrojuanlu
Copy link
Member Author

Oh, you're right! Perhaps the extension is outdated? In any case, reopening. All yours :)

@astrojuanlu astrojuanlu reopened this Feb 3, 2019
@shreyasbapat
Copy link
Member

On it!

@astrojuanlu
Copy link
Member Author

Thanks @shreyasbapat! Re-closing :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants