/cctbxsnips-Ultisnips

cctbx-snips for the ultisnips package for Vim and NeoVim

Primary LanguageVim SnippetMIT LicenseMIT

cctbxsnips for the UltiSnips plugin in Vim and NeoVim

Version License: MIT

CCTBX

CCTBX is the Computational Crystallography Toolbox. Its development is based at Lawrence-Berkeley National Laboratory. It provides code for computations with diffraction data and atomic coordinates of proteins and small molecules. It has C++ and Python ports. It is available in Anaconda in the conda-forge channel as cctbx-base for python3.8 through 3.11 for Windows, macOS, and Linux.

Installation

I assume that Anaconda has already been installed. We also create the Jupyter notebook kernel while we are at it. Execute one line at a time: Wait for the execution to finish before executing the next line.

conda create --name cctbx39 python=3.9
conda activate cctbx39
conda install -c conda-forge cctbx-base -y
conda install ipykernel -y
python -m ipykernel install --user --name cctbx39 --display-name "cctbx python3.9"

The second to last command triggers the installation of Jupyter in the cctbx39 env. The last command creates and installs the Jupyter kernel in ~/Library/Jupyter/kernels/cctbx39 on the Mac. Select cctbx python3.9 from the list of kernels when opening a new notebook in Jupyter.

Replace the 3.9 or 39 above with whatever version of Python you want to use (between 3.8 and 3.11).

UltiSnips

UltiSnips is a popular snippet manager for Vim. It should work with NeoVim, but due to changes in NeoVim, UltiSnips is less stable there. There are other snippets managers for Vim and NeoVim, but UltiSnips is well-established.

The problems that this repo addresses

  1. Facilitation of code reuse. The use of code snippets can save time by reusing existing code. The presence of tab stops in code snippets can help ensure that all parameters that need customization to a new problem are considered. Thus, tab stops can reduce subsequent debugging.

  2. Use Emacs to edit Jupyter and Colab code and markdown cells The existing snippet formats for Jupyter and Colab notebooks do not support tab triggers and tab stops, which are standard features of code snippet systems in most text editors. We can overcome these limitations by sending the active code cell to Emacs via the GhostText extension for the browser and the atomic-chrome package for Emacs.

Installation

  1. Install the snippets for Vim.

I assume that the Ultisnips plugin has already been properly installed. The snippets are stored in a single file called python.snippets. I store this file in a folder called my-snippets/Ultisnips. You may have to concatenate python.snippets with an existing python.snippets file.

cd ~/.vim/my-snippets/Ultisnips
git clone https://github.com/MooersLab/cctbxsnips-Ultisnips.git
cd cctbxsnips-Ultisnips/
mv python.snippets ../.
cd ..
rm -rf cctbxsnips-Ultisnips
  1. Optional If you want to use these snippets from Vim or NeoVim to edit live cells in Jupyter or Colab notebooks, install GhostText in your browser and the Vim Ghostplugin for Vim. Install the [nvim-ghost](https://github.com/subnut/nvim-ghost.nvim] plugin for NeoVim).

Related repositories

Version Changes Date
Version 0.2 Fixed typos in README.md. Added Badges and Update table 2024 April 12

Sources of funding

  • NIH: R01 CA242845
  • NIH: R01 AI088011
  • NIH: P30 CA225520 (PI: R. Mannel)
  • NIH P20GM103640 and P30GM145423 (PI: A. West)