Main Content

Project Setup

Organize work into projects, automate startup and shutdown, find frequent tasks, reuse standard template settings

Projects help you to organize large modeling projects by finding required files, managing and sharing files and settings, and interacting with source control. See What Are Projects? and watch Using Projects to Collaborate, Track, and Merge Changes and Perform Code Reviews (4 min, 50 sec).

Functions

expand all

currentProjectGet current project
openProjectLoad an existing project
closeClose project
exportExport project to archive
matlab.project.extractProjectExtract project from archive (Since R2022b)
matlab.project.createProjectCreate blank project
matlab.project.convertDefinitionFilesChange definition file type of project (Since R2020b)
matlab.project.deleteProjectStop folder management and delete project definition files (Since R2019b)
matlab.project.loadProjectLoad project
matlab.project.rootProjectGet root project
Simulink.createFromTemplateCreate model or project from template
Simulink.findTemplatesFind model or project templates with specified properties
Simulink.exportToTemplateCreate template from model or project

Legacy API

simulinkproject(Not recommended) Open project and get project object
slproject.create(Not recommended) Create blank project
slproject.getCurrentProjects(Not recommended) List all top-level projects
slproject.loadProject(Not recommended) Load project
addFileAdd file or folder to project
addFolderIncludingChildFilesAdd folder and child files to project
addPathAdd folder to project path
addReferenceAdd referenced project to project
addShortcutAdd shortcut to project
addShutdownFileAdd shutdown file to project
addStartupFileAdd startup file to project
findFileFind single project file by name
findFilesFind project files by category or label name (Since R2024a)
isLoadedDetermine if project is loaded
reloadReload project
removeFileRemove file or folder from project
removePathRemove folder from project path
removeReferenceRemove project reference
removeShortcutRemove shortcut from project
removeShutdownFileRemove shutdown file from project shutdown list
removeStartupFileRemove startup file from project startup list

Legacy API

simulinkproject(Not recommended) Open project and get project object

Topics

Project Creation

Startup and Shutdown Automation

  • Specify Project Path
    The project can manage your path automatically when you open and close projects.
  • Automate Startup Tasks
    In a project, startup files help you set up the environment for your project.
  • Automate Shutdown Tasks
    In a project, shutdown files help you clean up the environment for the current project when you close it.

Frequent Task Shortcuts

Project Template Creation

About Projects

  • What Are Projects?
    Use projects to help you organize your work. Find all your required files; manage and share files, settings, and user-defined tasks; and interact with source control.
  • What Can You Do with Project Shortcuts?
    In a project, use shortcuts to make it easy for any project user to find and access important files and operations.
  • Sharing Projects
    Collaborate by sharing projects by email, archive file, template, MATLAB toolbox, or on GitHub®.