Octave for Microsoft Windows: Difference between revisions

Jump to navigation Jump to search
updated details for Octave 7.1.0
(updated details for Octave 7.1.0)
Line 15: Line 15:
* For the 7z/zip archives:  
* For the 7z/zip archives:  
# Extract the file content to a directory on the harddrive (such as {{Path|C:\Octave}}). Spaces or non-ASCII characters in the path are discouraged and may cause program errors.
# Extract the file content to a directory on the harddrive (such as {{Path|C:\Octave}}). Spaces or non-ASCII characters in the path are discouraged and may cause program errors.
# Manually create a shortcut to the {{Path|octave.vbs}} file in the main installation directory. (Right-click on the file, select 'Create Shortcut', and move the new shortcut to your desired location.)  
# Manually create a shortcut to the {{Path|octave-launch.exe}} file in the main installation directory. (Right-click on the file, select 'Create Shortcut', and move the new shortcut to your desired location.)  
# If a command-line only instance of Octave is desired, the user can create another shortcut as stated above, right-click on the shortcut, select Properties, and add <code>--no-gui</code> to the end of the Target field.
# If a command-line only instance of Octave is desired, the user can create another shortcut as stated above, right-click on the shortcut, select Properties, and add <code>--no-gui</code> to the end of the Target field.
# IMPORTANT: Run the {{Path|post-install.bat}} file before running Octave the first time to reduce plot delays due to the Windows font cache and make the pre-installed packages visible to the system.
# IMPORTANT: Run the {{Path|post-install.bat}} file before running Octave the first time to reduce plot delays due to the Windows font cache and make the pre-installed packages visible to the system.


* note: users who have problems running .vbs files due to local security policy or software can instead make a shortcut to the {{Path|octave.bat}} file located in {{Path|\mingw32\bin}} or {{Path|\mingw64\bin}}, depending on the version of Octave installed.  
* Note: versions before 7.1.0 used .vbs and .bat files to start Octave.  The {{Path|octave.bat}} file is still available in {{Path|\mingw32\bin}} or {{Path|\mingw64\bin}}, depending on the version of Octave installed, for use cases requiring it for startup.  


==Octave Packages==
==Octave Packages==
Line 37: Line 37:
   >> pkg list
   >> pkg list


The output for preinstalled global packages included with version 6.4.0 when installed into {{Path|C:\Octave}} is:
The output for preinstalled global packages included with version 7.1.0 when installed into {{Path|C:\Octave}} is:


     Package Name        | Version | Installation directory
     Package Name        | Version | Installation directory
     ---------------------+---------+-----------------------
     ---------------------+---------+-----------------------
                   audio  |  2.0.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\audio-2.0.3
                   audio  |  2.0.4 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\audio-2.0.4
        communications 1.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\communications-1.2.3
                biosig 2.4.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\audio-2.4.0
                control 3.3.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\control-3.3.1
        communications 1.2.4 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\communications-1.2.4
        data-smoothing 1.3.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\data-smoothing-1.3.0
                control |  3.4.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\control-3.4.0
              database 2.4.4 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\database-2.4.4
        data-smoothing 1.3.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\data-smoothing-1.3.0
              dataframe 1.2.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\dataframe-1.2.0
              database 2.4.4 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\database-2.4.4
                  dicom 0.4.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\dicom-0.4.0
              dataframe 1.2.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\dataframe-1.2.0
              financial |  0.5.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\financial-0.5.3
                  dicom |  0.4.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\dicom-0.4.1
                  fits 1.0.7 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\fits-1.0.7
              financial 0.5.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\financial-0.5.3
    fuzzy-logic-toolkit |  0.4.6 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\fuzzy-logic-toolkit-0.4.6
                  fits 1.0.7 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\fits-1.0.7
                    ga  |  0.10.2 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\ga-0.10.2
    fuzzy-logic-toolkit 0.4.6 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\fuzzy-logic-toolkit-0.4.6
                general |   2.1.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\general-2.1.1
                    ga | 0.10.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\ga-0.10.3
          generate_html 0.3.2 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\generate_html-0.3.2
                general 2.1.2 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\general-2.1.2
              geometry 4.0.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\geometry-4.0.0
          generate_html 0.3.2 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\generate_html-0.3.2
                    gsl 2.1.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\gsl-2.1.1
              geometry 4.0.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\geometry-4.0.0
                  image | 2.12.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\image-2.12.0
                    gsl |   2.1.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\gsl-2.1.1
    instrument-control |   0.7.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\instrument-control-0.7.0
                  image | 2.14.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\image-2.14.0
              interval 3.2.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\interval-3.2.0
    instrument-control 0.7.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\instrument-control-0.7.1
                    io |  2.6.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\io-2.6.3
              interval 3.2.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\interval-3.2.1
        linear-algebra |  2.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\linear-algebra-2.2.3
                    io |  2.6.4 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\io-2.6.4
                  lssa 0.1.4 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\lssa-0.1.4
        linear-algebra 2.2.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\linear-algebra-2.2.3
                  ltfat 2.3.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\ltfat-2.3.1
                  lssa 0.1.4 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\lssa-0.1.4
                mapping 1.4.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\mapping-1.4.1
                  ltfat 2.3.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\ltfat-2.3.1
                 matgeom |  1.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\matgeom-1.2.3
                 mapping |  1.4.2 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\mapping-1.4.2
          miscellaneous |  1.3.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\miscellaneous-1.3.0
                matgeom |  1.2.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\matgeom-1.2.3
                    nan |  3.6.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\nan-3.6.0
          miscellaneous 1.3.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\miscellaneous-1.3.0
                netcdf | 1.0.14 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\netcdf-1.0.14
                    nan |   3.6.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\nan-3.6.1
                  nurbs |   1.4.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\nurbs-1.4.3
                netcdf | 1.0.14 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\netcdf-1.0.14
                    ocs 0.1.5 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\ocs-0.1.5
                  nurbs 1.4.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\nurbs-1.4.3
                octproj 2.0.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\octproj-2.0.1
                    ocs |  0.1.5 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\ocs-0.1.5
                  optim 1.6.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\optim-1.6.1
                octproj 2.0.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\octproj-2.0.1
            optiminterp 0.3.6 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\optiminterp-0.3.6
                  optim 1.6.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\optim-1.6.1
            quaternion 2.4.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\quaternion-2.4.0
            optiminterp 0.3.7 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\optiminterp-0.3.7
              queueing 1.2.7 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\queueing-1.2.7
            quaternion 2.4.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\quaternion-2.4.0
                signal |  1.4.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\signal-1.4.1
              queueing |  1.2.7 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\queueing-1.2.7
                sockets |  1.2.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\sockets-1.2.1
                signal |  1.4.1 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\signal-1.4.1
              sparsersb |  1.0.9 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\sparsersb-1.0.9
                sockets |  1.3.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\sockets-1.3.0
                splines |  1.3.4 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\splines-1.3.4
              sparsersb |  1.0.9 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\sparsersb-1.0.9
            statistics |  1.4.2 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\statistics-1.4.2
                splines |  1.3.4 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\splines-1.3.4
                    stk 2.6.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\stk-2.6.1
            statistics 1.4.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\statistics-1.4.3
                strings 1.2.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\strings-1.2.0
                    stk 2.7.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\stk-2.7.0
                struct | 1.0.17 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\struct-1.0.17
                strings |   1.2.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\strings-1.2.0
              symbolic |   2.9.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\symbolic-2.9.0
                struct | 1.0.17 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\struct-1.0.17
                tisean 0.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\tisean-0.2.3
              symbolic 2.9.0 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\symbolic-2.9.0
                     tsa  |  4.6.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\tsa-4.6.3
                tisean  |  0.2.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\tisean-0.2.3
                   video  |  2.0.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\video-2.0.0
                     tsa  |  4.6.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\tsa-4.6.3
                 windows  |  1.6.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\windows-1.6.1
                   video  |  2.0.2 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\video-2.0.2
                 zeromq  |  1.5.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\zeromq-1.5.3
                 windows  |  1.6.2 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\windows-1.6.2
                 zeromq  |  1.5.3 | C:\Octave\octave-7.1.0-w64\mingw64\share\octave\packages\zeromq-1.5.3
                                                                                            
                                                                                            
   
   
