Skip to content

Commit

Permalink
Updated references to MATLAB release versions from r2023a to r2023b
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelmcdonnellmw authored and Prabhakar Kumar committed Sep 14, 2023
1 parent fb1b69f commit 58f936f
Show file tree
Hide file tree
Showing 12 changed files with 44 additions and 44 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/README-from-matlab-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ This workflow consists of the following steps:

---

Copyright (c) 2023 The MathWorks, Inc. All rights reserved.
Copyright 2023 The MathWorks, Inc. All rights reserved.

---
2 changes: 1 addition & 1 deletion .github/workflows/README-matlab-installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ This workflow consists of the following steps:

---

Copyright (c) 2023 The MathWorks, Inc. All rights reserved.
Copyright 2023 The MathWorks, Inc. All rights reserved.

---
2 changes: 1 addition & 1 deletion .github/workflows/build-test-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
strategy:
fail-fast: false
matrix:
matlab-release: [r2023a, r2022b, r2022a, r2021b, r2021a, r2020b]
matlab-release: [r2023b, r2023a, r2022b, r2022a, r2021b, r2021a, r2020b]

steps:
- name: Checkout repo
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/from-matlab-docker-build-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
strategy:
fail-fast: false
matrix:
matlab-release: [r2023a, r2022b, r2022a]
matlab-release: [r2023b, r2023a, r2022b, r2022a]

steps:
- name: Checkout repo
Expand Down
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
# install, and the location at which to install MATLAB.

# Here is an example docker build command with the optional build arguments.
# docker build --build-arg MATLAB_RELEASE=r2023a
# docker build --build-arg MATLAB_RELEASE=r2023b
# --build-arg MATLAB_PRODUCT_LIST="MATLAB Deep_Learning_Toolbox Symbolic_Math_Toolbox"
# --build-arg MATLAB_INSTALL_LOCATION="/opt/matlab/R2023a"
# --build-arg MATLAB_INSTALL_LOCATION="/opt/matlab/R2023b"
# --build-arg [email protected]
# -t my_matlab_image_name .

# To specify which MATLAB release to install in the container, edit the value of the MATLAB_RELEASE argument.
# Use lowercase to specify the release, for example: ARG MATLAB_RELEASE=r2021b
ARG MATLAB_RELEASE=r2023a
ARG MATLAB_RELEASE=r2023b

# Specify the list of products to install into MATLAB.
ARG MATLAB_PRODUCT_LIST="MATLAB"
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The files in this GitHub repository refer to commercial software products and se

The following license terms apply only to the files in this GitHub repository, including files in this folder and its subfolders, and do not apply to MathWorks Programs. References to “software” and “code” in the following license terms refer to the files in this GitHub repository.

Copyright (c) 2020, The MathWorks, Inc.
Copyright 2020, The MathWorks, Inc.

All rights reserved.

