tljh-matlab


Nametljh-matlab JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/mathworks/jupyter-matlab-proxy/tree/main/install_guides/the-littlest-jupyterhub/tljh-matlab
SummaryTLJH plugin for MATLAB
upload_time2024-11-26 06:37:14
maintainerNone
docs_urlNone
authorThe MathWorks, Inc.
requires_pythonNone
licenseMATHWORKS CLOUD REFERENCE ARCHITECTURE LICENSE
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # MATLAB Plugin for The Littlest JupyterHub

A plugin for running [MATLAB® Integration for Jupyter on The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/jupyter-matlab-proxy/install_guides/the-littlest-jupyterhub/README.md).

## Background

The Littlest JupyterHub supports [plugins](https://tljh.jupyter.org/en/latest/contributing/plugins.html) that provide additional features. The MATLAB plugin for TLJH, `tljh-matlab`, installs:
* a specified version of MATLAB, as well as any MATLAB toolboxes
* the system libraries that MATLAB requires 
* the [MATLAB Integration for Jupyter](github.com/mathworks/jupyter-matlab-proxy), for running MATLAB in Jupyter notebooks and accessing the MATLAB environment from Jupyter.

## Usage
To install the MATLAB plugin for TLJH include `--plugin tljh-matlab` in the Installer Script.
See [Customizing the Installer](https://tljh.jupyter.org/en/latest/topic/customizing-installer.html) for more information.

For example, the following command sets up an `admin_user` with `admin_password` and installs `tljh-matlab`:
```bash
curl -L https://tljh.jupyter.org/bootstrap.py
  | sudo python3 - \
    --admin admin_user:admin_password \
    --plugin tljh-matlab
```

## Customization
To customize the default values used by the plugin, set the relevant environment variables before using the bootstrap command:

| Environment Variable Name | Default Values | Notes |
|---|---|---|
| MATLAB_RELEASE             | R2024b                         | Specify the MATLAB release you would like to install. |
| MATLAB_PRODUCT_LIST        | "MATLAB Symbolic_Math_Toolbox" | Specify a product by consulting the `--products` section of [MATLAB Package Manager](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md). For example, to install Simulink in addition to MATLAB, use `"MATLAB Simulink"`. |
| MATLAB_INSTALL_DESTINATION | /opt/matlab/R2024b             | Specify the path to the location where you want to install MATLAB. |


For example, to customize the plugin to install MATLAB R2023b and Simulink, run:
```bash
curl https://tljh.jupyter.org/bootstrap.py
  | env MATLAB_RELEASE=R2023b MATLAB_PRODUCT_LIST="MATLAB Simulink" \
    sudo python3 - \
    --admin admin_user:admin_password \
    --plugin tljh-matlab
```

----

Copyright 2024 The MathWorks, Inc.

----

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mathworks/jupyter-matlab-proxy/tree/main/install_guides/the-littlest-jupyterhub/tljh-matlab",
    "name": "tljh-matlab",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "The MathWorks, Inc.",
    "author_email": "cloud@mathworks.com",
    "download_url": "https://files.pythonhosted.org/packages/c4/9b/48e093ad13bc2db673e17c00115beab7d34ce1b529afa8d7156be55d6cd4/tljh_matlab-0.1.0.tar.gz",
    "platform": null,
    "description": "# MATLAB Plugin for The Littlest JupyterHub\n\nA plugin for running [MATLAB® Integration for Jupyter on The Littlest JupyterHub](https://github.com/mathworks/jupyter-matlab-proxy/jupyter-matlab-proxy/install_guides/the-littlest-jupyterhub/README.md).\n\n## Background\n\nThe Littlest JupyterHub supports [plugins](https://tljh.jupyter.org/en/latest/contributing/plugins.html) that provide additional features. The MATLAB plugin for TLJH, `tljh-matlab`, installs:\n* a specified version of MATLAB, as well as any MATLAB toolboxes\n* the system libraries that MATLAB requires \n* the [MATLAB Integration for Jupyter](github.com/mathworks/jupyter-matlab-proxy), for running MATLAB in Jupyter notebooks and accessing the MATLAB environment from Jupyter.\n\n## Usage\nTo install the MATLAB plugin for TLJH include `--plugin tljh-matlab` in the Installer Script.\nSee [Customizing the Installer](https://tljh.jupyter.org/en/latest/topic/customizing-installer.html) for more information.\n\nFor example, the following command sets up an `admin_user` with `admin_password` and installs `tljh-matlab`:\n```bash\ncurl -L https://tljh.jupyter.org/bootstrap.py\n  | sudo python3 - \\\n    --admin admin_user:admin_password \\\n    --plugin tljh-matlab\n```\n\n## Customization\nTo customize the default values used by the plugin, set the relevant environment variables before using the bootstrap command:\n\n| Environment Variable Name | Default Values | Notes |\n|---|---|---|\n| MATLAB_RELEASE             | R2024b                         | Specify the MATLAB release you would like to install. |\n| MATLAB_PRODUCT_LIST        | \"MATLAB Symbolic_Math_Toolbox\" | Specify a product by consulting the `--products` section of [MATLAB Package Manager](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md). For example, to install Simulink in addition to MATLAB, use `\"MATLAB Simulink\"`. |\n| MATLAB_INSTALL_DESTINATION | /opt/matlab/R2024b             | Specify the path to the location where you want to install MATLAB. |\n\n\nFor example, to customize the plugin to install MATLAB R2023b and Simulink, run:\n```bash\ncurl https://tljh.jupyter.org/bootstrap.py\n  | env MATLAB_RELEASE=R2023b MATLAB_PRODUCT_LIST=\"MATLAB Simulink\" \\\n    sudo python3 - \\\n    --admin admin_user:admin_password \\\n    --plugin tljh-matlab\n```\n\n----\n\nCopyright 2024 The MathWorks, Inc.\n\n----\n",
    "bugtrack_url": null,
    "license": "MATHWORKS CLOUD REFERENCE ARCHITECTURE LICENSE",
    "summary": "TLJH plugin for MATLAB",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/mathworks/jupyter-matlab-proxy/tree/main/install_guides/the-littlest-jupyterhub/tljh-matlab"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fb3cbc62961cfe8c806b51dbcf73e10ddd3b015c780bb4e7f544de7512797d32",
                "md5": "34a5900856250c0f5e4dfe34f28cac1f",
                "sha256": "5fed64657e1e703daa5d341b6fba7734d6d23b45a7bb3b1f2e4d2fa2f7abd4c2"
            },
            "downloads": -1,
            "filename": "tljh_matlab-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "34a5900856250c0f5e4dfe34f28cac1f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5740,
            "upload_time": "2024-11-26T06:37:13",
            "upload_time_iso_8601": "2024-11-26T06:37:13.241431Z",
            "url": "https://files.pythonhosted.org/packages/fb/3c/bc62961cfe8c806b51dbcf73e10ddd3b015c780bb4e7f544de7512797d32/tljh_matlab-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c49b48e093ad13bc2db673e17c00115beab7d34ce1b529afa8d7156be55d6cd4",
                "md5": "192261e6c7f04ac86e927becdb8d9239",
                "sha256": "ca146fce3d3857a0137be0c26f95b4755d0e797dd043e93eddb22bbd00aa58bb"
            },
            "downloads": -1,
            "filename": "tljh_matlab-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "192261e6c7f04ac86e927becdb8d9239",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4492,
            "upload_time": "2024-11-26T06:37:14",
            "upload_time_iso_8601": "2024-11-26T06:37:14.962526Z",
            "url": "https://files.pythonhosted.org/packages/c4/9b/48e093ad13bc2db673e17c00115beab7d34ce1b529afa8d7156be55d6cd4/tljh_matlab-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-26 06:37:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mathworks",
    "github_project": "jupyter-matlab-proxy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tljh-matlab"
}
        
Elapsed time: 1.18266s