Editing FAQ

This is a list of frequently asked questions (FAQ) for GNU Octave users.

We are always looking for new questions (with answers), better answers, or both.  Feel free to edit this page with your changes.

=Where do I get additional help?=

If you can't find an answer to your question in this FAQ, wiki, or in the [http://www.octave.org/doc/interpreter manual] ([http://www.octave.org/octave.pdf PDF]) you can:

* Search for an answer in our [https://lists.gnu.org/archive/html/help-octave/ mailing list archives]
* Contact our user community using our [https://octave.discourse.group Octave Discourse].
* Contact our user community using our [https://webchat.freenode.net/?channels=octave IRC chat room <code>#octave</code> in Freenode]

<div class="tocinline">__TOC__</div>

=== Support expectations ===
See [https://octave.org/support-expectations.html Support Expectations]

Also this [https://www.commitstrip.com/en/2014/05/07/the-truth-behind-open-source-apps/ CommitStrip]

=General=

==What is Octave?==

[https://www.gnu.org/software/octave/ GNU Octave] is a high-level interpreted language, primarily intended for numerical computations.  It provides capabilities for the numerical solution of linear and nonlinear problems, and for performing other numerical experiments.  It also provides extensive graphics capabilities for data visualization and manipulation.  GNU Octave is normally used through its interactive interface ([https://en.wikipedia.org/wiki/Command-line_interface CLI] and [https://en.wikipedia.org/wiki/Graphical_user_interface GUI]), but it can also be used to write non-interactive programs. 
The GNU Octave language is quite similar to Matlab so that most programs are easily portable.

The GNU Octave distribution includes a [http://www.octave.org/octave.pdf 1000+ page Texinfo manual].  Access to the complete text of the manual is available via the <code>doc</code> command at the GNU Octave prompt.

==What is Octave Forge?==

[https://octave.sourceforge.io/ Octave Forge] is a collection of [[packages]] for GNU Octave, something similar to the Matlab toolboxes.  When talking about the two projects at the same time, GNU Octave is usually referred to as Octave core (or just "core").  Octave Forge also serves as a test bed for code that may eventually end up in the core, and distributes binaries for systems with a lack of developers tools (mainly Windows).

==Who uses Octave?==

A huge number of people ranging from students to researchers involved in various fields such as statistics,Machine Learning, data analytics, etc. Universities use it for research and teaching, companies of all sizes for development and individuals for certain private purposes. See [[Who Uses Octave?]] for more clarity.

==Who develops Octave?==

Discussions about writing the software that would eventually become Octave started in about 1988 with James B. Rawlings and [http://jweaton.org/ John W. Eaton] at the University of Texas.  John W. Eaton is the original author of Octave, starting full-time development in February 1992.  He is still the primary maintainer.  The community of users and developers has in addition contributed some code and fuels the discussion on the mailing lists [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org] (user forum), [https://lists.gnu.org/mailman/listinfo/octave-maintainers maintainers@octave.org] (development issues).Also GNU Octave takes part in GSOC as a mentor organisation wherein a huge number of students apply every year and contribute to Octave thereby helping in removal of the bugs and development of new features .

==Why "Octave"?==

Octave's name has nothing to do with music.  It is named after [http://en.wikipedia.org/wiki/Octave_Levenspiel Octave Levenspiel], a former professor of John who was famous for his ability to do quick back-of-the-envelope calculations.  You can hear John pronounce the name "Octave" a few times [http://videolectures.net/mloss08_eaton_oct/ in this video].  We hope that GNU Octave will help perform computations with the same ease as Dr. Levenspiel.

==Why "GNU" Octave?==

The [https://www.gnu.org/ GNU Project] was launched in 1984 to develop a complete Unix-like operating system which is free software: the GNU system.  GNU is a recursive acronym for "GNU's Not Unix"; it is pronounced [https://www.gnu.org/gnu/pronunciation.en.html g'noo].

The [https://www.fsf.org/ Free Software Foundation (FSF)] is the principal organization that has sponsored the GNU Project.

Octave became GNU Octave in 1997 (beginning with [[Release History|version 2.0.6]]).  This meant agreeing to consider Octave a part of the GNU Project and support the efforts of the FSF.  A big part of this effort is to adhere to the [https://www.gnu.org/prep/standards/standards.html GNU coding standards] and to benefit from GNU's infrastructure (e.g. [https://hg.savannah.gnu.org/hgweb/octave/ code hosting] and [http://bugs.octave.org bug tracking]).  Additionally, Octave receives [https://my.fsf.org/donate/working-together/octave sponsorship] from the FSF's Working Together fund.  However, Octave is not and has never been developed by the FSF.

==How can I cite Octave?==

Octave is free software and does not legally bind you to cite it.  However, we have invested a lot of time and effort in creating GNU Octave, and we would appreciate if you would cite if you used.  To cite GNU Octave in publications use:

  John W. Eaton, David Bateman, Søren Hauberg, Rik Wehbring ({{Release Year}}).
  GNU Octave version {{Release}} manual: a high-level interactive language for numerical computations.
  URL https://octave.org/doc/v{{Release}}/

A [https://en.wikipedia.org/wiki/BibTeX BibTeX] entry for [https://en.wikipedia.org/wiki/LaTeX LaTeX] users is:

  @manual{,
    title     = {{GNU Octave} version {{Release}} manual: a high-level interactive language for numerical computations},
    author    = {John W. Eaton and David Bateman and S{\o}ren Hauberg and Rik Wehbring},
    year      = <span>{</span>{{Release Year}}},
    url       = {[https://octave.org/doc/v{{Release}}/ https://octave.org/doc/v{{Release}}/]},
  }

Run {{manual|citation}} at the Octave prompt for details on how to best cite the Octave version you are running.  Certain Octave packages also have recommended citations in which case use <code>citation package_name</code>.

Note that there are two reasons for citing the software used.  One is giving recognition to the work done by others which we have already addressed to. The other is giving details on the system used so that experiments can be replicated.  For this, you should cite the version of Octave and all packages used (you can get this information using the <code>ver</code> command), as well as any details of your setup as part of your Methods.  In addition, you should make your source available as well. See [http://software.ac.uk/so-exactly-what-software-did-you-use How to cite and describe software] for more details and an in depth discussion for the same.

==What documentation exists for Octave?==

Besides this wiki, the GNU Octave distribution includes a [http://www.octave.org/doc/interpreter 1000+ page Texinfo manual] ([http://www.octave.org/octave.pdf PDF]).  Access to the complete text of the manual is available via the {{manual|doc}} command at the GNU Octave prompt.  If you have problems using this manual, or find that some topic is not adequately explained, indexed, or cross-referenced, please report it on http://bugs.octave.org.

==How can I report a bug in Octave?==

Please read our website http://www.octave.org/bugs.html.


= Common problems =

== Octave does not start ==

The following steps have been the solution to several bug reports and help requests.  Please try them before asking for further support.  If nothing below helps, please give us the following information:

* Operating system: e.g. [https://support.microsoft.com/en-us/help/13443/windows-which-version-am-i-running '''MS Windows 10 (version 2004)'''] or '''Ubuntu 20.04'''
* GNU Octave version: e.g. '''Version {{Release}}'''
* Installation method: e.g. '''Downloaded and installed "octave-{{Release}}-w64-installer.exe" from https://www.octave.org/download.html'''

=== MS Windows ===

* After Octave upgrade the GUI does not open / shuts down immediately.
** '''Solution:'''
*** Version 5.2.0 and older: Delete the folder {{path|C:\Users\YOUR_USER_NAME\.config\octave}}
*** Version 6.1.0 and newer: Delete the folder {{path|%APPDATA%\octave}}, which generally is located at {{path|C:\Users\YOUR_USER_NAME\AppData\Roaming\octave}}
* Missing/conflicting files.
** '''Solution:''' Remove/Uninstall all existing Octave versions.  Restart the system.  Install GNU Octave again.

* Permission errors
** '''Solution 1:''' Octave versions prior to version 7.1.0 on MS Windows used VBS scripts to start the program.  You can test whether your system is blocking VBS scripts by doing the following:
**# Using Notepad or another text editor, create a text file containing only the text: <pre>msgbox("This is a test script, Click OK to close")</pre>
**# Save the file on your Desktop with the name {{Path|testscript.vbs}} (be sure that the editor didn't end it in .txt or .vbs.txt).
**# Double click the file.  If scripts can run, a popup window will appear with that message. 
**#* If the file opens in notepad or an editor, it means it still ended in .txt.  MS Windows insecurely hides file extensions by default.  To show file extensions follow [https://answers.microsoft.com/en-us/windows/forum/all/in-win10-how-to-show-the-file-extension-for/ed21ff20-cdb3-4263-9c7d-fc6ed125fc82 these instructions at Microsoft.com].
**#* If both {{Path|testscript.vbs}} and {{Path|octave.vbs}} open a text- or other editor, it means your MS Windows file associations have .vbs files associated with another program.  To fix this, right click the .vbs file, select "Open With", select "Choose Another App", check the box that says "Always use this app to open .vbs files".  Finally, select "Microsoft Windows Based Script Host" from the list.  If it is not in the list, select "More apps".  If still not there, select "Look for Another App on this PC" and navigate to {{Path|C:\Windows\System32\wscript.exe}}, select it, and select "Open".  If {{Path|wscript}} is still not present you will need to seek assistance installing missing MS Windows components.
**# Try moving {{Path|testscript.vbs}} to another location, such as a {{Path|C:\temp folder}}.  Additionally try to move {{Path|testscript.vbs}} in the Octave installation folder containing {{Path|octave.vbs}} and see if VBS scripts can be run there.
**# If {{Path|testscript.vbs}} doesn't run in any of those locations, then scripting appears to be disabled or blocked on your system.  If {{Path|testscript.vbs}} runs in some locations but not others, there there may be other security permissions errors to be solved.  If {{Path|testscript.vbs}} runs in the same folder as {{Path|octave.vbs}}, but directly double-clicking on {{Path|octave.vbs}} does not start Octave, then there appears to be some problem other than script permissions. 
** '''Solution 2:''' Consult your malware detection (a.k.a. AntiVirus) software, if files are blocked.
** '''Solution 3:''' Did you install Octave on a network-drive?  Do you have the execution permissions?
** '''Solution 4:''' Is your computer managed by your company?  Does your administrator prohibit script execution?
===Collecting gdb backtrace information===
The following instructions can help you gather troubleshooting information that may help developers identify the problem if the above steps are ineffective:
* if Octave is 'hanging' (the process is remaining open):
*# attempt to start the Octave GUI 
*# with the program stalled (either at the GUI, or with the black terminal window), open the Task Manager (right click on taskbar, select Task manager), switch to the "Details" tab, find `octave-gui.exe` on that list, ad take note of the corresponding PID (process ID)
*# Open the folder where Octave is installed. You should find a file called `cmdshell.bat` in the main folder. Run that file, which should open a MSYS2 bash (command line) window.
*# At that prompt, run `gdb -p <em>PID</em>` where <em>PID</em> is the process ID noted previously.
*# at the gdb prompt, execute `set logging on` to save all output to a text file (default will be `gdb.txt`. If you want a different location or filename you can execute `set logging file C:\path\to\file.txt` first).
*# execute `thread apply all bt`.  (If this returns a list longer than one page you may need to 'continue' by typing `c`.)
*# execute `quit` to leave gdb.
*# append that text file to your trouble report at octave.discourse.group or bug report at bugs.octave.org.

* if Octave is immediately crashing and closing:
*# Open the folder where Octave is installed. You should find a file called `cmdshell.bat` in the main folder. Run that file, which should open a MSYS2 bash (command line) window.
*# At that prompt, run `gdb octave`. (that will start gdb attached to the octave executable.)
*# at the gdb prompt, execute `set logging on` to save all output to a text file (default will be `gdb.txt`. If you want a different location or filename you can execute `set logging file C:\path\to\file.txt` first).
*# At the gdb prompt, execute `r --gui`.  That should attempt to start the Octave in GUI mode.  The gdb prompt should stay unresponsive as long as octave is running.
*# If octave crashes, the gdb prompt should become responsive again. execute `thread apply all bt`.  (If this returns a list longer than one page you may need to 'continue' by typing `c`.)
*# append the text file to your trouble report at octave.discourse.group or bug report at bugs.octave.org.

==I do not see any output of my script until it has finished?==

By default Octave is set to pass its screen output through a [https://en.wikipedia.org/wiki/Terminal_pager pager] (usually the default pager is "less") which allows things such as navigating through the output with arrow keys or searching for text or regular expressions within the output.  The pager only displays the output after it's finished receiving it, so when it is active you'll not be able to see anything until your script has terminated.  To change this behavior temporarily or permanently you may want to use one of the options described [https://www.octave.org/doc/interpreter/Paging-Screen-Output.html in the manual].

==When I try plotting from a script, why am I not seeing anything?==

If you are running an Octave script that includes a plotting command, the script and Octave may terminate immediately.  So the plot window does show up, but immediately closes when Octave finishes execution.  Alternatively, if using fltk, the plot window needs a readline loop to show up (the time when Octave is sitting around doing nothing waiting for interactive input).

A common solution is to put a {{manual|pause}} command at the end of your script.

==How do I get sound input or output in MS Windows?==

Sound input from a sound card and output to a sound card is fully supported since Octave 4.0.0 for all platforms.  If you have problems with the [https://www.octave.org/doc/interpreter/Audio-Processing.html audio I/O functions] using Octave 4.0.0 or a newer version, please report them on the [http://bugs.octave.org bug tracker].

==I have problem X using the latest Octave version==

Please be more specific about what you mean by "latest version"?

* The latest stable version is {{Release}}.  Be aware that you may still have an older version due to whatever distribution method you are using.  To get a newer stable version for your system see the following as in accordance to your Operating system: [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], or [[Octave for Microsoft Windows|Windows]].

* If you refer to the latest Mercurial revision, please specify the [https://www.mercurial-scm.org/wiki/ChangeSetID changeset ID] not the revision number, e.g. the output of <code>hg summary</code> or <code>hg id</code>.  Changeset IDs are globally unique across all repos.

If your problem still persists with the "latest version", then please [http://bugs.octave.org/ report a bug] or ask for help at [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org].  Otherwise, don't be surprised if volunteers are less inclined to help you with a problem that only exists in an older version of Octave and is already fixed in a newer version.

==Why is Octave's floating-point computation wrong?==

Floating-point arithmetic is an approximation '''in binary''' to arithmetic on real or complex numbers.  Just like you cannot represent 1/3 exactly in decimal arithmetic (0.333333... is only a rough approximation to 1/3 for any finite number of 3s), you cannot represent some fractions like <math>1/10</math> exactly in base 2.  In binary, the representation to one tenth is <math>0.0\overline{0011}_b</math> where the bar indicates that it repeats infinitely (like how <math>1/6 = 0.1\overline{6}_d</math> in decimal).  Because this infinite repetition cannot be represented exactly with a finite number of digits, rounding errors occur for values that appear to be exact in decimal but are in fact approximations in binary, such as for example how 0.3 - 0.2 - 0.1 is not equal to zero.

In addition, some advanced operations are computed by approximation and there is no guarantee for them to be accurate, see [https://en.wikipedia.org/wiki/Rounding#Table-maker.27s_dilemma Table-maker's dilemma] for further references. Their results are system-dependent.

This isn't a bug that is limited to GNU-Octave & it happens with any program that uses [https://en.wikipedia.org/wiki/IEEE_754 IEEE 754 floating-point arithmetic].  To be fair, IEEE 754 also specifies decimal floating-point arithmetic, which has never seen wide adoption.  The reason why Octave and other programs using IEEE 754 binary floating-point numbers is that they are ''fast'', because they are implemented in hardware or system libraries.  Unless you are using very exotic hardware, Octave will use your computer's processor for basic floating-point arithmetic.

Another approach to deal with rounding errors is interval arithmetic with the [[Interval package]] or symbolic computations with the [[Symbolic package]].  These approaches are likely to be slower, since not all operations can be performed on Hardware like pure floating-point arithmetic.

To learn more about floating-point arithmetic, consult this [https://en.wikipedia.org/wiki/Floating-point_arithmetic Wikipedia article] or the classical reference by David Goldberg [http://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html What Every Computer Scientist Should Know About Floating-Point Arithmetic].

==Missing lines when printing under Windows with OpenGL toolkit and Intel integrated GPU==

Some windows users with integrated Intel GPUs have reported missing lines when printing with an OpenGL toolkit like FLTK or Qt. {{bug|42534}}

Users with this kind of problem should try to install/update their Intel OpenGL drivers for Windows or consider installing Mesa drivers from http://qt-project.org/wiki/Cross-compiling-Mesa-for-Windows.

See also https://www.opengl.org/wiki/FAQ#Why_is_my_GL_version_only_1.4_or_lower.3F .

==Plot hangs and makes the GUI unresponsive==

If the Qt graphics toolkit is used and "plot" is used for the first time, the fontconfig scanner searches the font directory to build a font cache. This can take up to 3min on slow CPUs. See {{bug|45458}}

==Error message about invalid call to script or invalid use of script in index expression==

If Octave shows an error message about {{Codeline|invalid call to script .../close.m}} or {{Codeline|invalid use of of script .../close.m in index expression}}, it means that you have created a script called close.m that is overriding the built-in Octave function {{Codeline|close}}. Octave functions and scripts share the same global namespace. It is best to avoid creating your own scripts or functions that have the same name as an Octave function as to avoid this error regarding the invalid call to script or invalid use of script in index expression.

=Licensing issues=

==If I write code using Octave do I have to release it under the GPL?==

The answer depends on precisely how the code is written and how it works:

* Code written '''entirely in the scripting language of Octave''' (interpreted code in .m files) may be released under the terms of whatever license you choose.

* Code written using [https://www.gnu.org/software/octave/doc/interpreter/Oct_002dFiles.html Octave's native code interface] (also known as a .oct file) necessarily links with Octave internals and is considered a derivative work of Octave.  Therefore it must be released under terms that are compatible with the [https://www.gnu.org/licenses/gpl.html GPL].

* Code written using [https://www.gnu.org/software/octave/doc/interpreter/Mex_002dFiles.html Octave's implementation of the Matlab MEX interface] may be released under the terms of whatever license you choose, provided that the following conditions are met:

:# The MEX file may not use any bindings that are specific to Octave, '''it has to use the MEX interface only'''.  In other words, it should be possible in principle to use the MEX file with other programs that implement the MEX interface (e.g., Matlab).  For example including an Octave header file or calling an Octave function within the MEX file, that is not related with Octave's implementation of the MEX interface make the MEX file a derivative work of Octave and has therefore to be released under terms that are compatible with the [https://www.gnu.org/licenses/gpl.html GPL].
:# The MEX file may not be distributed together with Octave in such a way that they effectively create a single work.  For example, you should not distribute the MEX file and Octave together in a single package such that Octave automatically loads and runs the MEX file when it starts up.  There are other possible ways to effectively create a single work.

* Code that '''embeds the Octave interpreter''' (e.g., by calling the <code>octave_main</code> function), or that calls functions from Octave's libraries (e.g., liboctinterp, liboctave, or libcruft) is considered a derivative work of Octave and therefore must be released under terms that are compatible with the GPL.

==Will you change the license of the Octave libraries for me?==

'''No.''' Instead of asking us to change the licensing terms for Octave, we recommend that you release your program under terms that are compatible with the GPL, this way the free software community can be benefited from your work the same as you were/have benefited from the work of all the people who have contributed to Octave.

==Should I favor the MEX interface to avoid the GPL?==

'''No.''' The original reason for implementing the [https://www.gnu.org/software/octave/doc/interpreter/Mex_002dFiles.html MEX interface] for Octave was to allow Octave to run free software that uses MEX files (the particular goal was to run [https://computation.llnl.gov/projects/sundials/release-history#sundialsTB sundialsTB] in Octave). The intent was to liberate that software from Matlab and increase the amount of free softwares available to Octave users & not to enable people to write proprietary code for Octave. For the good of the community, we strongly encourage users of Octave to release the code they write for Octave under terms that are compatible with the [https://www.gnu.org/licenses/gpl.html GPL].

==Why can't I use code from File Exchange in Octave?==

According to the Matlab Central [https://www.mathworks.com/matlabcentral/termsofuse.html Terms of Use] (Last updated: 10-Aug-2016), all submitted code is licensed under the [https://en.wikipedia.org/wiki/BSD_licenses BSD license] by default (cf. § 5 [https://www.mathworks.com/matlabcentral/termsofuse.html Terms of Use]), but it is clearly stated that:

{{Quote|text=Content submitted to File Exchange may only be used with MathWorks products. | |§ 2(a)(iii) [https://www.mathworks.com/matlabcentral/termsofuse.html Terms of Use]}}

That does not apply to GNU Octave, therefore the usage is in general prohibited.  It should suffice — although interpretations of this vary — to contact the author directly to send you the code personally (maybe released under a free license), or download the code from the author's own website, if available. [[Asking_for_package_to_be_released_under_GPL:_examples|Some examples of letters/email sent to authors for that purpose]].

=Installation=

==How can I install Octave on Windows?==

:'' So as to install GNU-Octave for Windows O.S, refer to : [[Octave for Microsoft Windows]]''

==How can I install Octave on MacOS?==

:''So as to install GNU-Octave for MacOS, refer to : [[Octave for macOS]]''

==How can I install Octave on GNU/Linux?==

:'' So as to install GNU-Octave on GNU/Linux, refer to: [[Octave for GNU/Linux]]''

==How to install Octave on Android OR What is the Octave app available in the Google Play store?==

There is an '''unofficial''' Octave app available for Android in the Google Play store.  Please see [[Octave for Android]] for further  information.

==How can I install Octave on platform X?==

Octave currently runs on [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], and [[Octave for Microsoft Windows|Windows]].  It should be possible to make Octave work on other systems as well.  If you are interested in porting Octave to other systems, please contact the maintainers development mailing list [https://lists.gnu.org/mailman/listinfo/octave-maintainers maintainers@octave.org].

==What Octave version should I use?==

For general use, it is recommended to use the latest stable version of Octave (currently {{Release}}), available from http://www.octave.org/download.html.  For development and bleeding-edge features one can obtain the development source code from the Mercurial repository https://hg.savannah.gnu.org/hgweb/octave/graph/.

The used version of Octave is available via the {{manual|ver}} command and a list of user-visible changes since the last release is available via the {{manual|news}} command at the GNU Octave prompt.

==On what platforms does Octave run?==

Octave runs on any platform you can compile it on.  Binary distributions exist for [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], and [[Octave for Microsoft Windows|Windows]].  To work fully functional, Octave requires the used platform to support the underlying numerical libraries like [https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms BLAS], [https://en.wikipedia.org/wiki/LAPACK LAPACK], [http://www.suitesparse.com SuiteSparse], etc., and for plotting [https://www.opengl.org/ OpenGL] or [http://www.gnuplot.info/ gnuplot].

==How can I obtain Octave's source code?==

The latest version of the Octave source code (and older versions) is available from:

* https://www.octave.org/download.html
* https://ftp.gnu.org/gnu/octave/

Since Octave is distributed under the terms of the GPL, you can get Octave from a friend who has a copy.

==How can I build Octave from the source code?==

To use Octave it is usually not required to build it from it's source code.  Binary distributions exist for [[Octave for GNU/Linux|GNU/Linux]], [[Octave for macOS|macOS]], and [[Octave for Microsoft Windows|Windows]].

If you have reasons to build Octave from the source code, see [[Building]] for more information.

==What do I need to build Octave from the source code?==

For a list of build dependencies, refer to  [[Building]].

==Do I need GCC to build Octave from the source code?==

No. The development is done primarily with [https://gcc.gnu.org/ GCC], so you may hit some incompatibilities.  Octave is intended to be portable to any standard conforming compiler (for example [https://clang.llvm.org/ clang] is known to work as well).  If you face any difficulties that you think are bugs, please report them to the [http://bugs.octave.org bug tracker], or ask for help on the [https://lists.gnu.org/mailman/listinfo/help-octave help@octave.org mailing list].

=What's new in Octave?=

Each new Octave release introduces many new features.  A complete list of user visible changes can be seen by running <code>news</code> at the Octave prompt.

* '''What's new in the next version of Octave?'''
** See the [https://hg.savannah.gnu.org/hgweb/octave/file/tip/NEWS NEWS file] on the development branch.
* '''What was new in Octave Version X.Y.Z?'''
** See [[Release History]].

=Packages and Octave Forge=

==How do I install or load all Octave Forge packages?==

Do not do it!  Really, there is no reason to do this.  Octave has many packages for different needs and is unlikely that you need all of them.  You either have a small set of required packages, in which case
you know them by name; or you want them all "just because", in which case you don't really need them.

The common misconception is that the more packages one has installed and loaded, the more complete and powerful its Octave installation will be.  However, in the same way one would never install all perl modules, ruby gems, python packages, and C++ libraries (because it simply makes no sense), one should not install all Octave packages.

Packages should be installed and loaded selectively.  Note that some packages are meant to shadow core functions changing the way Octave works, and that different packages can have different functions with the same name leading to unpredictable results.

If you really really really want to do load all packages, you can with the following:
<syntaxhighlight lang="octave">
## WARNING: loading all packages is probably not the solution you are looking for.
cellfun (@(x) pkg ("load", x.name), pkg ("list"));
</syntaxhighlight>

==I have installed a package but still get a "foo undefined" error?==

You have probably forgotten to load the package.  Use {{Codeline|pkg load package-name}} to load it.  Most packages are no longer loaded automatically to avoid surprises.  See reasoning on related FAQ [[FAQ#How_do_I_install_all_Octave_packages.3F|how do I install all Octave packages]].  If you want a specific package to be loaded by default at startup, consider adding the {{Codeline|pkg load}} command on your {{path|[[.octaverc]]}} file.

==I cannot install a package. Octave complains about a missing mkoctfile.==

You should normally use your distribution's packages.  For Debian and Fedora, Octave package <code>foo</code> will be a deb or rpm called <code>octave-foo</code>, and you should install that instead using <code>apt</code> or <code>yum</code>.

If you really need to build Octave packages from source to install them, you'll need {{manual|mkoctfile}}. Most distributions split Octave into several packages.  The script {{manual|mkoctfile}} is then part of a separate package:

* Debian/Ubuntu: [https://packages.debian.org/stretch/liboctave-dev liboctave-dev]

* Fedora: {{Codeline|octave-devel}}

==How do I automatically load a package at Octave startup?==

When Octave starts, it runs the file {{Path|~/.octaverc}} (in your user's home directory).  If you want Octave to automatically load a package, simply add a <code>pkg load pkg-name</code> command to it.  If the files does not exist, create it.

If you do this, remember that other people may not have Octave configured to load packages at startup.  Therefore, if you write code for others, remember that your programs still need to load the packages they require.

=Octave usage=

==How do I execute an Octave script?==

First of all, make sure you understand [http://www.octave.org/doc/interpreter/Script-Files.html the difference between script files and function files].  If you want to execute a function defined in a file, just call the function like any other Octave function: <code>foo(arg1, arg2);</code>

To execute a script from within Octave, just type its name without the <code>.m</code> extension.  Thus, if you have a script called <code>foo.m</code>, just type <code>foo</code> from within the Octave command prompt to execute it.  You have to make sure that the script is in your current working directory or in Octave's load path.  Type {{manual|pwd}} to get the current working directory or type {{manual|path}} to see which paths belong to Octave's load path.  The current working directory is referred to as "." in the output of {{manual|path}}.

If the script name has characters that are not valid for an Octave identifier, or if you do not want to use {{manual|addpath}} to add the script's location to the current path, you can use the {{manual|run}} function instead:

<syntaxhighlight lang="octave">
run ("Script Name With Spaces.m")
run ("/opt/local/foo.m")
</syntaxhighlight>

An alternative is to run the script from outside Octave by calling Octave from your operating system shell.  Unlike calling the script from inside Octave, this also allows you to pass arguments from the shell into the script, which the script can access using the {{manual|argv}} command:

   $ octave the-script.m arg1 arg2

In a Unix environment, if the script has a [http://en.wikipedia.org/wiki/Shebang_%28Unix%29 shebang] (e.g. <code>#!/usr/bin/octave</code>) and executable permissions, you can call it like any other Unix program with arguments:

   $ ./the-script arg1 arg2

If you call the script from the shell and it's plotting, please note [[#When I try plotting from a script, why am I not seeing anything?|how to plot when running a script from the shell]].

==How do I close a figure?== 

To close the current figure type {{manual|close}} in the Octave command prompt.

==How do I set the number of displayed decimals?==

You can control the number of displayed decimals using the {{manual|format}} command:

<syntaxhighlight lang="octave">
>> format long
>> pi
pi = 3.14159265358979
>> format short
>> pi
pi = 3.1416
</syntaxhighlight>

==How do I call an Octave function from C++?==

Please read the manual https://www.gnu.org/software/octave/doc/interpreter/Calling-Octave-Functions-from-Oct_002dFiles.html.

==How do I change color/line definition in gnuplot postscript?==

Here is a awk script to get a rainbow color map

 #!/bin/awk -f
  
  BEGIN {
    split("0 4 6 7 5 3 1 2 8", rainbow, " ");
    split("7 3 1 0 2 4 6 5 8", invraim, " ");
  }
  
  $1 ~ /\/LT[0-8]/ {
    n = substr($1, 4, 1);
    if (n == 0)
      lt = "{ PL [] 0.9 0.1 0.1 DL } def";
    else if (n == 1)
      lt = "{ PL [4 dl 2 dl] 0.1 .75 0.1 DL } def";
    else if (n == 2)
      lt = "{ PL [2 dl 3 dl] 0.1 0.1 0.9 DL } def";
    else if (n == 3)
      lt = "{ PL [1 dl 1.5 dl] 0.9 0 0.8 DL } def";
    else if (n == 4)
      lt = "{ PL [5 dl 2 dl 1 dl 2 dl] 0.1 0.8 0.8 DL } def";
    else if (n == 5)
      lt = "{ PL [4 dl 3 dl 1 dl 3 dl] 0.9 0.8 0.2 DL } def";
    else if (n == 6)
      lt = "{ PL [2 dl 2 dl 2 dl 4 dl] 0.5 0.3 0.1 DL } def";
    else if (n == 7)
      lt = "{ PL [2 dl 2 dl 2 dl 2 dl 2 dl 4 dl] 1 0.4 0 DL } def";
    else if (n == 8)
      lt = "{ PL [2 dl 2 dl 2 dl 2 dl 2 dl 2 dl 2 dl 4 dl] 0.5 0.5 0.5 DL } def";
    $0 = sprintf("/LT%d %s", rainbow[n+1], lt);
    ##$0 = sprintf("/LT%x %s", invraim[n+1], lt);
    ##$0 = sprintf("/LT%x %s", n, lt);
  }
  
  { print; }

==How do I tell if a file exists?==

One can use the function {{manual|exist}} to tell if a regular file, say <code>foo.txt</code> exist in Octave's load path, or the current directory:

<syntaxhighlight lang="octave">
>> exist ("foo.txt", "file")  # 2, if file exists, 0 otherwise
ans = 2
</syntaxhighlight>

==How do I create a plot without a window popping up (plot to a file directly)?==

<syntaxhighlight lang="octave">
figure (1, "visible", "off");
plot (sin (1:100));
print -deps "/tmp/sin.eps"
</syntaxhighlight>

One can set that behavior as default:

<syntaxhighlight lang="octave">
set (0, "defaultfigurevisible", "off");
</syntaxhighlight>

==How do I increase Octave's precision?==

Octave's default numerical type is [https://en.wikipedia.org/wiki/IEEE_754 IEEE 754] binary64, a.k.a. "double" or "hardware floats".  This type has a precision of 53 bits or about 16 decimal digits. It is supported by each modern computer hardware, so it is really '''fast'''.  This type is assumed throughout for Octave's calculations.  If more precision was required, one can obtain a "few bits more" by using integer types, e.g. {{manual|uint64}}, but in general one cannot expect more precision from any '''fast''' numerical software.  Just to visualize "how big" those numerical limits are, consider the following table:

{| class="wikitable"
|+ Limits of some of Octave's data types obtained by {{manual|intmax}} and {{manual|flintmax}}.
|-
| <code>intmax ("uint64")</code>
| style="text-align: right;" | <code>18,446,744,073,709,551,615</code>
| <code>2^64-1</code>
|-
| <code>intmax ("int64")</code>
| style="text-align: right;" | <code>9,223,372,036,854,775,807</code>
| <code>2^63-1</code>
|-
| <code>flintmax ("double")</code>
| style="text-align: right;" | <code>9,007,199,254,740,992</code>
| <code>2^53</code>
|-
| <code>flintmax ("single")</code>
| style="text-align: right;" | <code>16,777,216</code>
| <code>2^24</code>
|}

When working with other types than "double" in Octave, one has to make sure, that the first operand is converted to the desired type:

<syntaxhighlight lang="Octave">
>> uint64 (2^53 + 1)
ans = 9007199254740992
>> uint64 (2^53) + 1
ans = 9007199254740993
</syntaxhighlight>

Notice the difference, in the first line the addition within the brackets is performed using double precision, therefore the result gets "truncated" to the maximum possible value without a warning.  The third line uses throughout uint64 precision.

Consider carefully if your problem really needs more precision.  Often if you're running out of precision the problem lies fundamentally in your methods being [https://en.wikipedia.org/wiki/Numerical_stability numerically unstable], thus more precision will not help you here.

If you absolutely must have more precision, you're at present better off using a [https://en.wikipedia.org/wiki/Computer_algebra_system CAS] instead of Octave.  However, CAS or symbolic computations must be implemented '''in software''' which makes it much slower than hardware floats.  An example of such a CAS is [http://www.sagemath.org/ Sage] or have a look at Octave's [[Symbolic package]].

==How do I run a Matlab P-file in Octave?==

You can't. Matlab P-files (files with a <code>.p</code> file extension), also known as P-code, are [https://en.wikipedia.org/wiki/Obfuscation_%28software%29 obfuscated] files that cannot be run outside of Matlab itself.  The original source Matlab m-files that were used to generate these P-files should be used in Octave instead.

There are no plans to support running P-files produced by Matlab in Octave.

==How does Octave solve linear systems?==

In addition to consulting Octave's source for the precise details, you can read the Octave manual for a complete high-level description of the algorithm that Octave uses to decide how to solve a particular linear system, e.g. how the backslash operator <code>A \ x</code> will be interpreted.  Sections [http://www.octave.org/doc/interpreter/Techniques-Used-for-Linear-Algebra.html Techniques Used for Linear Algebra] and [http://www.octave.org/doc/interpreter/Sparse-Linear-Algebra.html Linear Algebra on Sparse Matrices] from the manual describe this procedure.

==How do I do X?==

You are probably looking for the function {{manual|lookfor}}.  This function searches the help text of all functions for a specific string and returns a list of functions.  Note that by default it will only search the first line of the help text (check <code>help lookfor</code> at the octave prompt for more).  The following example helps to find the function to calculate correlation coefficient in a matrix:

  >> lookfor correlation
  corr                Compute matrix of correlation coefficients.
  corrcoef            Compute a matrix of correlation coefficients.
  spearman            Compute Spearman's rank correlation coefficient RHO.

Also, there's a high chance that the function name has a suggestive name, and so you can try auto-completion to get some hints.  For the previous example, typing <code>corr</code> at the octave prompt followed by pressing the {{key press|Tab}}-Key twice would suggest the following:

  >> corr
  corr     corrcoef

=Differences between Octave and Matlab=
:''See [[Differences between Octave and Matlab]]''.

=[https://en.wikipedia.org/wiki/Graphical_user_interface GUI]=

==Does Octave have a GUI?==

'''Yes!''' It was officially released with Octave 4.0.0.  It was also available since version 3.8.0 as an experimental feature (use the {{Codeline|--force-gui}} option to start Octave).

==Why did you create yet another GUI instead of making one that already exists better?==

The previously existing GUIs were not part of Octave itself.  The integration within Octave was rather bad, as all of them treated Octave as a foreign black box and used pipes for communication.  This approach is bound to fail with each new version of Octave, as any fix would only be temporary.  For historical reasons and to honor the approaches, a short list of previous GUIs for Octave:

* '''QtOctave''' was a great, beautiful, and very useful tool which is now abandoned and incompatible with newer versions of Octave.  We are thankful to its developers to make it free software so we could reuse large chunks of it for what is now the Octave GUI.

* '''Quint''' was a project for an Octave GUI that actually tried to do it right.  Eventually [https://lists.gnu.org/archive/html/octave-maintainers/2011-07/msg00096.html it was merged into the Octave repository] and is no longer a separate project.  Also, many bits from QtOctave were reused in the GUI.

* '''[http://www.xoctave.com/ Xoctave]''', which is proprietary and commercial.

* '''GUI Octave''', which was proprietary and is no longer available.

=Graphics: backends and toolkits=

==What are the supported graphics backends?==

* [https://www.opengl.org/ OpenGL] via the graphics toolkits '''[https://www.qt.io/ qt]''' (current default) and '''[http://www.fltk.org/ fltk]'''
* [http://www.gnuplot.info/ gnuplot] via the '''gnuplot''' graphics toolkit

==How do I change my graphics toolkit?==

There are three commands to deal with graphics toolkits:

{| class="wikitable"
| <code>available_graphics_toolkits</code>
| lists all available graphics toolkits
|-
| <code>graphics_toolkit</code>
| displays the currently used graphics toolkit
|-
| <code>graphics_toolkit ("qt/fltk/gnuplot")</code>
| sets the graphics toolkit to either of [https://www.qt.io/ qt], [http://www.fltk.org/ fltk], or [http://www.gnuplot.info/ gnuplot], if available
|}

==Why did you replace gnuplot with an OpenGL backend?==

The development of Octave is committed to being both compatible with Matlab and adding additional features.  Toward those ends, the developers decided to introduce a native OpenGL backend that supports Matlab handle graphics and its uicontrols.  Starting with the 3.8 release, Octave uses OpenGL graphics by default (with [http://www.fltk.org/ FLTK widgets] in Octave 3.8 and [https://www.qt.io/ Qt widgets] in Octave 4.0 and later).

==Are there any plans to remove the gnuplot backend?==

'''No.''' There are no plans to remove the gnuplot backend.  It will be available as long as our users find it useful.

==How can I implement a new graphics backend/toolkit?==

This is one of those times where the best documentation is to read the existing code.  We have three different toolkits in Octave now, so there are some examples to draw from.

= Development =

== When will feature X be released or implemented? ==

When it's ready, sooner [https://www.octave.org/get-involved.html if you help].  You can [https://savannah.gnu.org/patch/?group=octave send us patches] if you can implement feature X yourself.  If you can't, some [https://www.octave.org/commercial-support.html developers may be convinced to work on your specific problem for some money].

== How can I get involved in Octave development? ==

:''See [[Developer FAQ]]''.

[[Category:FAQ]]