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?.

Functions

expand all

currentProjectGet current project
openProjectLoad an existing project
closeClose project
exportExport project to archive
matlab.project.createProjectCreate blank project
matlab.project.convertDefinitionFilesChange definition file type of project
matlab.project.deleteProjectStop folder management and delete project definition files
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
close(Not recommended) Close project
export(Not recommended) Export project to zip
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 project file by name
isLoadedDetermine if project is loaded
reloadReload project
removeFileRemove file 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

addFile(Not recommended) Add file to project
addFolderIncludingChildFiles(Not recommended) Add folder and child files to project
addPath(Not recommended) Add folder to path of project
addReference(Not recommended) Add referenced project to project
addShortcut(Not recommended) Add shortcut to project
addShutdownFile(Not recommended) Add shutdown file to project
addStartupFile(Not recommended) Add startup file to project
findFile(Not recommended) Get project file by name
isLoaded(Not recommended) Determine if project is loaded
reload(Not recommended) Reload project
removeFile(Not recommended) Remove file from project
removePath(Not recommended) Remove folder from project path
removeReference(Not recommended) Add folder to project path
removeShortcut(Not recommended) Remove shortcut from project
removeShutdownFile​(Not recommended) Remove shutdown file from project shutdown list
removeStartupFile(Not recommended) Remove startup file from project startup list

Topics

Project Creation

Create a New Project From a Folder

Automatic project creation: Easily turn a folder to a project and manage your files, data, and environment in one place.

Create a Project from a Model

Create a project to organize your model and any dependent files. Simulink® runs dependency analysis on your model to identify required files and a project root location that contains all dependencies.

Add Files to the Project

Add files in the project files view or programmatically.

Create a New Project from an Archived Project

Create a new project from an archived project.

Create a New Project Using Templates

In a project, use templates to create and reuse a standard project structure.

Open Recent Projects

Open recent projects from MATLAB® or Simulink.

Specify Project Details, Startup Folder, and Derived Files Folders

View and edit details such as the name, description, project root, startup folder, and generated files folders.

Explore Project Tools with the Airframe Project

Try an example project to see how the tools can help you organize your work.

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

Create Shortcuts to Frequent Tasks

In a project, create shortcuts for common project tasks and to make it easy to find and access important files and operations.

Use Shortcuts to Find and Run Frequent Tasks

In a project, use shortcuts to make it easy for any project user to find and access important files and operations.

Project Template Creation

Create Templates for Standard Project Settings

To reuse scripts and files for a standard project setup, create templates from projects, edit templates, or explore example templates.

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®.

Featured Examples

Using a Project

Using a Project

Use an existing project to manage the files within your design. It shows how to automate startup and shutdown tasks, add shortcuts for common tasks, run checks, upgrade project files, analyze project dependencies, and share your project.

Open Live Script
Create and Reference a Project Programmatically

Create and Reference a Project Programmatically

Programmatically create a new project and add it as a reference project in your main project. It covers how to create a project from the command line, add files and folders, set up the project path, define project shortcuts and create a reference to the new project in another project.

Open Live Script
Using a Project with Git

Using a Project with Git

Use a project to manage the files within your design. Starting with an existing project that is already checked into source control, this example shows how to view modified files, compare file revisions, and analyze project dependencies.

Open Live Script

Simulink Documentation

Support