nix-matlab/README.adoc

162 lines
4.2 KiB
Text
Raw Normal View History

2021-05-14 14:15:05 +00:00
= Matlab for Nix users
This repo is a collection of files that should help Nix and NixOS users install Matlab imperatively.
2021-05-14 14:15:05 +00:00
== Install
2021-05-14 14:15:05 +00:00
Like any other Matlab user, you should first go to your Matlab account on
Mathworks' website, at: https://www.mathworks.com/mwaccount/ and download the
installation zip file. Extract the zip file and note the `install` executable
you just extracted. To run that file, you'll need to get into a FHS environment
that a nix-shell will provide.
2021-05-14 14:15:05 +00:00
=== Run `matlab-shell` with an unstable Nix
2021-05-14 14:15:05 +00:00
....
nix run gitlab:doronbehar/nix-matlab#matlab-shell
....
=== Run `matlab-shell` with +++<s>stable</s>+++ legacy Nix
....
git clone https://gitlab.com/doronbehar/nix-matlab
cd nix-matlab
nix-shell
....
=== Installation of Matlab itself
include::./install.adoc[]
2021-05-14 14:15:05 +00:00
=== Adding `matlab` executables to your system
2021-05-15 08:30:34 +00:00
With what was done now, you run Matlab from the command line with:
....
# Legacy nix users (inside a clone of this repo)
$(nix-build)/bin/matlab
# Flake nix users (without cloning)
nix run gitlab:doronbehar/nix-matlab
....
But it's likely you'd like to make Matlab survive garbage collections and add a
desktop launcher to your system. To do that you can follow one of the following
paths according to your setup.
2021-05-14 14:15:05 +00:00
==== For NixOS users with a flakes setup
2021-05-15 13:33:29 +00:00
[source,nix]
----
inputs = {
# ...
nix-matlab = {
# Recommended if you also override the default nixpkgs flake, common among
# nixos-unstable users:
#inputs.nixpkgs.follows = "nixpkgs";
url = "gitlab:doronbehar/nix-matlab";
};
# ...
outputs = { self, nixpkgs, nix-matlab }:
let
flake-overlays = [
nix-matlab.overlay
];
in {
nixosConfigurations = (
HOSTNAME = nixpkgs.lib.nixosSystem {
2021-05-15 13:36:54 +00:00
modules = [ (import ./configuration.nix flake-overlays) ]
2021-05-15 13:33:29 +00:00
};
};
};
};
----
And in `./configuration.nix`:
[source,nix]
----
# All overlays given by flakes
flake-overlays:
{ config, pkgs, options, lib, ... }:
{
nixpkgs.overlays = [
(
final: prev: {
# Your own overlays...
}
)
] ++ flake-overlays;
}
----
Example evaluated
https://gitlab.com/doronbehar/nixos-configs/-/blob/e28b5aaf86f21202a2b7daa05b098ee5ed85de6f/flake.nix#L5-16[here]
and
https://gitlab.com/doronbehar/nixos-configs/-/blob/e28b5aaf86f21202a2b7daa05b098ee5ed85de6f/configuration.nix#L74[here].
2021-05-15 08:30:34 +00:00
2021-05-14 14:15:05 +00:00
==== For NixOS users without a flakes setup
2021-05-15 13:33:29 +00:00
The following setup should also fit flake NixOS users.
Add to your `configration.nix` (untested, but should work):
[source,nix]
----
nixpkgs.overlays = let
nix-matlab = import (builtins.fetchTarball "https://gitlab.com/doronbehar/nix-matlab/-/archive/master/nix-matlab-master.tar.gz") { };
in [
nix-matlab.overlay
(
final: prev: {
# Your own overlays...
}
)
];
----
2021-05-14 14:15:05 +00:00
==== Home Manager setup
2021-05-15 13:33:29 +00:00
TODO
==== Usage in Other Flakes / `shell.nix`
Some people may wish to not install matlab globally, and only making it part of
the `buildInputs` of their project. Usually this paradigm follows along with
https://direnv.net/[`direnv`] +
https://nixos.wiki/wiki/Development_environment_with_nix-shell#Using_Direnv[`shell.nix`]
/ https://nixos.wiki/wiki/Flakes#Direnv_integration[`flake.nix`] setup. For
example you can create in your project a `shell.nix`, or define `devShell` in
your `flake.nix` similarly to this:
[source,nix]
----
{ pkgs, nix-matlab }:
pkgs.mkShell {
buildInputs = (with nix-matlab.packages.x86_64-linux; [
matlab
matlab-mlint
matlab-mex
]);
# Define C include path env vars for c development
shellHook = nix-matlab.shellHooksCommon;
}
----
Note that Matlab still needs to be installed in a user-writeable location for
this `shellHook` to work, as explained xref:#user-content-install[here].
2021-05-15 13:33:29 +00:00
== Previous work / Credits
2021-05-14 14:15:05 +00:00
2021-05-15 08:30:34 +00:00
Core parts of this repo are based on
https://github.com/tviti/nix-cfg/tree/e6531426e86273e450c6133a0deae9008411fffd/pkgs/matlab[@tviti's
work]. My part was making it a bit more accessible for modern Nix flake setup,
and making the shell and steps a bit more approachable.
The idea for a `shellHooksCommon` was by
https://gitlab.com/DavidRConnell[@DavidRConnell], first discussed in
https://gitlab.com/doronbehar/nix-matlab/-/merge_requests/1#note_631741222[!1].