diff --git a/doc/manual/source/installation-and-configuration.rst b/doc/manual/source/installation-and-configuration.rst index cc0a4f69e0a18c5c02b2c045c59c894d326927b9..a109f3cfc2b78e23c3400e78fde9f9533acdead3 100644 --- a/doc/manual/source/installation-and-configuration.rst +++ b/doc/manual/source/installation-and-configuration.rst @@ -84,19 +84,31 @@ be under ``/usr/share/doc/dynare-doc`` (only on Debian, Ubuntu and Linux Mint). On macOS -------- -To install Dynare for use with MATLAB, execute the automated installer -called ``dynare-4.x.y.pkg`` (where *4.x.y* is the version number), and -follow the instructions. The default installation directory is -``/Applications/Dynare/4.x.y`` (please refer to the `Dynare wiki`_ for -detailed instructions). - -After installation, this directory will contain several -sub-directories, among which are ``matlab``, ``mex`` and ``doc``. +To install Dynare for use with MATLAB, execute the automated installer called +``dynare-4.x.y.pkg`` (where *4.x.y* is the version number), and follow the +instructions. The default installation directory is +``/Applications/Dynare/4.x.y``. After installation, this directory will contain +several sub-directories, among which are ``matlab``, ``mex``, and ``doc``. Note that several versions of Dynare can coexist (by default in ``/Applications/Dynare``), as long as you correctly adjust your path settings (see :ref:`words-warning`). +By default, the installer installs a version of GCC (for use with :opt:`use_dll`) +in the installation directory, under the ``.brew`` folder. To do so, it also +installs a version of `Homebrew <https://brew.sh>`__ in the same folder and +Xcode Command Line Tools (this is an Apple product) in a system folder. + +All of this requires a bit of time and hard disk space. The amount of time it +takes will depend on your computing power and internet connection. To reduce +the time the Dynare installer takes, you can install Xcode Command Line Tools +yourself (see :ref:`prerequisites-macos`). Dynare, Homebrew, and GCC use +about 600 MB of disk space while the Xcode Command Line Tools require about 400 +MB. + +If you do not use the :opt:`use_dll` option, you have the choice to forgo the +installation of GCC and hence Dynare will only take about 50 MB of disk space. + Dynare for Octave works with Octave installed via the package located here: `https://octave-app.org <https://octave-app.org>`__. @@ -134,14 +146,17 @@ Users of Octave under GNU/Linux should install the package for MEX file compilation (under Debian, Ubuntu or Linux Mint, it can be done via ``apt install liboctave-dev``). +.. _prerequisites-macos: + Prerequisites on macOS ---------------------- Dynare now ships a compilation environment that can be used with the -:opt:`use_dll` option. Specifically, the Dynare installer downloads and -installs the Xcode Command Line Tools, installs `Homebrew <https://brew.sh>`_ -under the Dynare installation directory (in the ``.brew`` folder), and finally -installs GCC. +:opt:`use_dll` option. To install this environment correctly, the Dynare +installer ensures that the Xcode Command Line Tools (an Apple product) have +been installed on a system folder. To install the Xcode Command Line Tools +yourself, simply type ``xcode-select --install`` into the Terminal +(``/Applications/Utilities/Terminal.app``) prompt. Configuration =============