153
edits
Octave for Microsoft Windows: Difference between revisions
Jump to navigation
Jump to search
→Pre-installed Packages: update pkg list for 6.3.0
(→Octave Packages: corrected information about update -global) |
(→Pre-installed Packages: update pkg list for 6.3.0) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 29: | Line 29: | ||
>> pkg global_list | >> pkg global_list | ||
Octave versions for Windows prior to 6.1.0 defaulted to always | 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=== | ===Pre-installed Packages=== | ||
| Line 37: | Line 37: | ||
>> pkg list | >> pkg list | ||
The output for preinstalled global packages included with version 6. | The output for preinstalled global packages included with version 6.3.0 when installed into {{Path|C:\Octave}} is: | ||
Package Name | Version | Installation directory | Package Name | Version | Installation directory | ||
---------------------+---------+----------------------- | ---------------------+---------+----------------------- | ||
audio | 2.0.2 | C:\Octave\octave-6. | audio | 2.0.2 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\audio-2.0.2 | ||
communications | 1.2. | communications | 1.2.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\communications-1.2.3 | ||
control | 3. | control | 3.3.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\control-3.3.1 | ||
data-smoothing | 1.3.0 | C:\Octave\octave-6. | data-smoothing | 1.3.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\data-smoothing-1.3.0 | ||
database | 2.4.4 | C:\Octave\octave-6. | database | 2.4.4 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\database-2.4.4 | ||
dataframe | 1.2.0 | C:\Octave\octave-6. | dataframe | 1.2.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\dataframe-1.2.0 | ||
dicom | 0.4.0 | C:\Octave\octave-6. | dicom | 0.4.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\dicom-0.4.0 | ||
financial | 0.5.3 | C:\Octave\octave-6. | financial | 0.5.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\financial-0.5.3 | ||
fits | 1.0.7 | C:\Octave\octave-6. | fits | 1.0.7 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\fits-1.0.7 | ||
fuzzy-logic-toolkit | 0.4. | fuzzy-logic-toolkit | 0.4.6 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\fuzzy-logic-toolkit-0.4.6 | ||
ga | 0.10. | ga | 0.10.2 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\ga-0.10.2 | ||
general | 2.1.1 | C:\Octave\octave-6. | general | 2.1.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\general-2.1.1 | ||
generate_html | 0.3.2 | C:\Octave\octave-6. | generate_html | 0.3.2 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\generate_html-0.3.2 | ||
geometry | 4.0.0 | C:\Octave\octave-6. | geometry | 4.0.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\geometry-4.0.0 | ||
gsl | 2.1.1 | C:\Octave\octave-6. | gsl | 2.1.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\gsl-2.1.1 | ||
image | 2.12.0 | C:\Octave\octave-6. | image | 2.12.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\image-2.12.0 | ||
instrument-control | 0. | instrument-control | 0.7.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\instrument-control-0.7.0 | ||
interval | 3.2.0 | C:\Octave\octave-6. | interval | 3.2.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\interval-3.2.0 | ||
io | 2.6.3 | C:\Octave\octave-6. | io | 2.6.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\io-2.6.3 | ||
linear-algebra | 2.2.3 | C:\Octave\octave-6. | linear-algebra | 2.2.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\linear-algebra-2.2.3 | ||
lssa | 0.1.4 | C:\Octave\octave-6. | lssa | 0.1.4 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\lssa-0.1.4 | ||
ltfat | 2.3.1 | C:\Octave\octave-6. | ltfat | 2.3.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\ltfat-2.3.1 | ||
mapping | 1.4.1 | C:\Octave\octave-6. | mapping | 1.4.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\mapping-1.4.1 | ||
matgeom | 1.2. | matgeom | 1.2.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\matgeom-1.2.3 | ||
miscellaneous | 1.3.0 | C:\Octave\octave-6. | miscellaneous | 1.3.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\miscellaneous-1.3.0 | ||
nan | 3.5. | nan | 3.5.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\nan-3.5.3 | ||
netcdf | 1.0.14 | C:\Octave\octave-6. | netcdf | 1.0.14 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\netcdf-1.0.14 | ||
nurbs | | nurbs | 1.4.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\nurbs-1.4.3 | ||
ocs | 0.1.5 | C:\Octave\octave-6. | ocs | 0.1.5 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\ocs-0.1.5 | ||
octproj | 2.0.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\octproj-2.0.1 | |||
optim | 1.6.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\optim-1.6.1 | |||
optiminterp | 0.3.6 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\optiminterp-0.3.6 | |||
quaternion | 2.4.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\quaternion-2.4.0 | |||
queueing | 1.2.7 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\queueing-1.2.7 | |||
signal | 1.4.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\signal-1.4.1 | |||
sockets | 1.2.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\sockets-1.2.1 | |||
sparsersb | 1.0.8 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\sparsersb-1.0.8 | |||
splines | 1.3.4 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\splines-1.3.4 | |||
statistics | 1.4.2 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\statistics-1.4.2 | |||
stk | 2.6.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\stk-2.6.1 | |||
strings | 1.2.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\strings-1.2.0 | |||
struct | 1.0.17 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\struct-1.0.17 | |||
symbolic | 2.9.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\symbolic-2.9.0 | |||
tisean | 0.2.3 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\tisean-0.2.3 | |||
tsa | 4.6.2 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\tsa-4.6.2 | |||
video | 2.0.0 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\video-2.0.0 | |||
windows | 1.6.1 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\windows-1.6.1 | |||
zeromq | 1.5.2 | C:\Octave\octave-6.3.0-w64\mingw64\share\octave\packages\zeromq-1.5.2 | |||
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: | 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: | ||
| Line 95: | Line 96: | ||
>> pkg rebuild | >> 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. | 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=== | ===Package Installation and Update=== | ||
| Line 111: | Line 114: | ||
>> 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, 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. For example: | ||
To install a global package to the latest version (requires write-access to the global-list location) you can use: | To install a global package to the latest version (requires write-access to the global-list location) you can use: | ||
| Line 117: | Line 120: | ||
>> pkg install -forge -global <package_name> | >> pkg install -forge -global <package_name> | ||
Note that the update command does not take -local or -global options, and always performs an update according to the user's Administrator access level. | 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. | 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 on [https://cygwin.com/ cygwin]= | =GNU Octave on [https://cygwin.com/ cygwin]= | ||