Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mooerslab/cctbxsnips-snipmate
https://github.com/mooerslab/cctbxsnips-snipmate
cctbx cctbx-snippets cctbx-snips code-snippets-python colab colab-notebook crystallographic-computing ghosttext jupyter python snipmate snippets websocket
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mooerslab/cctbxsnips-snipmate
- Owner: MooersLab
- License: mit
- Created: 2023-01-27T15:27:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T09:26:25.000Z (8 months ago)
- Last Synced: 2024-04-13T23:54:52.058Z (8 months ago)
- Topics: cctbx, cctbx-snippets, cctbx-snips, code-snippets-python, colab, colab-notebook, crystallographic-computing, ghosttext, jupyter, python, snipmate, snippets, websocket
- Language: Vim Snippet
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cctbxsnips-snipmate
[](https://opensource.org/licenses/MIT)
## CCTBX
[CCTBX](https://github.com/cctbx/cctbx_project) 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.
### Blaine's cctbx install protocol
I assume that Anaconda has already been installed. While we are at it, we also create the Jupyter Notebook kernel. Execute one line at a time: Wait for the execution to finish before executing the next line.
```bash
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).
## Snipmate
[Snipmate](https://github.com/garbas/vim-snipmate) is a popular snippet manager for Vim.
It should work with NeoVim.
There are other snippets managers for Vim and NeoVim, such as `neosnippets`.
To complicate matters more, there several alternate systems for managing plugins.
## The problems that this repo addresses
1. ** Facilitation of code reuse ** 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.
```bash
cd ~/.vim/my-snippets/snipmate
git clone https://github.com/MooersLab/cctbxsnips-snipmate.git
cd cctbxsnips-snipmate/
mv cctbx.snippets ../.
cd ..
rm -rf cctbxsnips-snipmate
```
2. **Optional** If you want to use these snippets from Vim or NeoVim to edit live cells in Jupyter or Colab notebooks, install [GhostText](https://ghosttext.fregante.com/) in your browser and the [Vim Ghost](https://github.com/raghur/vim-ghost)plugin for Vim. Install the [nvim-ghost](https://github.com/subnut/nvim-ghost.nvim] plugin for NeoVim).
## Related repositories
- [cctbxsnips-Emacs](https://github.com/MooersLab/cctbxsnips-Emacs) CCTBX snippets for the yasnippet snippet system in for Emacs.
- [cctbxsnips-SublimeText3](https://github.com/MooersLab/cctbxsnips-SublimeText3) CCTBX snippets for Sublime Text 3 (ST3).
- [cctbxsnips-VSC](https://github.com/MooersLab/cctbxsnips-VSC) CCTBX snippets for Visual Studio Code (VSC).
- [cctbxsnips-UltiSnips](https://github.com/MooersLab/cctbxsnips-Ultisnips) CCTBX snippets for Vim or NeoVim via UltiSnips plugin.
- [cctbxsnips-neosnippets](https://github.com/MooersLab/cctbxsnips-neosnippets) CCTBX snippets for Vim or NeoVim via neosnippets plugin.
- [cctbxsnips-Atom](https://github.com/MooersLab/cctbxsnips-Atom) CCTBX snippets for Atom.
- [Jupyterlab cctbx snippets](https://github.com/MooersLab/jupyterlabcctbxsnips) CCTBX snippets for JupyterLab with the `jupyterlab-snippets` extension or the jupyterlab-snippets-mutlimenus extension.
- [Jupyterlab cctbx plus snippets](https://github.com/MooersLab/jupyterlabcctbxsnipsplus) The variant of the `jupyterlabcctbxsnips` library with comments to guide editing of the snippets.
- [Colab cctbx snippets](https://github.com/MooersLab/colabcctbxsnips) Colab snippets.
## Update History
|Version | Changes | Date |
|:-----------:|:----------------------------------------------------------------------------:|:----------------------:|
| Version 0.2| Fixed typos in README.md. Added badges and update table | 2024 April 13 |
## Sources of funding
- NIH: R01 CA242845
- NIH: R01 AI088011
- NIH: P30 CA225520 (PI: R. Mannel)
- NIH P20GM103640 and P30GM145423 (PI: A. West)