stata_kernel icon indicating copy to clipboard operation
stata_kernel copied to clipboard

Things to add to docs

Open kylebarron opened this issue 7 years ago • 10 comments

  • [x] note about using pip3 instead of pip
  • [x] using indentation and for loops in Atom to control what code is executed at a time.
  • [ ] advantage of using Jupyter for remote work: You can reconnect to the same session of Stata if your connection gets cut/VPN times out. Provide short overview of tmux; how to list current jupyter sessions; how to reconnect from Hydrogen
  • [x] explanation of how graphs work with the kernel. Note: graph keyword must come at the beginning of the line; you can quiet graphs by running them with qui
  • [x] explanation of delimiter modes
  • [x] using watch expressions in Atom
  • [ ] jupyter theme customization. https://bitbucket.org/joon/color-schemes-for-jupyter-qt-console https://www.reddit.com/r/IPython/comments/3hfflo/jupyter_qtconsole_colors/ https://github.com/dunovank/jupyter-themes
  • [ ] Explain that when the kernel is started from the console or from Hydrogen, the Stata session is lost when it's closed. Alternatively, you can do jupyter kernel --kernel stata, to start a Stata kernel that (multiple) other clients can connect to.
  • [x] Checkmark in Atom means that the command was successfully completed but that no output was created.
  • [x] ~~Add note that it's fine in Stata to run if/else if/else blocks separately. This means it's 100% ok to just shift-enter through the whole document.~~ This is not always true.
  • [ ] Mention how you can connect multiple front ends to the same kernel.

kylebarron avatar Aug 21 '18 18:08 kylebarron

Limitations:

  • ~~Can't run log close _all on Windows.~~
  • ~~Creating a log file will have a lot of extra stuff in it.~~

kylebarron avatar Sep 14 '18 22:09 kylebarron

In troubleshooting:

~~If you have multiple installations of Python on your machine, you need to run python -m stata_kernel.install with the correct one. Because the path of the executable gets put as the executable in kernel.json.~~

kylebarron avatar Sep 18 '18 15:09 kylebarron

Using dynamic documents with Hydrogen in Atom.

kylebarron avatar Sep 20 '18 20:09 kylebarron

~~Note that browse (not the magic) will still work on Windows and on Mac when using Automation.~~ image

kylebarron avatar Sep 21 '18 16:09 kylebarron

~~Add note about Stata compatibility. I think it should be compatible for 12+.~~

kylebarron avatar Oct 30 '18 03:10 kylebarron

Tout nbconvert to PDF a bit more

kylebarron avatar Oct 30 '18 04:10 kylebarron

More explanation of Mata support.

kylebarron avatar Nov 19 '18 17:11 kylebarron

~~Developer documentation. How to build and deploy docs; how to push to pypi.~~

kylebarron avatar Nov 28 '18 21:11 kylebarron

Mention using console with regular Stata file in jupyter lab

kylebarron avatar Jan 30 '19 21:01 kylebarron

If you clear all global macros, ~~graphs won't work~~ it takes an extra command for the global to re-instantiate

kylebarron avatar Feb 06 '19 00:02 kylebarron