mip-package-manager 0.2.0

pip-style package manager for MATLAB packages

mip-client

⚠️ Warning: This project is at a very early stage of development and is subject to breaking changes.

A simple pip-style package manager for MATLAB packages.

Installation

Install the package using pip:

pip install mip-package-manager

Or install from source:

# First, clone the repository
git clone https://github.com/mip-org/mip-client.git
cd mip-client

# Then, install the package
pip install -e .

To set up the MATLAB integration, run:

mip setup

This command will create the necessary directories and files in ~/.mip/matlab for MATLAB integration.

Then add ~/.mip/matlab to your MATLAB path permanently. You can do this in MATLAB:

addpath('~/.mip/matlab')
savepath

Alternatively, you can add this to your MATLAB startup.m file (typically located at ~/Documents/MATLAB/startup.m):

addpath('~/.mip/matlab')

Note: After upgrading to a new version of mip, run mip setup to ensure you have the latest MATLAB integration.

Usage

Install a package

Either from the command line or from within MATLAB, run:

mip install package_name

Downloads and installs a package to ~/.mip/packages/package_name.

Table of installable packages

Using packages in MATLAB

After setting up the MATLAB path and installing packages, you can load them in MATLAB:

% Load a package (adds it to the path for the current session)
mip load package_name

% Now you can use the package functions

List installed packages

mip list

Shows all currently installed packages.

Uninstall a package

mip uninstall package_name

Removes an installed package after confirmation. Also removes any packages that depend on it.

Internal Package Structure

• Packages are stored in ~/.mip/packages/
• Each package is extracted from a zip (.mhl) file into its own directory
• Each package has a mip.json file containing metadata, a load.m that gets called when the package is loaded, and an unload.m that gets called when the package is unloaded.
• The +mip MATLAB namespace is installed in ~/.mip/matlab/+mip/

Example

# Install a package
mip install surfacefun

# List installed packages
mip list

# Use in MATLAB
matlab
>> mip load surfacefun
>> % Now use the toolbox functions

# Uninstall
mip uninstall surfacefun

How to add new packages

For now mip supports a very limited set of packages, which are built as part of this repository. To add a new package, you should submit a pull request to https://github.com/mip-org/mip-core.

Requirements

• Python 3.6+
• MATLAB

Authors

Jeremy Magland and Dan Fortunato - Center for Computational Mathematics, Flatiron Institute

License

Apache License 2.0