Write guide for parallel processing trials.

.github/workflows/tests.yml

@@ -45,3 +45,7 @@ jobs:
     - name: Run docts
       run: |
         python doctests.py
+
+    - name: Test parallel processing script
+      run: |
+        python docs/_static/script_for_parallel_processing/main.py

docs/Guides/index.rst

@@ -28,4 +28,5 @@ Contents:
    deadlock.rst
    process_based.rst
    from_file.rst
-   behaviour/index.rst
+   behaviour/index.rst
+   parallel_process.rst

docs/Guides/parallel_process.rst

@@ -0,0 +1,59 @@
+.. _parallel_process:
+
+=========================
+How to Parallelise Trials
+=========================
+
+It is possible to repeat a simulation in parallel using the cores available on a
+given computer. This can lead to decreases in computational time as instead of
+running each successive simulation :ref:`one after the other <tutorial-iv>` they
+can be run at the same time.
+
+As an example consider the following simulation network::
+
+    >>> import ciw
+    >>> N = ciw.create_network(arrival_distributions=[ciw.dists.Exponential(rate=0.2)],
+    ...                        service_distributions=[ciw.dists.Exponential(rate=0.1)],
+    ...                        number_of_servers=[3])
+
+The following function will return the mean wait time::
+
+    >>> def get_mean_wait(network, seed=0, max_time=10000):
+    ...     """Return the mean waiting time for a given network"""
+    ...     ciw.seed(seed)
+    ...     Q = ciw.Simulation(N)
+    ...     Q.simulate_until_max_time(max_simulation_time=max_time)
+    ...     recs = Q.get_all_records()
+    ...     waits = [r.waiting_time for r in recs]
+    ...     mean_wait = sum(waits) / len(waits)
+    ...     return mean_wait
+    >>> get_mean_wait(network=N)
+    3.386690...
+
+To be able to better approximate the average wait, the above function will be
+repeated and the average taken::
+
+    >>> import numpy as np
+    >>> max_time = 500
+    >>> repetitions = 200
+    >>> np.mean([get_mean_wait(network=N, max_time=max_time, seed=seed) for seed in range(repetitions)])
+    3.762233...
+
+To obtain the above by running 2 simulations at the same time (assuming that 2
+cores are available), the :code:`multiprocessing` library can be used. In which
+case the following :download:`main.py
+<../_static/script_for_parallel_processing/main.py>` script gives a working
+example:
+
+.. literalinclude:: ../_static/script_for_parallel_processing/main.py
+
+It is possible to use :code:`multiprocessing.cpu_count()` to obtain the number
+of available cores.
+
+Note that the conditional :code:`if __name__ == '__main__':` is needed to ensure
+that :code:`get_mean_wait` can be pickled. This is necessary to ensure that it
+can be used by the parallel processing pool.
+
+The :code:`multiprocessing` library is part of the python standard library so no
+further dependencies are required. However other options are available, one
+example of which is `dask <https://www.dask.org>`_.

docs/_static/script_for_parallel_processing/README.md

@@ -0,0 +1,5 @@
+This directory contains a script for carrying out parallel processing with ciw.
+
+This is referred to in `./docs/Guides/parallel_process.rst`.
+
+This script is shown in the docs but is also tested as part of the CI.

docs/_static/script_for_parallel_processing/main.py

@@ -0,0 +1,30 @@
+import ciw
+import multiprocessing
+import numpy as np
+
+N = ciw.create_network(
+    arrival_distributions=[ciw.dists.Exponential(rate=0.2)],
+    service_distributions=[ciw.dists.Exponential(rate=0.1)],
+    number_of_servers=[3],
+)
+
+max_time = 500
+repetitions = 200
+
+
+def get_mean_wait(network, seed=0, max_time=10000):
+    """Return the mean waiting time for a given network"""
+    ciw.seed(seed)
+    Q = ciw.Simulation(N)
+    Q.simulate_until_max_time(max_simulation_time=max_time)
+    recs = Q.get_all_records()
+    waits = [r.waiting_time for r in recs]
+    mean_wait = sum(waits) / len(waits)
+    return mean_wait
+
+
+if __name__ == "__main__":
+    pool = multiprocessing.Pool(processes=2)
+    args = [(N, seed, max_time) for seed in range(repetitions)]
+    waits = pool.starmap(get_mean_wait, args)
+    print(np.mean(waits))