Skip to content

Commit

Permalink
Updated documentation for new behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
ppinchuk committed Nov 21, 2023
1 parent 790e372 commit 6540433
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion reV/generation/generation.py
Original file line number Diff line number Diff line change
Expand Up @@ -782,7 +782,10 @@ def run(self, out_fpath=None, max_workers=1, timeout=1800,
module name and/or resource data year will get added to the
output file name. By default, ``None``.
max_workers : int, optional
Number of local workers to run on. By default, ``1``.
Number of local workers to run on. If ``None``, or if
running from the command line and omitting this argument
from your config file completely, this input is set to
``os.cpu_count()``. Otherwise, the default is ``1``.
timeout : int, optional
Number of seconds to wait for parallel run iteration to
complete before returning zeros. By default, ``1800``
Expand Down

0 comments on commit 6540433

Please sign in to comment.