xref: /petsc/src/sys/fileio/smatlab.c (revision e8e8640d1cb9a3a2f50c0c0d7b26e5c4d521e2e4)

#include <petscsys.h>

/*@C
  PetscStartMatlab - starts up MATLAB with a MATLAB script

  Logically Collective, but only MPI rank 0 in the communicator does anything

  Input Parameters:
+ comm    - MPI communicator
. machine - optional machine to run MATLAB on
- script  - name of script (without the .m)

  Output Parameter:
. fp - a file pointer returned from `PetscPOpen()`

  Level: intermediate

  Notes:
  This starts up a "regular" MATLAB interactive session, it does not start the MATLAB Engine, this is controlled with `PetscMatlabEngine`

  Warning, this overwrites your `matlab/startup.m` file

  The script must be in your MATLAB path or current directory

.seealso: `PetscPOpen()`, `PetscPClose()`, `PetscMatlabEngine`
@*/
PetscErrorCode PetscStartMatlab(MPI_Comm comm, const char machine[], const char script[], FILE **fp)
{
  FILE *fd;
  char  command[512];
#if defined(PETSC_HAVE_UCBPS) && defined(PETSC_HAVE_POPEN)
  char        buf[1024], *found;
  PetscMPIInt rank;
#endif

  PetscFunctionBegin;
#if defined(PETSC_HAVE_UCBPS) && defined(PETSC_HAVE_POPEN)
  /* check if MATLAB is not already running */
  PetscCall(PetscPOpen(comm, machine, "/usr/ucb/ps -ugxww | grep matlab | grep -v grep", "r", &fd));
  PetscCallMPI(MPI_Comm_rank(comm, &rank));
  if (rank == 0) found = fgets(buf, 1024, fd);
  PetscCallMPI(MPI_Bcast(&found, 1, MPI_CHAR, 0, comm));
  PetscCall(PetscPClose(comm, fd));
  if (found) PetscFunctionReturn(PETSC_SUCCESS);
#endif

  if (script) {
    /* the remote machine won't know about current directory, so add it to MATLAB path */
    /* the extra \" are to protect possible () in the script command from the shell */
    PetscCall(PetscSNPrintf(command, PETSC_STATIC_ARRAY_LENGTH(command), "echo \"delete ${HOMEDIRECTORY}/matlab/startup.m ; path(path,'${WORKINGDIRECTORY}'); %s  \" > ${HOMEDIRECTORY}/matlab/startup.m", script));
#if defined(PETSC_HAVE_POPEN)
    PetscCall(PetscPOpen(comm, machine, command, "r", &fd));
    PetscCall(PetscPClose(comm, fd));
#endif
  }
#if defined(PETSC_HAVE_POPEN)
  PetscCall(PetscPOpen(comm, machine, "xterm -display ${DISPLAY} -e matlab -nosplash", "r", fp));
#endif
  PetscFunctionReturn(PETSC_SUCCESS);
}