From 858634ce2a23221719b3fe22a1394bf26a4a5226 Mon Sep 17 00:00:00 2001 From: Aman Chokshi Date: Fri, 20 Nov 2020 01:14:06 +1100 Subject: [PATCH] Added warning to use --max_cores=1 on laptops --- docs/embersbyexample.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/embersbyexample.rst b/docs/embersbyexample.rst index ec62040..fa5c1fb 100644 --- a/docs/embersbyexample.rst +++ b/docs/embersbyexample.rst @@ -211,8 +211,9 @@ We can now align all the raw RF files within a date interval using the :func:`~e MWA tile are smoothed and aligned and saved to compressed :samp:`npz` file by :func:`~numpy.savez_compressed`. **WARNING:** This is probably the most resource hungry section. It typically took me 2 days to process 5 months of data, on a machine with 40 cpu cores. Beware, and be patient. -The :samp:`--max_cores` option is available to limit number of cores used by the :samp:`align_batch` paralelized cli-tool. An analysis of the performance of this -tool can be found at :doc:`performance`. +The :samp:`--max_cores` option is available to limit number of cores used by the :samp:`align_batch` paralelized cli-tool. If you are experimenting with EMBERS +on a laptop it is highly suggested that you use set :samp:`--max_cores=1` for any batch script. This is sufficent for testing and will not run your laptop to the +ground by using all availible resources. An analysis of the performance of this tool can be found at :doc:`performance`. The :samp:`align_batch` cli tool is a convenient way to align large volumes of data