Installation

To install the Surfacefun MATLAB package, follow these steps.

Install with mip (recommended)

The recommended way to install Surfacefun in MATLAB is via the mip package manager:

>> mip install surfacefun

To use it in your current MATLAB session, run:

>> mip load surfacefun

This will automatically add Surfacefun to your MATLAB path.

Manual installation

Alternatively, you can install Surfacefun manually by following these steps.

1. In a terminal, clone the source repository from GitHub:

   git clone --recurse-submodules https://github.com/danfortunato/surfacefun.git
   

2. In MATLAB, change to the directory where the repository was cloned, then change to the surfacefun directory:

   >> cd 'surfacefun'
   

3. Now add the source files to your MATLAB path by running:

   >> setup
   

4. (Optional) If you would like this path to persist between MATLAB sessions, you may save it by running:

   >> savepath