Mailman 3 Updating documentation notebook and notebook dependency to IPython 4 - yt-dev

newer
Issue #1134: Quickstart notebook...

Updating documentation notebook and notebook dependency to IPython 4

older
Issue #1133: [experimental] Alpha...

Nathan Goldbaum

20 Oct 2015 20 Oct '15

8:46 p.m.

Hi all, Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x? Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format. The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython. My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well. -Nathan

Attachments:

attachment.html (text/html — 1.1 KB)

Show replies by date

Matthew Turk

20 Oct 20 Oct

8:48 p.m.

Hi Nathan, I think this is a good idea. -Matt On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum wrote:

...

Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

John ZuHone

8:50 p.m.

+1 John ZuHone Kavli Center for Astrophysics and Space Research Massachusetts Institute of Technology 77 Massachusetts Ave., 37-582G Cambridge, MA 02139 (w) 617-253-2354 (m) 781-708-5004 jzuhone@space.mit.edu jzuhone@gmail.com http://www.jzuhone.com

...

On Oct 20, 2015, at 4:46 PM, Nathan Goldbaum wrote:

Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan _______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

Cameron Hummels

9:13 p.m.

With this new format, what is the way to edit notebooks (e.g. in the docs)? We won't be able to edit the .ipynb file directly with a text editor? How now? On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum wrote:

...

Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Cameron Hummels NSF Postdoctoral Fellow Department of Astronomy California Institute of Technology http://chummels.org

Nathan Goldbaum

9:14 p.m.

On Tue, Oct 20, 2015 at 2:13 PM, Cameron Hummels wrote:

...

With this new format, what is the way to edit notebooks (e.g. in the docs)? We won't be able to edit the .ipynb file directly with a text editor? How now?

You can if you want, but you'll need IPython 4.0 or newer to edit the notebooks in the notebook browser interface.

...

On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum wrote:

...
Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Cameron Hummels NSF Postdoctoral Fellow Department of Astronomy California Institute of Technology http://chummels.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

Nathan Goldbaum

9:23 p.m.

On Tue, Oct 20, 2015 at 2:14 PM, Nathan Goldbaum wrote:

...

On Tue, Oct 20, 2015 at 2:13 PM, Cameron Hummels wrote:

...
With this new format, what is the way to edit notebooks (e.g. in the docs)? We won't be able to edit the .ipynb file directly with a text editor? How now?

You can if you want, but you'll need IPython 4.0 or newer to edit the notebooks in the notebook browser interface.

Right you have to edit it with a text editor or install IPython 2.x. This is annoying because 2.x is getting pretty long in the tooth and many people (well, me) don't have it installed anymore.

...

...
On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum wrote:

...
Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Cameron Hummels NSF Postdoctoral Fellow Department of Astronomy California Institute of Technology http://chummels.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

Michael Zingale

9:39 p.m.

it might be good to look at what version of ipython some popular linux distros ship with. I don't think that many are on 4 yet, but seem to be shipping with 3.2. On Tue, Oct 20, 2015 at 5:23 PM, Nathan Goldbaum wrote:

...

On Tue, Oct 20, 2015 at 2:14 PM, Nathan Goldbaum wrote:

...
On Tue, Oct 20, 2015 at 2:13 PM, Cameron Hummels wrote:

...
With this new format, what is the way to edit notebooks (e.g. in the docs)? We won't be able to edit the .ipynb file directly with a text editor? How now?

You can if you want, but you'll need IPython 4.0 or newer to edit the notebooks in the notebook browser interface.

Right you have to edit it with a text editor or install IPython 2.x. This is annoying because 2.x is getting pretty long in the tooth and many people (well, me) don't have it installed anymore.

...
...
On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum wrote:

...
Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Cameron Hummels NSF Postdoctoral Fellow Department of Astronomy California Institute of Technology http://chummels.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Michael Zingale Associate Professor Dept. of Physics & Astronomy • Stony Brook University • Stony Brook, NY 11794-3800 *phone*: 631-632-8225 *e-mail*: Michael.Zingale@stonybrook.edu *web*: http://www.astro.sunysb.edu/mzingale github: http://github.com/zingale

Michael Zingale

9:44 p.m.

although it looks like there is a way to convert back to an older version: https://github.com/QuantEcon/QuantEcon.site/issues/19 so this may be a non-issue for people with older ipythons. On Tue, Oct 20, 2015 at 5:39 PM, Michael Zingale < michael.zingale@stonybrook.edu> wrote:

