Skip to content

docs: add mip as the recommended way to install chunkIE #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danfortunato wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add mip as the recommended way to install chunkIE #194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/getchunkie.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,28 @@
Get chunkIE
============

Installation From Source
Install with mip (recommended)
------------------------------

The recommended way to install chunkIE is with `mip <https://mip.sh>`_, 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 <https://mip.sh/docs>`_ for more information on using mip.

Installation From Source
---------------------------

Installation directly from source is not recommended for Windows
Expand Down
Loading