#31620 closed defect (fixed)

Document installing sagemath kernel without copying documentation

Reported by: nbruin Owned by:
Priority: blocker Milestone: sage-9.3
Component: documentation Keywords:
Cc: Merged in:
Authors: Nils Bruin Reviewers: Matthias Koeppe
Report Upstream: N/A Work issues:
Branch: 79914c2 (Commits, GitHub, GitLab) Commit: 79914c2c020dda02e63d199f047607bb3f191369
Dependencies: Stopgaps:

Status badges

Description

Follow up to #30476: Using jupyter kernelspec to install sagemath kernel results in copying about 2Gb of documentation into the jupyter kernels share directory. That's generally not the spot to put large files/documentation. Document how to avoid this.

Change History (10)

comment:1 follow-up: Changed 17 months ago by nbruin

The procedure to follow would be something like:

  • Use sage -sh -c 'ls -d $SAGE_LOCAL/share/jupyter/kernels/sagemath' to find location of sagemath kernel to install
  • Use jupyter --paths to find eligible data locations (for a "user" install, there will likely be something like $HOME/.local/share/jupyter there.
  • Installing the sagemath kernel should then amount to something like
    ln -s `sage -sh -c 'ls -d $SAGE_LOCAL/share/jupyter/kernels/sagemath'` $HOME/.local/share/jupyter
    

We may want to check/refine these instructions to be a little more robust and/or appropriate for other operating systems, but having this documented in an easily discovered place would help. These instructions should probaly be placed or linked to in src/doc/en/installation/launching.rst

comment:2 in reply to: ↑ 1 Changed 17 months ago by mkoeppe

See also previous discussions in #30298

comment:3 follow-up: Changed 17 months ago by mkoeppe

Replying to nbruin:

The procedure to follow would be something like:

  • Use sage -sh -c 'ls -d $SAGE_LOCAL/share/jupyter/kernels/sagemath' to find location of sagemath kernel to install

For this first step, I think we may want to add an option to the sage script that just prints the location

comment:4 Changed 17 months ago by nbruin

  • Branch set to u/nbruin/document_installing_sagemath_kernel_without_copying_documentation

comment:5 Changed 17 months ago by nbruin

  • Authors set to Nils Bruin
  • Commit set to 79914c2c020dda02e63d199f047607bb3f191369
  • Status changed from new to needs_review

New commits:

79914c2Document installing sagemath kernel without copying

comment:6 in reply to: ↑ 3 Changed 17 months ago by nbruin

Replying to mkoeppe:

Replying to nbruin:

The procedure to follow would be something like:

  • Use sage -sh -c 'ls -d $SAGE_LOCAL/share/jupyter/kernels/sagemath' to find location of sagemath kernel to install

For this first step, I think we may want to add an option to the sage script that just prints the location

I don't think it's something people need to do very often, so they'd need to look up how to do it anyway. As long as it's easily discovered and a readily copy-pastable formula, I don't think it's so bad if it's a little long. At least it's transparent what is going on for someone with generic bash skills. Let's first get this documented. It's a safe and easy change, so we can still include it in 9.3. Then it'll be up on sagemath.org in the near future and then hopefully search engines can pick it up.

comment:7 Changed 17 months ago by mkoeppe

OK, that's fine with me.

comment:8 Changed 17 months ago by mkoeppe

  • Reviewers set to Matthias Koeppe
  • Status changed from needs_review to positive_review

comment:9 Changed 16 months ago by mkoeppe

  • Priority changed from major to blocker

comment:10 Changed 16 months ago by vbraun

  • Branch changed from u/nbruin/document_installing_sagemath_kernel_without_copying_documentation to 79914c2c020dda02e63d199f047607bb3f191369
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.