...

it might be good to look at what version of ipython some popular linux distros ship with. I don't think that many are on 4 yet, but seem to be shipping with 3.2.

On Tue, Oct 20, 2015 at 5:23 PM, Nathan Goldbaum wrote:

...
On Tue, Oct 20, 2015 at 2:14 PM, Nathan Goldbaum wrote:

...
On Tue, Oct 20, 2015 at 2:13 PM, Cameron Hummels wrote:

...
With this new format, what is the way to edit notebooks (e.g. in the docs)? We won't be able to edit the .ipynb file directly with a text editor? How now?

You can if you want, but you'll need IPython 4.0 or newer to edit the notebooks in the notebook browser interface.

Right you have to edit it with a text editor or install IPython 2.x. This is annoying because 2.x is getting pretty long in the tooth and many people (well, me) don't have it installed anymore.

...
...
On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum
...
wrote:

...
Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Cameron Hummels NSF Postdoctoral Fellow Department of Astronomy California Institute of Technology http://chummels.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Michael Zingale Associate Professor

Dept. of Physics & Astronomy • Stony Brook University • Stony Brook, NY 11794-3800 *phone*: 631-632-8225 *e-mail*: Michael.Zingale@stonybrook.edu *web*: http://www.astro.sunysb.edu/mzingale github: http://github.com/zingale

Nathan Goldbaum

9:47 p.m.

On Tue, Oct 20, 2015 at 2:44 PM, Michael Zingale < michael.zingale@stonybrook.edu> wrote:

...

although it looks like there is a way to convert back to an older version:

https://github.com/QuantEcon/QuantEcon.site/issues/19

so this may be a non-issue for people with older ipythons.

On Tue, Oct 20, 2015 at 5:39 PM, Michael Zingale < michael.zingale@stonybrook.edu> wrote:

...
it might be good to look at what version of ipython some popular linux distros ship with. I don't think that many are on 4 yet, but seem to be shipping with 3.2.

I think supporting the python stacks on linux distros is a very hard, moving target. Instead, we've been pretty successful "supporting" the install script stack, with the intention of fixing issues on other versions. In addition, it's pretty easy to set up a python stack even without the install script using e.g. miniconda.

...

...
On Tue, Oct 20, 2015 at 5:23 PM, Nathan Goldbaum wrote:

...
On Tue, Oct 20, 2015 at 2:14 PM, Nathan Goldbaum wrote:

...
On Tue, Oct 20, 2015 at 2:13 PM, Cameron Hummels wrote:

...
With this new format, what is the way to edit notebooks (e.g. in the docs)? We won't be able to edit the .ipynb file directly with a text editor? How now?

You can if you want, but you'll need IPython 4.0 or newer to edit the notebooks in the notebook browser interface.

Right you have to edit it with a text editor or install IPython 2.x. This is annoying because 2.x is getting pretty long in the tooth and many people (well, me) don't have it installed anymore.

...
...
On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum < nathan12343@gmail.com> wrote:

...
Hi all,

Would anyone object to me updating the install script dependency and notebook dependency to IPython 4.x?

Right now it's quite annoying to edit the notebooks in the documentation, since you basically need to either edit them "by hand" (e.g. by directly editing the .ipynb file in a text editor) or update to IPython 2.x. It also causes a possibly scary to a new user pop-up box when opening the notebooks warning that notebook has been automatically converted to the new format.

The down side of doing this update is that people on older versions of IPython will no longer be able to read the notebooks. In addition, we will need to update our build automation and sphinx setup to use the newer version of IPython.

My ultimate goal is to make sure our docs are fully compatible with both python2 and python3, but I figure if I'm going over the full docs build I might as well update the IPython dependency as well.

-Nathan

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Cameron Hummels NSF Postdoctoral Fellow Department of Astronomy California Institute of Technology http://chummels.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Michael Zingale Associate Professor

Dept. of Physics & Astronomy • Stony Brook University • Stony Brook, NY 11794-3800 *phone*: 631-632-8225 *e-mail*: Michael.Zingale@stonybrook.edu *web*: http://www.astro.sunysb.edu/mzingale github: http://github.com/zingale

-- Michael Zingale Associate Professor

