.. CHIMES config 
   Alexander Richings 28th January 2020 

.. _CHIMES_config:

Configuring SWIFT with CHIMES
------------------------------

To build SWIFT with the CHIMES module, you will need the following configuration options: 

+------------------------------------+---------------------------------------------------------------+
| Configuration option               | Description                                                   |
+====================================+===============================================================+
| ``--with-cooling=CHIMES``          | | Sets the SWIFT cooling function to use the CHIMES module.   |
|                                    | | By default, it will assume you are using the reduced CHIMES |
|                                    | | network with only H and He in non-equilibrium, i.e. with a  |
|                                    | | network size of 10. To include metals in non-equilibrium as |
|                                    | | well, you will need to use ``--with-cooling=CHIMES_xxx``,   |
|                                    | | where ``xxx`` is the number of ions and molecules included  |
|                                    | | in the CHIMES network, i.e. that are evolved in             |
|                                    | | non-equilibrium. Note that this has to match the size of    |
|                                    | | the network determined from the elements that are included  |
|                                    | | according to the Include[Element] parameters (see the       |
|                                    | | parameters section). The size of the full CHIMES network,   |
|                                    | | with all elements included, is 157.                         |
|                                    |                                                               |
+------------------------------------+---------------------------------------------------------------+
| ``--with-sundials=/sundials/path`` | | Builds SWIFT with the Sundials libraries, which are         |
|                                    | | required by the CHIMES module. If you just use              |
|                                    | | ``--with-sundials``, it will try to find the Sundials       |
|                                    | | libraries automatically on your system. However, if it      |
|                                    | | cannot find these libraries automatically (for example, if  |
|                                    | | you built the libraries yourself), then you can directly    |
|                                    | | pass it the path to the directory where the Sundials        |
|                                    | | libraries are installed.                                    |
|                                    |                                                               |
+------------------------------------+---------------------------------------------------------------+
| | ``--enable-chimes-``             | | Use this configure option to build CHIMES in double         |
| | ``double-precision``             | | precision. If this option is not used, CHIMES will default  |
|                                    | | to single precision. Note that the Sundials library must    |
|                                    | | be built with the same precision as CHIMES.                 |
|                                    |                                                               |
+------------------------------------+---------------------------------------------------------------+