{"id":26129480,"url":"https://github.com/mathworks-ref-arch/matlab-codespaces","last_synced_at":"2025-04-13T18:42:26.805Z","repository":{"id":249549724,"uuid":"823950609","full_name":"mathworks-ref-arch/matlab-codespaces","owner":"mathworks-ref-arch","description":"This repository show different ways you can configure your dev containers to run MATLAB in codespaces.","archived":false,"fork":false,"pushed_at":"2025-02-24T10:01:59.000Z","size":11010,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-27T09:23:37.991Z","etag":null,"topics":["codespaces","matlab"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mathworks-ref-arch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-04T04:34:56.000Z","updated_at":"2025-03-23T14:36:18.000Z","dependencies_parsed_at":"2024-07-21T19:44:44.871Z","dependency_job_id":"510dcd5b-f530-41c1-9b09-16767d83b68b","html_url":"https://github.com/mathworks-ref-arch/matlab-codespaces","commit_stats":null,"previous_names":["mathworks-ref-arch/matlab-codespaces"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathworks-ref-arch%2Fmatlab-codespaces","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathworks-ref-arch%2Fmatlab-codespaces/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathworks-ref-arch%2Fmatlab-codespaces/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mathworks-ref-arch%2Fmatlab-codespaces/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mathworks-ref-arch","download_url":"https://codeload.github.com/mathworks-ref-arch/matlab-codespaces/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248764822,"owners_count":21158160,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codespaces","matlab"],"created_at":"2025-03-10T19:49:02.551Z","updated_at":"2025-04-13T18:42:26.785Z","avatar_url":"https://github.com/mathworks-ref-arch.png","language":"Dockerfile","readme":"# Run MATLAB in GitHub Codespaces\n\nThis repository shows how to run MATLAB\u0026reg; in [GitHub\u0026trade; Codespaces](https://github.com/features/codespaces), so you can quickly start a development environment for developing the MATLAB code hosted in your Github repository.\n\n\n## Table of Contents\n- [When Should I Use MATLAB in Codespaces?](#when-should-i-use-matlab-in-codespaces)\n- [Choose a Configuration](#choose-a-configuration)\n- [Use MATLAB in Codespaces](#use-matlab-in-codespaces)\n  - [What Can I Do With MATLAB in VS Code?](#what-can-i-do-with-matlab-in-vs-code)\n  - [What Can I Do With MATLAB in JupyterLab?](#what-can-i-do-with-matlab-in-jupyterlab)\n- [Related Links](#related-links)    \n\n\n## When Should I Use MATLAB in Codespaces?\n\nA [codespace (GitHub Docs)](https://docs.github.com/en/codespaces/overview) is a development environment you run in the cloud. If you own a Github repository hosting MATLAB code, users of your repository can use Codespaces to:\n- Configure a consistent and customizable development environment.\n- Run MATLAB along with other software or programming languages.\n- Use Git to contribute back to your repository.\n\n## Choose a Configuration\n\nCodespaces run in Docker containers called development containers, or [dev containers (GitHub Docs)](https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers). You can customize how MATLAB is installed in your codespace by modifying the configuration file of the dev container, named `devcontainer.json`. Choose the configuration that corresponds to your desired use case.\n\n| Use Case  | Recommendation | Start Codespace Using Recommended Configuration |\n| ------------- | ------------- |------------- |\n|Use MATLAB only|Use a prebuilt [MATLAB Container on Docker Hub](https://hub.docker.com/r/mathworks/matlab). \u003cbr\u003e\u003cbr\u003eConfigure your codespace using this [devcontainer.json](.devcontainer/devcontainer.json).|[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/mathworks-ref-arch/matlab-codespaces?template=false\u0026devcontainer_path=.devcontainer%2Fdevcontainer.json)|\n|Customize MATLAB installation with specific toolboxes or other software|Create a custom MATLAB container image using [MATLAB Dockerfile](https://github.com/mathworks-ref-arch/matlab-dockerfile). You can see an example Dockerfile in the `.devcontainer/using-matlab-dockerfile` folder. \u003cbr\u003e\u003cbr\u003eConfigure your codespace using this [devcontainer.json](.devcontainer/using-matlab-dockerfile/devcontainer.json).|[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/mathworks-ref-arch/matlab-codespaces?template=false\u0026devcontainer_path=.devcontainer%2Fusing-matlab-dockerfile%2Fdevcontainer.json)|\n|Add MATLAB to an existing devcontainer configuration|Use the [MATLAB Feature for Devcontainers](https://github.com/mathworks/devcontainer-features/tree/main/src/matlab). \u003cbr\u003e\u003cbr\u003eConfigure your codespace using this [devcontainer.json](.devcontainer/using-devcontainer-feature/devcontainer.json).|[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/mathworks-ref-arch/matlab-codespaces?template=false\u0026devcontainer_path=.devcontainer%2Fusing-devcontainer-feature%2Fdevcontainer.json)||\n\n## Use MATLAB in Codespaces \n\nUse your MATLAB codespace to:\n- Run \u0026 Debug `.m` files in VS Code\n- Run MATLAB code in Jupyter Notebooks in both VS Code and JupyterLab\n- Switch to the MATLAB IDE to use more MATLAB features.\n\nBy default, your MATLAB codespace starts in a [Visual Studio Code](https://code.visualstudio.com/) environment, and MATLAB opens in a browser tab.\n\n![VSCode In Codespaces](img/VSCodeInCodespaces.png)\n\nFor details on using MATLAB in VS Code in your codespace, see [What Can I Do With MATLAB in VS Code?](#what-can-i-do-with-matlab-in-vs-code)\n\nFor details on using MATLAB in JupyterLab in your codespace, see [What Can I Do With MATLAB in JupyterLab?](#what-can-i-do-with-matlab-in-jupyterlab)\n\n\n\n\n### What Can I Do With MATLAB in VS Code?\n\nOnce you have MATLAB set up in your codespace, you can use VS Code to: \n\n1. **Run \u0026 Debug MATLAB files in the VS Code editor.**\u003c/br\u003e\n   \n   ![Run and Debug MATLAB in VS Code](img/RunAndDebugInVSCode.gif)\n   \n   For more information, see [MATLAB Extension for Visual Studio Code](https://github.com/mathworks/MATLAB-extension-for-vscode).\n\n\n2. **Access MATLAB in a browser tab.**\u003c/br\u003e\n\n   ![MATLAB Proxy](img/MATLABinBrowser.png)\n\n   For more information on using MATLAB in the browser, see [MATLAB Proxy](https://github.com/mathworks/matlab-proxy).\n\n3. **Run MATLAB code in Jupyter Notebooks within VS Code.**\u003c/br\u003e\n\n   You can run MATLAB code in Jupyter Notebooks, within the VS Code environment. For more information about VS Code support for Jupyter Notebooks, see [Jupyter Notebooks in VS Code (VS Code)](https://code.visualstudio.com/docs/datascience/jupyter-notebooks).\n   \n   ![Jupyter Notebook In VS Code](img/JupyterNotebookInVSCode.gif)\n\n\n### What Can I Do With MATLAB in JupyterLab?\n\nThe configurations in [Choose a Configuration](#choose-a-configuration) enable you to run MATLAB in JupyterLab as well as VS Code:\n\n![Open In JupyterLab](img/OpenInJupyterLab.gif)\n\n\nAfter opening JupyterLab in your codespace, you can:\n\n1. **Run MATLAB code in Jupyter Notebooks.**\u003c/br\u003e\n   \n   ![Run MATLAB code using Jupyter Notebooks](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterKernel.gif)\n\n2. **Access MATLAB in a browser window.**\u003c/br\u003e\n      \n   ![Access the MATLAB in a browser window](https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterMATLABDesktop.gif)\n\n\n## Related Links \n- [Overview of Codespaces (GitHub)](https://docs.github.com/en/codespaces/overview)\n- [Development Container Features (GitHub)](https://github.com/devcontainers/features/)\n- [Development Container Specification (Microsoft\u0026reg;)](https://containers.dev/implementors/spec/)\n- [Setting Your Default Editor for Codespaces (GitHub)](https://docs.github.com/en/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)\n- [Run Dev Containers in VS Code (VS Code Docs) ](https://code.visualstudio.com/docs/devcontainers/create-dev-container)\n\n---\n\nCopyright 2024-2025 The MathWorks, Inc.\n\n---\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathworks-ref-arch%2Fmatlab-codespaces","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathworks-ref-arch%2Fmatlab-codespaces","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathworks-ref-arch%2Fmatlab-codespaces/lists"}