Dept. of Physics & Astronomy • Stony Brook University • Stony Brook, NY 11794-3800 *phone*: 631-632-8225 *e-mail*: Michael.Zingale@stonybrook.edu *web*: http://www.astro.sunysb.edu/mzingale github: http://github.com/zingale

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

Nathan Goldbaum

11:09 p.m.

I've created a trello card to track this: https://trello.com/c/zEggFsW6 Please feel free to help out (just ping me with changesets over e-mail/slack/whatever or make a PR to my repo). I think this should be merged in *after* we merge the experimental and development heads, which will hopefully happen soon (next week or so). On Tue, Oct 20, 2015 at 2:47 PM, Nathan Goldbaum wrote:

...

On Tue, Oct 20, 2015 at 2:44 PM, Michael Zingale < michael.zingale@stonybrook.edu> wrote:

...
although it looks like there is a way to convert back to an older version:

https://github.com/QuantEcon/QuantEcon.site/issues/19

so this may be a non-issue for people with older ipythons.

On Tue, Oct 20, 2015 at 5:39 PM, Michael Zingale < michael.zingale@stonybrook.edu> wrote:

...
it might be good to look at what version of ipython some popular linux distros ship with. I don't think that many are on 4 yet, but seem to be shipping with 3.2.

I think supporting the python stacks on linux distros is a very hard, moving target. Instead, we've been pretty successful "supporting" the install script stack, with the intention of fixing issues on other versions.

In addition, it's pretty easy to set up a python stack even without the install script using e.g. miniconda.

...
...
On Tue, Oct 20, 2015 at 5:23 PM, Nathan Goldbaum wrote:

...
On Tue, Oct 20, 2015 at 2:14 PM, Nathan Goldbaum
...
wrote:

...
On Tue, Oct 20, 2015 at 2:13 PM, Cameron Hummels wrote:

...
With this new format, what is the way to edit notebooks (e.g. in the docs)? We won't be able to edit the .ipynb file directly with a text editor? How now?

You can if you want, but you'll need IPython 4.0 or newer to edit the notebooks in the notebook browser interface.

Right you have to edit it with a text editor or install IPython 2.x. This is annoying because 2.x is getting pretty long in the tooth and many people (well, me) don't have it installed anymore.

...
...
On Tue, Oct 20, 2015 at 1:46 PM, Nathan Goldbaum < nathan12343@gmail.com> wrote:

> Hi all, > > Would anyone object to me updating the install script dependency and > notebook dependency to IPython 4.x? > > Right now it's quite annoying to edit the notebooks in the > documentation, since you basically need to either edit them "by hand" (e.g. > by directly editing the .ipynb file in a text editor) or update to IPython > 2.x. It also causes a possibly scary to a new user pop-up box when opening > the notebooks warning that notebook has been automatically converted to the > new format. > > The down side of doing this update is that people on older versions > of IPython will no longer be able to read the notebooks. In addition, we > will need to update our build automation and sphinx setup to use the newer > version of IPython. > > My ultimate goal is to make sure our docs are fully compatible with > both python2 and python3, but I figure if I'm going over the full docs > build I might as well update the IPython dependency as well. > > -Nathan > > _______________________________________________ > yt-dev mailing list > yt-dev@lists.spacepope.org > http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org > >

-- Cameron Hummels NSF Postdoctoral Fellow Department of Astronomy California Institute of Technology http://chummels.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

-- Michael Zingale Associate Professor

Dept. of Physics & Astronomy • Stony Brook University • Stony Brook, NY 11794-3800 *phone*: 631-632-8225 *e-mail*: Michael.Zingale@stonybrook.edu *web*: http://www.astro.sunysb.edu/mzingale github: http://github.com/zingale

-- Michael Zingale Associate Professor

Dept. of Physics & Astronomy • Stony Brook University • Stony Brook, NY 11794-3800 *phone*: 631-632-8225 *e-mail*: Michael.Zingale@stonybrook.edu *web*: http://www.astro.sunysb.edu/mzingale github: http://github.com/zingale

_______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org

3104

Age (days ago)

3104

Last active (days ago)

List overview

Download

9 comments

5 participants

participants (5)

Cameron Hummels
John ZuHone
Matthew Turk
Michael Zingale
Nathan Goldbaum

Updating documentation notebook and notebook dependency to IPython 4

tags

participants (5)