From 15d44c484fd2214210cd027393f2abbca98561a2 Mon Sep 17 00:00:00 2001 From: Dan Fortunato Date: Wed, 15 Jul 2026 15:59:12 -0400 Subject: [PATCH] docs: add mip as the recommended way to install chunkIE Adds an 'Install with mip (recommended)' section to the top of the Get chunkIE page, documenting installation via the mip package manager (https://mip.sh). --- docs/getchunkie.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/getchunkie.rst b/docs/getchunkie.rst index e5df1c94..7d96a893 100644 --- a/docs/getchunkie.rst +++ b/docs/getchunkie.rst @@ -4,7 +4,28 @@ Get chunkIE ============ -Installation From Source +Install with mip (recommended) +------------------------------ + +The recommended way to install chunkIE is with `mip `_, a package +manager for MATLAB. After installing mip, run the following command in MATLAB: + +.. code:: matlab + + >> mip install chunkie + +This will install chunkIE together with its dependencies using pre-built MEX +binaries, so there is no need to compile anything yourself. + +Then load chunkIE onto your MATLAB path for the current session: + +.. code:: matlab + + >> mip load chunkie + +See `mip.sh/docs `_ for more information on using mip. + +Installation From Source --------------------------- Installation directly from source is not recommended for Windows