<div dir="ltr"><div><div>Hi David, <br><br></div>The team and I are working on these
issues right now. There is a pull request (PR), under review, that will
alleviate some of the nbconvert problems you mention (see <a href="https://github.com/ipython/ipython/pull/3607" target="_blank">https://github.com/ipython/ipython/pull/3607</a>)<br>
<br></div>From the PR, this is how nbconvert will be called:<br><br>"<pre><code> ipython nbconvert notebook*.ipynb
ipython nbconvert notebook1.ipynb notebook2.ipynb
ipython nbconvert # this will use the config file to fill in the notebooks</code></pre>"<br><div class="gmail_extra"><br></div><div class="gmail_extra">I don't know all of the details, but I can provide some comments to your email in-line with regard to nbconvert (as seen below).<br>
<br></div><div class="gmail_extra">Thank you so much for spending the time to send some feedback,<br></div><div class="gmail_extra">Sincerely,<br><br></div><div class="gmail_extra">Jon<br></div><div class="gmail_extra"><br>
</div><br><div class="im">On Tue, Jul 16, 2013 at 8:56 AM, David P. Sanders <span dir="ltr"><<a href="mailto:dpsanders@gmail.com" target="_blank">dpsanders@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">Hi,<div><br></div><div>I
have been playing with the notebook and nbconvert from master, and have
some feedback on some basic usability issues, which I hope will be
useful.</div>
<div><br></div><div>Note that I am not (yet) a developer, but am rather trying to get a feel for things before possibly moving in that direction...</div>
<div><br></div><div>Please let me know if this is not the correct forum for such comments, and if I should, for example, instead open issues.</div><div><br></div><div><br></div><div>1. Ipython command line invocation</div>
<div>- Would it be possible to get rid of the hyphens in --pylab and
--profile in the ipython invocation? I understand that this is to do
with implementation, but it is neither easy to remember, nor to motivate
to novices that they should type this!<br>
</div><div><br></div></div></blockquote></div><div><br><span style="background-color:rgb(255,255,0)">Flags like this can be set in config files if you need them every time you work in a particular environment.</span><br>
<br> <br>
</div><div class="im"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><br></div><div>- Is there a good (non-historical) reason to use 'nbconvert' instead of just </div>
<div>ipython convert TARGET FILENAME?</div><div>Or even convertnb, so that the verb and noun are in the natural order.</div>
<div><br></div><div>Or make nbconvert just a separate binary (which, I understand, it basically is anyway, at least on unices):</div><div><br></div></div></blockquote><div><br></div></div><div><span style="background-color:rgb(255,255,0)">It was like this for a long time time prior to being merged into master recently.</span><br>
</div><div class="im"><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>nbconvert TARGET FILENAME?</div><div><br></div>
<div>
<br></div><div>
- Is it possible / easy to set up bash completion to press <TAB> after 'ipython' and have the options displayed?<br>
</div><div><br></div><div><br></div><div>- It would great to be able to type</div><div>ipython notebook odes.ipynb</div><div>and have the relevant ipynb open directly, instead of going via the dashboard</div><div><br></div>
<div><br></div><div>2. nbconvert:</div><div>- It would be great
(necessary, in my opinion) to have an 'Export as' option from within the
notebook to run the relevant nbconvert. </div><div><br></div></div></blockquote>
</div><div><br><span style="background-color:rgb(255,255,0)">That is planned, but not for 1.0</span><br> <br></div><div class="im"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div dir="ltr"><div><br></div>
<div>- PDF converter:<br></div><div>A direct PDF converter is necessary. </div><div>This is presumably trivial by just running</div><div>pdflatex after the LaTeX converter.</div><div>(Oh, if LaTeX is installed of course... I guess this is the problem?)</div>
<div><br></div></div></blockquote><div><br></div></div><div><span style="background-color:rgb(255,255,0)">We were think of generating and writing a make file to the output directory that would build the pdf.</span><br> <br>
</div><div class="im">
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><br></div><div>- html converter:</div><div>I tried <br></div><div>ipython nbconvert html odes.ipynb</div>
<div><br></div><div>but it doesn't work!</div><div><br></div><div>I strongly suggest to replace 'full_html' with just 'html'</div>
<div>and 'simple_html' could be 'basic_html'</div></div></blockquote><div><br></div></div><div><span style="background-color:rgb(255,255,0)">Ah, good suggestion, I'll see what the others think of this.</span><br>
</div><div class="im"><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><br></div><div>-
I was expecting that the HTML output would look exactly like on
nbviewer, which is also a static copy of the notebook, but it looks
different<br>
</div><div>I guess this is a CSS thing -- is there a good solution to have something exactly like on nbviewer?</div><div><br></div></div></blockquote><div> <br></div></div><div><span style="background-color:rgb(255,255,0)">I
don't know the answer to that, Matthias may know. He is actively
developing nbviewer and I believe he wrote the html templates that exist
now...</span><br>
</div><div class="im"><div><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>-
The nbconvert step produced an empty subdirectory 'odes_files' with
html export and some .txt files for LaTeX output. This seems unnecessary
from the user point of view.</div>
<div><br></div></div></blockquote></div><div><span style="background-color:rgb(255,255,0)"><br>This will change with the PR </span><br><br></div><div class="im"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div dir="ltr"><div><br></div><div>- Folding:</div><div>In my notebook, the output of several cells were folded, in particular the result of things like <br></div><div>help(odeint)</div><div>[I am planning on using this for a course, and wanted to record this step in the notebook]</div>
<div>But in the result of nbconvert, the full output of the documentation is shown.</div><div><br></div><div>This is very bad news -- how can the output folding be respected and not shown?</div><div><br></div></div></blockquote>
<div><br></div></div><div><span style="background-color:rgb(255,255,0)">I don't think a pre-canned feature exists to do this at the moment. It can be done by writing a transformer.</span><br></div><div class="im"><div>
</div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div dir="ltr"><div><br></div>
<div>- New LaTeX commands:</div><div>I defined various LaTeX shortcuts like</div><div>\newcommand{\yy}{\mathbf{y}}</div><div>inside $$...$$ in markdown cells.</div><div>(Is this the correct / canonical way to do this?)</div>
<div><br></div><div>Markdown seems to respect these in the rest of the document, and in the HTML output, but running</div><div>pdflatex on the LaTeX output forgot about them immediately after they were defined. </div><div>
<br></div></div></blockquote><div><br></div></div><div><span style="background-color:rgb(255,255,0)">This will have to be looked into. I don't know why the Latex isn't being passed through into the template.</span><br>
</div><div class="im"><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div><br></div><div>- Suppressing code cells in LaTeX output:<br>
</div><div>Towards the reproducible paper goal, how can code cells be suppressed in the LaTeX output. I guess with the metadata somehow?</div><div>
<br></div></div></blockquote><div><br></div></div><div><span style="background-color:rgb(255,255,0)">A transformer or a custom template</span><br></div><div> </div>______________________________<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
_________________<br>
IPython-dev mailing list<br>
<a href="mailto:IPython-dev@scipy.org" target="_blank">IPython-dev@scipy.org</a><br>
<a href="http://mail.scipy.org/mailman/listinfo/ipython-dev" target="_blank">http://mail.scipy.org/mailman/listinfo/ipython-dev</a></blockquote></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Tue, Jul 16, 2013 at 10:33 AM, David P. Sanders <span dir="ltr"><<a href="mailto:dpsanders@gmail.com" target="_blank">dpsanders@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><br><div class="gmail_extra"><div class="gmail_quote"><div class="im"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
- It would great to be able to type<br>
ipython notebook odes.ipynb<br>
and have the relevant ipynb open directly, instead of going via the<br>
dashboard<br>
<br></blockquote><div><br></div></div><div>Further to this comment:</div><div><br></div><div>At the moment, my default behaviour is *not* usually to want a list of the notebooks in the current directory, but simply to start writing stuff in the notebook, just like I would if I ran 'ipython' from the command line.</div>
<div><br></div><div>Maybe there could be an explicit option</div><div><br></div><div>ipython notebook dashboard</div><div><br></div><div>or</div><div><br></div><div>ipython notebook list</div><div><br></div><div>to get the dashboard behaviour.</div>
<div><br></div><div><br></div><div>[--snip]</div><div class="im">
<div><br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br>
- Folding:<br>
In my notebook, the output of several cells were folded, in particular the<br>
result of things like<br>
help(odeint)<br>
[I am planning on using this for a course, and wanted to record this step<br>
in the notebook]<br>
But in the result of nbconvert, the full output of the documentation is<br>
shown.<br>
<br>
This is very bad news -- how can the output folding be respected and not<br>
shown?<br></blockquote><div><br></div><div><br></div></div><div>This seems to be a more general problem: if I hide the output of a cell in the notebook, save and close, and reopen the same notebook, then the output appears in full. This seems to me to be an actual bug. I will (look for and) open an issue.</div>
<div><br></div><div>David.</div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div><div class="h5">
<br>
<br>
- New LaTeX commands:<br>
I defined various LaTeX shortcuts like<br>
\newcommand{\yy}{\mathbf{y}}<br>
inside $$...$$ in markdown cells.<br>
(Is this the correct / canonical way to do this?)<br>
<br>
Markdown seems to respect these in the rest of the document, and in the<br>
HTML output, but running<br>
pdflatex on the LaTeX output forgot about them immediately after they were<br>
defined.<br>
<br>
<br>
- Suppressing code cells in LaTeX output:<br>
Towards the reproducible paper goal, how can code cells be suppressed in<br>
the LaTeX output. I guess with the metadata somehow?<br>
<br>
<br>
3. Notebook issues:<br>
- Keyboard shortcuts:<br>
I am a keyboard person: for me, all functionality which is accessible via<br>
menus should be assigned a (preferably modifiable) keyboard shortcut.<br>
In particular, it seems that split cell, merge cell, and close and halt are<br>
currently missing shortcuts.<br>
<br>
- Similarly, could there be toolbar icons for split and merge?<br>
<br>
- Basic find and replace in the notebook:<br>
Find and replace, at least a basic one, is a must-have feature for<br>
refactoring.<br>
This seems to already be available in CodeMirror<br>
<br>
- In-place file editing<br>
It seems that by combining the %load and %%file magics,<br>
one has a kludgy way of editing an arbitrary file.<br>
Maybe this could be combined easily into an %%edit magic?<br>
<br>
- Is there a way of deleting multiple input cells simultaneously, rather<br>
than pressing Ctrl M-d several times or clicking the scissors icon several<br>
times (which admittedly is easier in this case). This would be very nice to<br>
have<br>
<br>
<br>
4. Notebook styling:<br>
- There seems to be much appetite for notebook styling, e.g. xkcdify.<br>
<br>
Here is a gist I found, referenced from a blog post that Brian commented on<br>
at some point, with a very basic interface. Something like this would be<br>
great to have, with a user-contributed style database:<br>
<br>
<a href="https://gist.github.com/aflaxman/5707238" target="_blank">https://gist.github.com/aflaxman/5707238</a><br>
<br>
Maybe this could just be via load_ext?<br>
<br>
By the way, is there a list of the possible extensions available?<br>
<br>
- Will Min's nbtoc extension be integrated?<br>
<br>
<br>
Apologies for the long message, but these are the things that have been<br>
bugging me for the last few days :)<br>
<br>
Thanks and best wishes,<br>
David.<br>
<br>
<br>
--<br>
**************************************************************************<br>
Dr. David P. Sanders<br>
<br>
Profesor Titular A / Associate Professor<br></div></div>
Departamento de F?sica, Facultad de Ciencias<br>
Universidad Nacional Aut?noma de M?xico (UNAM)<br>
<br>
<a href="mailto:dpsanders@gmail.com" target="_blank">dpsanders@gmail.com</a><br>
<a href="http://sistemas.fciencias.unam.mx/~dsanders" target="_blank">http://sistemas.fciencias.unam.mx/~dsanders</a><br>
<br>
Cub?culo / office: #414<div class="im"><br>
Tel.: +52 55 5622 4965<br></div>
-------------- next part --------------<br>
An HTML attachment was scrubbed...<br>
URL: <a href="http://mail.scipy.org/pipermail/ipython-dev/attachments/20130716/487ab363/attachment-0001.html" target="_blank">http://mail.scipy.org/pipermail/ipython-dev/attachments/20130716/487ab363/attachment-0001.html</a><br>
<br>
------------------------------<div class="im"><br>
<br>
_______________________________________________<br>
IPython-dev mailing list<br>
<a href="mailto:IPython-dev@scipy.org" target="_blank">IPython-dev@scipy.org</a><br>
<a href="http://mail.scipy.org/mailman/listinfo/ipython-dev" target="_blank">http://mail.scipy.org/mailman/listinfo/ipython-dev</a><br>
<br>
<br></div>
End of IPython-dev Digest, Vol 114, Issue 38<br>
********************************************<br>
</blockquote></div><div class="im"><br><br clear="all"><div><br></div>-- <br>**************************************************************************<br>Dr. David P. Sanders<br><br>Profesor Titular A / Associate Professor<br>
Departamento de Física, Facultad de Ciencias<br>
Universidad Nacional Autónoma de México (UNAM)<br><br><a href="mailto:dpsanders@gmail.com" target="_blank">dpsanders@gmail.com</a><br><a href="http://sistemas.fciencias.unam.mx/%7Edsanders" target="_blank">http://sistemas.fciencias.unam.mx/~dsanders</a><br>
<br>Cubículo / office: #414 <br>Tel.: +52 55 5622 4965<br><br>
</div></div></div>
<br>_______________________________________________<br>
IPython-dev mailing list<br>
<a href="mailto:IPython-dev@scipy.org">IPython-dev@scipy.org</a><br>
<a href="http://mail.scipy.org/mailman/listinfo/ipython-dev" target="_blank">http://mail.scipy.org/mailman/listinfo/ipython-dev</a><br>
<br></blockquote></div><br></div>