Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to use modular components of scimax (like new ipython)? #191

Closed
ghost opened this issue Apr 2, 2018 · 4 comments
Closed

How to use modular components of scimax (like new ipython)? #191

ghost opened this issue Apr 2, 2018 · 4 comments

Comments

@ghost
Copy link

ghost commented Apr 2, 2018

I just discovered scimax and I'm pretty excited about it. I'm looking to get started with some of the features, like the fancy new ob-ipython.

Since I already have a fair amount of emacs/org configuration of my own, I'd like to incorporate scimax a bit at a time, rather than enabling the whole thing all at once, so I have a better sense of what changes I'm making and so I have finer-grained control of which packages are controlling what.

I see the docs say

The new update is in two files: ./scimax-ob.el, which contains pretty general functions for all org babel src blocks I think, and ./scimax-org-babel-ipython-upstream.el which contains monkey-patches on ob-ipython, and additional features.

Is there a recommended way to use only the new ob-ipython, while keeping the other components disabled?

I already have the MELPA version of ob-ipython installed. Should I then clone this repo and (require 'scimax-ob) and (require scimax-org-babel-ipython-upstream) to get the added scimax ipython features? What of scimax-ob, scimax-notebook and scimax-org-babel-ipython?

Thanks for your help!

@jkitchin
Copy link
Owner

jkitchin commented Apr 2, 2018

You can do any of the following:

  1. use load-file to load specific files in scimax
  2. add scimax to your load-path and require what you want.

You will have to read the source files to see what is required, and then debug what is missing. You probably need scimax-ob and scimax-org-babel-ipython-upstream. You do not need scimax-notebook or scimax-org-babel-ipython (which is the old branch).

@singletS
Copy link
Contributor

singletS commented Apr 3, 2018

These seem to be the minimum needed to get things working for me on a (very) simplified spacemacs install:

(require 'ox-ipynb)
(require 'ob-ipython)
(require 'scimax-org-babel-ipython-upstream)

My .spacemacs loads a file that adds a few things like Easy Template definitions, keymap tweaks, etc., and the nuke-ipython function (found in scimax-org-babel-ipython.el).

Edit: I should mention this assumes

  1. Full install of scimax from github, including running scimax.sh at least once so other required packages are downloaded.
  2. load-paths are added per @jkitchin 's comment above

@ghost
Copy link
Author

ghost commented Apr 4, 2018

This works, thanks. I'll leave it open in case you want to reference it for the docs or anything.

jkitchin added a commit that referenced this issue Apr 5, 2018
@jkitchin
Copy link
Owner

jkitchin commented Apr 5, 2018

Thanks.

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

No branches or pull requests

2 participants