Editing Octave for Microsoft Windows

:''This article is about using pre-built installers of Octave for Windows; for instructions about building it, see [[Windows Installer]].''

{{Note|Windows installers are available for the latest version of '''Octave ({{Release}}, released on {{Release Date}})''' from https://ftpmirror.gnu.org/gnu/octave/windows/.}}

Users are encouraged to use the latest version unless a specific feature or requirement that warrants using an older version of the software. Version specific instructions and installation notes are provided below.

:'''Note:''' As of version 8.3.0, '''Octave no longer produces or supports 32-bit versions'''. An alternative source for 32-bit Windows binaries of Octave is using [[Octave for Microsoft Windows#GNU Octave in MSYS2|MSYS2]].   

:'''Note:''' As of version 4.4.1, '''Octave no longer supports Windows XP'''. There may be some workarounds to get Octave installed and running in command line mode (see Bug {{bug|54662}}), but maintainers cannot provide support and troubleshooting for this beyond what has already been documented. 

=Installers for Microsoft Windows=

The easiest way to install GNU Octave on Microsoft Windows is by using [http://hg.octave.org/mxe-octave/ MXE] builds.  For the current release, both 32-bit and 64-bit installers and zip archived packages (.zip and .7z formats) can be found at https://www.gnu.org/software/octave/download.html under the Windows tab. 

* For executable (.exe) installers: the user can simply run the downloaded file and follow the on-screen installation prompts.  It is recommended that the installation path does not include spaces or non-ASCII characters.  Shortcuts to the program will be created automatically.

* 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.
# 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.) 
# 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.

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

==Octave Packages==
Like many software programs, Octave uses ''packages'' to optionally extend and modify its capability. These packages can be installed and loaded using the built in package management program 'pkg'.  (Note that Octave does not automatically load installed packages, they must be manually loaded from within Octave by the user.) 

Octave maintains a system-wide (or ''global'') package list, and a user-specific (or ''local'') package list. By default in Windows 10, local packages are located at {{Path|C:\Users\%USERNAME%\octave\}}.  (The \octave folder will be created during the first package install\update if it is not already present.)  The global packages are stored in {{Path|%OCTAVE_HOME%\mingw64\share\octave\packages\}}, and are available to all users on the machine. Specific locations on your system can be found by typing the following commands at the Octave command line:

    >> pkg local_list
    >> pkg global_list

Octave versions for Windows prior to 6.1.0 defaulted to always making changes to global packages unless the user specified otherwise.  The default is now to follow the same behavior on all platforms, and for all package updates and installations to apply to local or global package locations according to whether or not the user is running with Administrative privileges (on Windows, this is usually accomplished by running as an Administrator privileged account, or starting Octave with the "Run as Administrator" option).  Alternatively, some pkg command options can force octave to try to use either the local or global packages.

===Pre-installed Packages===

A selection of pre-built, [[Octave Forge]] packages is included with all versions of the official Windows release.  If you followed the installation directions above, you can display a list of packages by typing the command below at the Octave command prompt:

   >> pkg list

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

    Package Name         | Version | Installation directory
    ---------------------+---------+-----------------------
                  audio  |   2.0.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\audio-2.0.3
         communications  |   1.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\communications-1.2.3
                control  |   3.3.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\control-3.3.1
         data-smoothing  |   1.3.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\data-smoothing-1.3.0
               database  |   2.4.4 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\database-2.4.4
              dataframe  |   1.2.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\dataframe-1.2.0
                  dicom  |   0.4.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\dicom-0.4.0
              financial  |   0.5.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\financial-0.5.3
                   fits  |   1.0.7 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\fits-1.0.7
    fuzzy-logic-toolkit  |   0.4.6 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\fuzzy-logic-toolkit-0.4.6
                     ga  |  0.10.2 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\ga-0.10.2
                general  |   2.1.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\general-2.1.1
          generate_html  |   0.3.2 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\generate_html-0.3.2
               geometry  |   4.0.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\geometry-4.0.0
                    gsl  |   2.1.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\gsl-2.1.1
                  image  |  2.12.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\image-2.12.0
     instrument-control  |   0.7.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\instrument-control-0.7.0
               interval  |   3.2.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\interval-3.2.0
                     io  |   2.6.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\io-2.6.3
         linear-algebra  |   2.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\linear-algebra-2.2.3
                   lssa  |   0.1.4 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\lssa-0.1.4
                  ltfat  |   2.3.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\ltfat-2.3.1
                mapping  |   1.4.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\mapping-1.4.1
                matgeom  |   1.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\matgeom-1.2.3
          miscellaneous  |   1.3.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\miscellaneous-1.3.0
                    nan  |   3.6.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\nan-3.6.0
                 netcdf  |  1.0.14 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\netcdf-1.0.14
                  nurbs  |   1.4.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\nurbs-1.4.3
                    ocs  |   0.1.5 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\ocs-0.1.5
                octproj  |   2.0.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\octproj-2.0.1
                  optim  |   1.6.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\optim-1.6.1
            optiminterp  |   0.3.6 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\optiminterp-0.3.6
             quaternion  |   2.4.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\quaternion-2.4.0
               queueing  |   1.2.7 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\queueing-1.2.7
                 signal  |   1.4.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\signal-1.4.1
                sockets  |   1.2.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\sockets-1.2.1
              sparsersb  |   1.0.9 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\sparsersb-1.0.9
                splines  |   1.3.4 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\splines-1.3.4
             statistics  |   1.4.2 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\statistics-1.4.2
                    stk  |   2.6.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\stk-2.6.1
                strings  |   1.2.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\strings-1.2.0
                 struct  |  1.0.17 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\struct-1.0.17
               symbolic  |   2.9.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\symbolic-2.9.0
                 tisean  |   0.2.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\tisean-0.2.3
                    tsa  |   4.6.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\tsa-4.6.3
                  video  |   2.0.0 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\video-2.0.0
                windows  |   1.6.1 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\windows-1.6.1
                 zeromq  |   1.5.3 | C:\Octave\octave-6.4.0-w64\mingw64\share\octave\packages\zeromq-1.5.3
                                                                                           
 
Note that the included packages shown above are stored in the default ''global package location'' within the Octave installation folder.  If any 'local' packages were previously installed with another version of windows, they might also appear in the list at the local location.  It is recommended that any such packages be uninstalled and reinstalled to guarantee compatibility with the current version of octave.

If Octave was installed from a zip or 7z archive and you did not run the {{Path|post-install.bat}} file, you may not see any packages listed.  In that case you need to run:
   
   >> pkg rebuild

That will force octave to look for both ''local'' and ''global'' packages in the set locations to repopulate the list of available packages.  Note that  'local' packages always take precedence if the same package is present in both locations.

'''Note''': The Windows bundle includes a minimal version of Python for the symbolic package. That version of Python is not intended to be used for anything else. If you like to use Python for something different in Octave (e.g., for the pythonic package), install a full Python distribution and set the necessary environment variables (PYTHON, ...?).

===Package Installation and Update===

All packages can be updated to the latest version by running:
   
   >> pkg update

Other packages can be installed by running:

   >> pkg install -forge <package_name>

To install a new or updated package version manually, the package file can be downloaded from the [https://octave.sourceforge.io/packages.php Octave Forge website] to the working directory and can be installed using:

   >> 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:

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>

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'

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=

[https://www.msys2.org/ MSYS2] is a collection of tools and libraries providing an easy-to-use environment for building, installing and running native Windows software. GNU Octave is available as a [https://packages.msys2.org/base/mingw-w64-octave package] in MSYS2.

The best (and recommended) way to use Octave on Windows is to use the provided installers (see above). But for some special requirements, the version of Octave packaged by MSYS2 might be the better solution. Those special requirements might include:
* Users might want to use e.g. Octave packages that depend on third party packages not included in MXE Octave (e.g., the Pythonic package that depends on a native Windows Python installation).
* Users might need features of newer versions of packages than which are included in MXE Octave.
* ...

MSYS2 follows a rolling release cycle. So, its packages are most likely more up-to-date than the packages included in Octave's installer for Windows.
It includes a (working) package manager (<code>pacman</code>) that provides the option to install a much wider range of packages than what can possibly be included in Octave's installer for Windows.

To use Octave in MSYS2, install the MSYS2 environment following [https://www.msys2.org/#installation their instructions]. At the <code>bash</code> shell (use e.g. "MSYS2 MinGW 64-bit" from the start menu), update the installation by <code>pacman -Syu</code>. After that, install a version of Octave that matches your environment (and the shell you are using), e.g. <code>pacman -S mingw-w64-x86_64-octave</code>.

This will install (among others), the main executables of Octave <code>octave-gui</code> (linked with Qt, i.e., including the "qt" graphics toolkit and the GUI), <code>octave-cli</code> (linked without Qt, i.e., only "fltk" and "gnuplot" graphics toolkits and no GUI), and the wrapper executable <code>octave</code> that dispatches to one of the former executables depending on the used command line switches. The Octave GUI can be started with <code>octave --gui</code> from MSYS2's <code>bash</code> shell, the command line interface (CLI) with <code>octave</code>.

=GNU Octave on [https://cygwin.com/ cygwin]=

*'''Maintainer:''' Marco Atzeri 
*'''Latest release:''' 2024-01-66

*Latest packages:

:octave-8.4.0-1
:Its announce on cygwin mailing list [https://cygwin.com/pipermail/cygwin-announce/2024-January/011503.html]

:Most of the Octave Forge packages have each a cygwin package.
: Full cygwin package list is available here [https://cygwin.com/packages/]
: At 2024-01-26, 51 forge packages were available. 

*To install : 
:  run  setup-x86_64.exe (for cygwin 64 bit) and select them in the Math category. 
:  All the package dependencies will be also installed.

:Graphics is based on X and to plot you will need to start octave within xterm (or similar).
:  I recommend to install "xinit", "xlaunch" and "gnuplot". These packages will pull all the functional Xserver. 
:  Otherwise the only graphics will be ASCII art ;-)

==Notes for cygwin==

* To build GNU Octave from cygwin source package, you need to install "cygport" and the relevant development libraries
:<syntaxhighlight lang="bash">
tar -xf octave-8.4.0-1-src.tar.xz 
cygport octave.cygport almostall
</syntaxhighlight>
:see cygport documentation at /usr/share/doc/cygport/html/manual/toc_index.html for further info.

=General info=

Be advised that GNU Octave is primarily developed on GNU/Linux and other [https://en.wikipedia.org/wiki/POSIX POSIX] conform systems. The ports of GNU Octave to Microsoft Windows use different approaches to get most of the original Octave and adapt it to Microsoft Windows idiosyncrasies (e.g. dynamic libraries, file paths, permissions, environment variables, GUI system, etc). Bear this in mind and don't panic if you get unexpected results. There are a lot of suggestions on the mailing lists for tuning your Octave installation. GNU Octave standalone ports for Windows are independently compiled using either the [http://mingw.org MinGW] or Microsoft Visual Studio development environments (3.6 or before).

=See also=

* [[Octave for Microsoft Windows (outdated)]] for older instructions.

[[Category:Installation]]
[[Category:Building]]
[[Category:Microsoft Windows]]