Line 115: Line 116:
   >> pkg install package_file_name.tar.gz
   >> pkg install package_file_name.tar.gz


Note that all of the commands above will perform ''local'' or ''global'' package installs according to the user's Administrator access level.  E.g., if an update is found for a global package with a non-elevated user account, the updated version will be installed to the ''local'' package location, leaving the old version intact in the ''global'' package location.  This behavior can be changed by calling the install command with the {{Path|-global}} option. For example:
Note that all of the commands above will perform ''local'' or ''global'' package installs according to the user's Administrator access level.  E.g., if an update is found for a global package with a non-elevated user account, the updated version will be installed to the ''local'' package location, leaving the old version intact in the ''global'' package location.  This behavior can be changed by calling the install command with the {{Path|-global}} option. As of Octave 7.1.0 the {{Path|-global}} option also works with the {{Path|pkg update}} command. For example:
 
To install a global package to the latest version (requires write-access to the global-list location) you can use:


   >> pkg install -forge -global <package_name>
   >> pkg install -forge -global <package_name>


Note also that the update command does not take -local or -global options, and always performs an update according to the user's Administrator access level. As such if Octave was installed from a zip or 7z archive in a non-privileged account, 'pkg update' cannot be used to update global packages, they must be updated manually using 'pkg install'
  >> pkg update -global


Detailed instructions for installing individual Octave Forge packages are given at https://octave.sourceforge.io/packages.php.
Detailed instructions for installing individual Octave Forge packages are given at https://octave.sourceforge.io/packages.php.


==Calling Octave executables==
Some environment variables have to be set to correctly run Octave executables.  So, a user should not call any of the executables directly unless the necessary environment variables have been set up manually.
Instead, the {{Path|octave.vbs}} script in Octave's root installation folder or the {{Path|octave.bat}} script in the bin directory should be used.  Both scripts support starting the GUI (command line argument {{Path|--gui}}) or running Octave in CLI mode (command line argument {{Path|--no-gui}}).  The .vbs script opens the GUI by default.  The .bat script starts Octave in CLI mode by default.
The .vbs script returns immediately when Octave has started.  The .bat script returns when Octave finishes execution.
Alternatively, Octave can be started using the msys2 shell that can be started with {{Path|cmdshell.bat}} in Octave's root installation folder.


=GNU Octave in MSYS2=
=GNU Octave in MSYS2=
150

edits

Navigation menu