IBAMR Project Settings and Packages for Sublime Text

The following instructions will set up the packages and basic configuration on a Mac. NOTE: They will remove any customization that you may have already made to Sublime, and so use with caution.

1. Install Sublime Package Control
2. Close Sublime Text
3. Open Terminal and input the following commands:

# Navigate to the Sublime Text Package directory:
cd ~/Library/Application\ Support/Sublime\ Text/Packages

# (NOTE: For Sublime Text 3, this directory is named ~/Library/Application\ Support/Sublime\ Text\ 3/Packages)

# Delete the User folder within this directory:
rm -r User

# Copy the contents of the User directory from the repository to ~/Library:
cp -r /path/to/IBAMR-sublime-settings/User

4. Open Sublime Text. Package Control will automatically download the necessary Sublime Text packages.
5. Close Sublime Text.

There is also a Sublime Text project file template for IBAMR that is intended to be placed in the IBAMR source code directory. To set up this project:

cp /path/to/IBAMR-sublime-settings/ibamr.sublime-project.template /path/to/IBAMR/ibamr.sublime-project

The .gitignore file in IBAMR is configured so that files named *.sublime-project or *.sublime-workspace are not tracked by git. This facilitates customization of the project files.

It is possible to get full code completion in Sublime Text by installing clangd, which is provided by, e.g., the llvm package in Homebrew. Once clangd is available, it is necessary create either a compile_commands.json file or a compile_flags.txt file. The purpose of this file is to inform clangd of key compiler flags. Our current recommendation is to create a compile_flags.txt file, since this allows code completion to work "out of the box" for any source code file in the project.

An example file is provided named example_compile_flags.txt. To use this file to create a working compile_flags.txt file, first copy the file into your IBAMR source directory:

cp /path/to/IBAMR-sublime-settings/example_compile_flags.txt /path/to/IBAMR/compile_flags.txt

then edit its contents to point to the correct directories.

You also can place this file in a higher level directory if you want it to be used with other projects, e.g.,

cp /path/to/IBAMR-sublime-settings/example_compile_flags.txt $HOME/code/compile_flags.txt

An extremely rudimentary script, IBAMR/scripts/setup_compile_commands.sh, is also available to create a compile_commands.json file. This script requires users to install scan-build and compdb:

pip install scan-build
pip install compdb