Expand Down
12 changes: 6 additions & 6 deletions MPM.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,24 +34,24 @@ For the MATLAB Dependencies, refer to `base-dependencies.txt` files in the [MATL

### Install MATLAB, Simulink, and Additional Products

To install MATLAB R2023a, Simulink, and Signal Processing Toolbox to the default folder, navigate to the folder containing the `mpm` binary file and run the following command.
To install MATLAB R2023b, Simulink, and Signal Processing Toolbox to the default folder, navigate to the folder containing the `mpm` binary file and run the following command.

./mpm install --release=R2023a --products MATLAB Simulink Signal_Processing_Toolbox
./mpm install --release=R2023b --products MATLAB Simulink Signal_Processing_Toolbox

You can install further products later. For example, add Robotics System Toolbox to the MATLAB installation.

./mpm install --release=R2023a --products Robotics_System_Toolbox
./mpm install --release=R2023b --products Robotics_System_Toolbox


### Install MATLAB and Specify Installation Options

Install MATLAB R2023a, specifying these installation options:
Install MATLAB R2023b, specifying these installation options:

- Set the installation destination folder to `/home/username/matlab`.
- Install Parallel Computing Toolbox without the GPU libraries.

```
./mpm install --release=R2023a --destination=/home/username/matlab --products MATLAB Parallel_Computing_Toolbox --no-gpu
./mpm install --release=R2023b --destination=/home/username/matlab --products MATLAB Parallel_Computing_Toolbox --no-gpu
```

Download a documentation ISO from [Install Documentation on Offline Machines](https://www.mathworks.com/help/install/ug/install-documentation-on-offline-machines.html) and mount the ISO. Install the documentation and examples, specifying the MATLAB installation folder and the path to the mounted ISO.
Expand All @@ -67,7 +67,7 @@ Download a documentation ISO from [Install Documentation on Offline Machines](ht
## Installation Options
| Option | Description | Example |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ |
| `--release` | Software version to install. This option supports releases and updates. To install the latest version of a release, specify the release version (for example, `R2022b`). To install a specific update release, specify the release version with an update number suffix (for example, `R2022bU4`). To a version without updates, specify the release version with an update 0 or general release suffix (for example, `R2022bU0` or `R2022bGR`). | `R2023a`, `R2022bU2`, `R2022GR` |
| `--release` | Software version to install. This option supports releases and updates. To install the latest version of a release, specify the release version (for example, `R2023b`). To install a specific update release, specify the release version with an update number suffix (for example, `R2023bU4`). To a version without updates, specify the release version with an update 0 or general release suffix (for example, `R2023bU0` or `R2023bGR`). | `R2023b`, `R2023bU2`, `R2023bGR` |
| `--products` | List of products to install, specified as product names separated by spaces. MATLAB Package Manager can install most MathWorks products. For the full list of correctly formatted product names, download the [MathWorks Product Installer](https://www.mathworks.com/help/install/ug/install-noninteractively-silent-installation.html) and refer to the `installer_input.txt` file included in it. Alternatively, see [Products and Services](https://www.mathworks.com/products.html) for product names in the current MATLAB release and replace spaces in names with underscores. For more information on which products MATLAB Package manager can not install, see [Limitations](#limitations). | `MATLAB Simulink Deep_Learning_Toolbox Fixed-Point_Designer` |
| `--destination` | Full path to the desired installation folder. Defaults to `/usr/share/matlab` if unset. | `/path/to/destination` |
| `--source` | Full path to downloaded product files (optional). MATLAB Package Manager downloads the product files if unset. | `/path/to/source` |
Expand Down
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ cd matlab-dockerfile

Build container with a name and tag of your choice.
```bash
docker build -t matlab:r2023a .
docker build -t matlab:r2023b .
```

Run the container. Test the container by running an example MATLAB command such as ver.
```bash
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:r2023a -batch ver
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:r2023b -batch ver
```
The [Dockerfile](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/Dockerfile) defaults to building a container for MATLAB R2023a.
The [Dockerfile](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/Dockerfile) defaults to building a container for MATLAB R2023b.

The example command `ver` displays the version number of MATLAB and other installed products. For more information, see [ver](https://www.mathworks.com/help/matlab/ref/ver.html). For more information on running the container, see the section on [Running the Container](#run-the-container).

Expand All @@ -57,9 +57,9 @@ The [Dockerfile](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/ma

| Argument Name | Default value | Description |
|---|---|---|
| [MATLAB_RELEASE](#build-an-image-for-a-different-release-of-matlab) | r2023a | The MATLAB release you want to install, in lower-case. For example: `r2019b`|
| [MATLAB_RELEASE](#build-an-image-for-a-different-release-of-matlab) | r2023b | The MATLAB release you want to install, in lower-case. For example: `r2019b`|
| [MATLAB_PRODUCT_LIST](#build-an-image-with-a-specific-set-of-products) | MATLAB | Products to install as a space-separated list. For more information, see [MPM.md](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/main/MPM.md). For example: `MATLAB Simulink Deep_Learning_Toolbox Fixed-Point_Designer`|
| [MATLAB_INSTALL_LOCATION](#build-an-image-with-matlab-installed-to-a-specific-location) | /opt/matlab/r2023a | The path to install MATLAB. |
| [MATLAB_INSTALL_LOCATION](#build-an-image-with-matlab-installed-to-a-specific-location) | /opt/matlab/r2023b | The path to install MATLAB. |
| [LICENSE_SERVER](#build-an-image-with-license-server-information) | *unset* | The port and hostname of the machine that is running the Network License Manager, using the `port@hostname` syntax. For example: `27000@MyServerName` |

Use these arguments with the the `docker build` command to customize your image.
Expand All @@ -74,24 +74,24 @@ docker build --build-arg MATLAB_RELEASE=r2019b -t matlab:r2019b .
#### Build an Image with a specific set of products
For example, to build an image with MATLAB and Simulink, use this command.
```bash
docker build --build-arg MATLAB_PRODUCT_LIST='MATLAB Simulink' -t matlab:r2023a .
docker build --build-arg MATLAB_PRODUCT_LIST='MATLAB Simulink' -t matlab:r2023b .
```

#### Build an Image with MATLAB installed to a specific location
For example, to build an image with MATLAB installed at /opt/matlab, use this command.
```bash
docker build --build-arg MATLAB_INSTALL_LOCATION='/opt/matlab' -t matlab:r2023a .
docker build --build-arg MATLAB_INSTALL_LOCATION='/opt/matlab' -t matlab:r2023b .
```

#### Build an Image with License Server Information

Including the license server information with the `docker build` command means you do not have to pass it when running the container.
```bash
# Build container with the License Server.
docker build --build-arg LICENSE_SERVER=27000@MyServerName -t matlab:r2023a .
docker build --build-arg LICENSE_SERVER=27000@MyServerName -t matlab:r2023b .

# Run the container, without needing to pass license information.
docker run --init --rm matlab:r2023a -batch ver
docker run --init --rm matlab:r2023b -batch ver
```

## Use the Network License Manager
Expand Down Expand Up @@ -124,7 +124,7 @@ With the `docker build` command, either:

```bash
# Example
docker build -t matlab:r2023a --build-arg LICENSE_SERVER=27000@MyServerName .
docker build -t matlab:r2023b --build-arg LICENSE_SERVER=27000@MyServerName .
```
- Use the `network.lic` file:
1. Place the `network.lic` file in the same folder as the Dockerfile.
Expand All @@ -133,41 +133,41 @@ With the `docker build` command, either:

```bash
# Example
docker build -t matlab:r2023a .
docker build -t matlab:r2023b .
```

With the `docker run` command, use the `MLM_LICENSE_FILE` environment variable. For example:

```bash
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:r2023a -batch ver
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:r2023b -batch ver
```

## Run the Container
If you did not provide the license server information when building the image, then provide it when running the container. Set the environment variable `MLM_LICENSE_FILE` using the `-e` flag, with the network license manager's location in the format `port@hostname`.
```bash
# Start MATLAB, print version information, and exit:
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:r2023a -batch ver
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab:r2023b -batch ver
```
You can run the container **without** specifying `MLM_LICENSE_FILE` if you provided the license server information when building the image, as shown in the examples below.
### Run MATLAB in an Interactive Command Prompt
To start the container and run MATLAB in an interactive command prompt, execute:
```bash
docker run --init -it --rm matlab:r2023a
docker run --init -it --rm matlab:r2023b
```
### Run MATLAB in Batch Mode
To start the container, run a MATLAB command, and then exit, execute:
```bash
# Container runs the command RAND in MATLAB and exits.
docker run --init --rm matlab:r2023a -batch rand
docker run --init --rm matlab:r2023b -batch rand
```
### Run MATLAB with Startup Options
To override the default behavior of the container and run MATLAB with any set of arguments, such as `-logfile`, execute:
```bash
docker run --init -it --rm matlab:r2023a -logfile "logfilename.log"
docker run --init -it --rm matlab:r2023b -logfile "logfilename.log"
```
To learn more, see the documentation: [Commonly Used Startup Options](https://www.mathworks.com/help/matlab/matlab_env/commonly-used-startup-options.html).
Expand All @@ -191,7 +191,7 @@ For some workflows and toolboxes, you must specify dependencies. You must do thi
* Use the MATLAB Engine API for C and Fortran.
* Use the Polyspace 32-bit tcc compiler.
The [matlab-deps repository](https://github.com/mathworks-ref-arch/container-images/tree/main/matlab-deps) repository lists Dockerfiles for various releases and platforms. [Click here to view the Dockerfile for R2023a](https://github.com/mathworks-ref-arch/container-images/blob/main/matlab-deps/r2023a/ubuntu20.04/Dockerfile).
The [matlab-deps repository](https://github.com/mathworks-ref-arch/container-images/tree/main/matlab-deps) repository lists Dockerfiles for various releases and platforms. [Click here to view the Dockerfile for R2023b](https://github.com/mathworks-ref-arch/container-images/blob/main/matlab-deps/r2023b/ubuntu22.04/Dockerfile).
These Dockerfiles contain commented lines with the libraries that support these additional capabilities. Copy and uncomment these lines into your Dockerfile.
Expand All @@ -208,6 +208,6 @@ We encourage you to try this repository with your environment and provide feedba
----
Copyright (c) 2021-2023 The MathWorks, Inc. All rights reserved.
Copyright 2021-2023 The MathWorks, Inc. All rights reserved.
----
2 changes: 1 addition & 1 deletion alternates/building-on-matlab-docker-image/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# To specify which MATLAB release to install in the container, edit the value of the MATLAB_RELEASE argument.
# Use lower case to specify the release, for example: ARG MATLAB_RELEASE=r2021b
ARG MATLAB_RELEASE=r2023a
ARG MATLAB_RELEASE=r2023b

# Specify the extra toolboxes to install into the image.
ARG ADDITIONAL_PRODUCTS="Symbolic_Math_Toolbox Statistics_and_Machine_Learning_Toolbox"
Expand Down
16 changes: 8 additions & 8 deletions alternates/building-on-matlab-docker-image/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ cd matlab-dockerfile/alternates/building-on-matlab-docker-image
### Quick start
Build a container with a name and tag.
```bash
docker build -t matlab_with_toolboxes:r2023a .
docker build -t matlab_with_toolboxes:r2023b .
```

You can then run the container with the "batch" option. Test the container by running an example MATLAB command such as `ver` to display the installed toolboxes.
```bash
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab_with_toolboxes:r2023a -batch ver
docker run --init --rm -e MLM_LICENSE_FILE=27000@MyServerName matlab_with_toolboxes:r2023b -batch ver
```

You can also run the container with the "browser" option to access MATLAB in a browser.
```bash
docker run --init --rm -it -p 8888:8888 matlab_with_toolboxes:r2023a -browser
docker run --init --rm -it -p 8888:8888 matlab_with_toolboxes:r2023b -browser
```
For more information, see [Run the Container](#run-the-container).

Expand All @@ -50,7 +50,7 @@ The `ADDITIONAL_PRODUCTS` argument must be a space separated list surrounded by
By default, `ADDITIONAL_PRODUCTS` includes two example toolboxes, which you can replace.
For example, to build an image containing MATLAB and the Deep Learning Toolbox:
```bash
docker build --build-arg ADDITIONAL_PRODUCTS="Deep_Learning_Toolbox" -t matlab_with_toolboxes:r2023a .
docker build --build-arg ADDITIONAL_PRODUCTS="Deep_Learning_Toolbox" -t matlab_with_toolboxes:r2023b .
```

For a successful build, include at least one product.
Expand All @@ -64,7 +64,7 @@ The [Dockerfile](https://github.com/mathworks-ref-arch/matlab-dockerfile/blob/ma

| Argument Name | Default value | Effect |
|---|---|---|
| [MATLAB_RELEASE](#build-an-image-for-a-different-release-of-matlab) | r2023a | The MATLAB release to install. Must be lower-case, for example: `r2020b`.|
| [MATLAB_RELEASE](#build-an-image-for-a-different-release-of-matlab) | r2023b | The MATLAB release to install. Must be lower-case, for example: `r2020b`.|
| [ADDITIONAL_PRODUCTS](#customize-products-to-install-using-matlab-package-manager-mpm) | "Symbolic_Math_Toolbox Statistics_and_Machine_Learning_Toolbox" | A space separated list of toolboxes to install. |
| [LICENSE_SERVER](#build-an-image-with-license-server-information) | *unset* | The port and hostname of a machine that is running a Network License Manager, using the `port@hostname` syntax. For example: `27000@MyServerName`. To use this build argument, the corresponding lines must be uncommented in the Dockerfile. |

Expand All @@ -87,12 +87,12 @@ server or browser mode will not start successfully.

Build container with the License Server.
```bash
docker build -t matlab_with_toolboxes:r2023a --build-arg LICENSE_SERVER=27000@MyServerName .
docker build -t matlab_with_toolboxes:r2023b --build-arg LICENSE_SERVER=27000@MyServerName .
```

Run the container, without needing to pass license information.
```bash
docker run --init matlab_with_toolboxes:r2023a -batch ver
docker run --init matlab_with_toolboxes:r2023b -batch ver
```
## Run the Container
The Docker container you build using this Dockerfile inherits run options from its base image.
Expand All @@ -117,6 +117,6 @@ We encourage you to try this repository with your environment and provide feedba

----

Copyright (c) 2023 The MathWorks, Inc. All rights reserved.
Copyright 2023 The MathWorks, Inc. All rights reserved.

----
2 changes: 1 addition & 1 deletion alternates/matlab-installer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# To specify which MATLAB release you wish to install in the container, edit the value of the MATLAB_RELEASE argument.
# Use lower case to specify the release.
ARG MATLAB_RELEASE=r2023a
ARG MATLAB_RELEASE=r2023b

FROM ubuntu as versioner

Expand Down
Loading

0 comments on commit 58f936f

Please sign in to comment.