.. include:: /fillers/links.rst .. include:: /fillers/contacts.rst .. _matlab: MATLAB ============ For help with running MATLAB on Compute1, you can contact |matlab-contact|. Set up the MATLAB license ------------------------- Prerequisite for using MATLAB is to setup the MATLAB license. Shown below is the step that must be taken to setup the license for MATLAB. You only need to set it up one time. SSH in to Compute1: .. code-block:: console $ ssh wustlkey@compute1-client-1.ris.wustl.edu Modify :code:`LSF_DOCKER_VOLUMES` in :literal:`~/lsf-conf.rc`. Recall :code:`LSF_DOCKER_VOLUMES` is a space-separated list of :literal:`path1:path2` pairs, specifying directories on Storage1 that are :term:`mounted ` in your container: :literal:`path1` the directory on Storage1 and :literal:`path2` is where it is mounted in your container. You need to add the following :literal:`path1:path2` pair to :code:`LSF_DOCKER_VOLUMES` in :literal:`~/lsf-conf.rc`: :literal:`/storage1/fs1/rvmartin/Active/tools/matlab-2019a/licenses:$HOME/.matlab/R2019b_licenses` Add the following line to the end of your :literal:`~/.bashrc` file to make sure you have :literal:`/usr/local/bin` in your :code:`PATH`: .. code-block:: none export PATH=$PATH:/usr/local/bin Running MATLAB interactively in terminal ---------------------------------------- Shown below is the quick-start guide to start MATLAB in a terminal. SSH in to Compute1: .. code-block:: console $ ssh wustlkey@compute1-client-1.ris.wustl.edu Get a compute exec node terminal: .. code-block:: console [wustlkey@compute1-client-1 ~]$ compute1-terminal /bin/bash .. note:: You might need to specify :literal:`-G` option if you are belonging to multiple compute groups. .. note:: You can specify :literal:`-M` and :literal:`-R` option to request x GB of memory. For example, to request for 64GB, :code:`compute1-terminal -M 64GB -R 'rusage[mem=64GB]' /bin/bash` Use software modules to load the environment for running MATLAB .. code-block:: none [wustlkey@compute1-exec-123 ~]$ module avail matlab -------------- /act/modulefiles ------------------------------- matlab matlab_R2019b The matlab module is a short-cut to the latest version. If you wanted to use a specific version, you'll do: .. code-block:: none [wustlkey@compute1-exec-123 ~]$ module load matlab_R2019b You can then run the matlab command directly: .. code-block:: none [wustlkey@compute1-exec-123 ~]$ matlab MATLAB is selecting SOFTWARE OPENGL rendering. Running MATLAB interactively in noVNC session --------------------------------------------- Shown below is the quick-start guide to start MATLAB in a noVNC session. SSH in to Compute1: .. code-block:: console $ ssh wustlkey@compute1-client-1.ris.wustl.edu Get a noVNC session. You will get the output similar to the following if this is your firsttime using noVNC. It will generate a random password for you indicated by line with “Your password for noVNC is:”. .. code-block:: none [wustlkey@compute1-client-1 ~]$ compute1-gui-desktop Created password for your noVNC web login. Your password for noVNC is: PRhtO6O2PwM= Please use the password below to login to the noVNC session. If you want to pick your own password, you can simply set the environment variable VNC_PW with you own password. Job <627984> is submitted to queue . You can access your compute1 desktop with the URL https://compute1-exec-86.compute.ris.wustl.edu:8901/vnc.html?resize=remote .. note:: You might need to specify :literal:`-G` option if you are belonging to multiple compute groups. .. note:: You can specify ``-n`` option to request x number of processes. For example, to request for 16 CPU, ``compute1-gui-desktop -n 16 /bin/bash`` .. note:: You can specify :literal:`-M` and :literal:`-R` option to request x GB of memory. For example, to request for 64GB, :code:`compute1-terminal -M 64GB -R 'rusage[mem=64GB]' /bin/bash` .. note:: The password and URL above are only for illustration only. You might get different password and URL. .. note:: You can prepend to the command “compute-gui-desktop” with VNC_PW= to set your own password for noVNC. Please replace “” with your custom password. Open a browser and copy-and-paste the URL from the step #2 above. The URL is at the line with the wording “You can access your compute1 desktop with the URL”. .. note:: It might have some delay to setup the noVNC session at the compute execution node. Normally, it will take less than 30 seconds. If it is not presenting the noVNC session page after a minute, please put in a ticket to RIS service desk: |ris-open-a-ticket|. Login to the noVNC session from the noVNC session page. Please click on the “Connect” button indicated by the red arrow. Then, please put in the password from step#2 .. image:: /images/matlab1.png :width: 100% :alt: Image of noVNC login Get a noVNC session terminal by clicking on the terminal icon as indicated by the red arrow as shown below .. image:: /images/matlab2.png :width: 100% :alt: Image 2 of matlab instructions Use software modules to load the environment for running MATLAB. .. code-block:: none [wustlkey@compute1-exec-123 ~]$ module avail matlab -------------- /act/modulefiles ------------------------------- matlab matlab_R2019b The matlab module is a short-cut to the latest version. If you wanted to use a specific version, you’ll do: .. code-block:: none [wustlkey@compute1-exec-123 ~]$ module load matlab_R2019b You can then run the matlab command directly: .. code-block:: none [wustlkey@compute1-exec-123 ~]$ matlab MATLAB is selecting SOFTWARE OPENGL rendering. Running MATLAB noninteractively in terminal ------------------------------------------- * RIS has created a MATLAB container (:code:`docker(gcr.io/ris-registry-shared/matlab)`), which you can use to submit batch MATLAB jobs * Need to add MATLAB path (:code:`/scratch1/fs1/ris/application/:/scratch1/fs1/ris/application/`) to :code:`LSF_DOCKER_VOLUMES` in your :code:`lsf-conf.rc` * Also add it to your :code:`$PATH` by :code:`export PATH=/scratch1/fs1/ris/application/matlab/2021b/bin/:$PATH` * Using MATLAB command noninteractively: :code:`matlab -nodesktop -nodisplay -sd "${your_code_directory}" -r "${run_script_without_.m}; exit"` An example: .. code-block:: none #BSUB -n 10 #BSUB -R "rusage[mem=300G] span[hosts=1] select[mem < 500GB] order[-slots]" #BSUB -q rvmartin #BSUB -a 'docker(gcr.io/ris-registry-shared/matlab)' #BSUB -N #BSUB -u @wustl.edu #BSUB -o joblog.txt #BSUB -J "Plot frame" cd /my-projects2/code/GCHP-v13.4.1/c720_animation matlab -nodesktop -nodisplay -sd "/my-projects2/code/GCHP-v13.4.1/c720_animation" -r "Plot_C720_HTAPv3_AOD_Species_201801_frame; exit"