diff --git a/README.md b/README.md index 10d2b563..a1c179a7 100644 --- a/README.md +++ b/README.md @@ -173,7 +173,7 @@ propagated_orbits = propagator.propagate_orbits( orbits, times, chunk_size=100, - num_jobs=1, + max_processes=1, ) ``` diff --git a/adam_core/propagator/propagator.py b/adam_core/propagator/propagator.py index ebedabc2..d8e559ea 100644 --- a/adam_core/propagator/propagator.py +++ b/adam_core/propagator/propagator.py @@ -49,7 +49,7 @@ def propagate_orbits( orbits: Orbits, times: Time, chunk_size: int = 100, - num_jobs: Optional[int] = 1, + max_processes: Optional[int] = 1, ) -> Orbits: """ Propagate each orbit in orbits to each time in times. @@ -62,9 +62,9 @@ def propagate_orbits( Times to which to propagate orbits. chunk_size : int, optional Number of orbits to send to each job. - num_jobs : int or None, optional - Number of jobs to launch. If None then the number of - jobs will be equal to the number of cores on the machine. If 1 + max_processes : int or None, optional + Maximum number of processes to launch. If None then the number of + processes will be equal to the number of cores on the machine. If 1 then no multiprocessing will be used. Returns @@ -72,8 +72,8 @@ def propagate_orbits( propagated : `~adam_core.orbits.orbits.Orbits` Propagated orbits. """ - if num_jobs is None or num_jobs > 1: - with concurrent.futures.ProcessPoolExecutor(max_workers=num_jobs) as executor: + if max_processes is None or max_processes > 1: + with concurrent.futures.ProcessPoolExecutor(max_workers=max_processes) as executor: futures = [] for orbit_chunk in _iterate_chunks(orbits, chunk_size): futures.append(executor.submit(propagation_worker, orbit_chunk, times, self)) @@ -105,7 +105,7 @@ def generate_ephemeris( orbits: Orbits, observers, chunk_size: int = 100, - num_jobs: Optional[int] = 1, + max_processes: Optional[int] = 1, ): """ Generate ephemerides for each orbit in orbits as observed by each observer @@ -120,9 +120,9 @@ def generate_ephemeris( orbit. chunk_size : int, optional Number of orbits to send to each job. - num_jobs : int or None, optional - Number of jobs to launch. If None then the number of - jobs will be equal to the number of cores on the machine. If 1 + max_processes : int or None, optional + Number of processes to launch. If None then the number of + processes will be equal to the number of cores on the machine. If 1 then no multiprocessing will be used. Returns @@ -134,8 +134,8 @@ def generate_ephemeris( TODO: Add ephemeris class TODO: Add an observers class """ - if num_jobs is None or num_jobs > 1: - with concurrent.futures.ProcessPoolExecutor(max_workers=num_jobs) as executor: + if max_processes is None or max_processes > 1: + with concurrent.futures.ProcessPoolExecutor(max_workers=max_processes) as executor: futures = [] for orbit_chunk in _iterate_chunks(orbits, chunk_size): futures.append(executor.submit(ephemeris_worker, orbit_chunk, observers, self)) diff --git a/adam_core/propagator/tests/test_propagator.py b/adam_core/propagator/tests/test_propagator.py index 7bd4bcc4..780cf505 100644 --- a/adam_core/propagator/tests/test_propagator.py +++ b/adam_core/propagator/tests/test_propagator.py @@ -30,7 +30,7 @@ def test_propagator_single_worker(): times = Time(["2020-01-01T00:00:00", "2020-01-01T00:00:01"]) prop = MockPropagator() - have = prop.propagate_orbits(orbits, times, num_jobs=1) + have = prop.propagate_orbits(orbits, times, max_processes=1) assert len(have) == len(orbits) * len(times) @@ -40,6 +40,6 @@ def test_propagator_multiple_workers(): times = Time(["2020-01-01T00:00:00", "2020-01-01T00:00:01"]) prop = MockPropagator() - have = prop.propagate_orbits(orbits, times, num_jobs=4) + have = prop.propagate_orbits(orbits, times, max_processes=4) assert len(have) == len(orbits) * len(times)