Move functional API in `pybatsim-functional` package

pybatsim-functional/pyproject.toml

+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "pybatsim-functional"
+version = "4.0.0-alpha.0"
+description = "Functional API for PyBatsim"
+keywords = [
+  "scheduler",
+  "simulation",
+]
+repository = "https://gitlab.inria.fr/batsim/pybatsim"
+authors = [
+  "Steffen Lackner <lackner@cs.tu-darmstadt.de>",
+  "Michael Mercier <michael.mercier@inria.fr>",
+  "Clément Mommessin <clement.mommessin@inria.fr>",
+]
+maintainers = [
+  "Raphaël Bleuse <raphael.bleuse@inria.fr>",
+]
+license = "LGPL-3.0-only"
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "Topic :: Scientific/Engineering",
+  "Topic :: System :: Distributed Computing",
+]
+packages = [
+  {include = "pybatsim_functional", from = "src"},
+]
+
+[tool.poetry.dependencies]
+python = "^3.7.1"
+pybatsim = {path = "../pybatsim-core", develop = true}
+
+[tool.poetry.dev-dependencies]
+
+# definition of PyBatsim schedulers
+[tool.poetry.plugins."pybatsim.schedulers"]
+"func:backfill-sjf" = "pybatsim_functional.schedulers.schedEasySjfBackfill:SchedEasySjfBackfill"
+"func:fcfs" = "pybatsim_functional.schedulers.schedFcfs:SchedFcfs"
+"func:filler" = "pybatsim_functional.schedulers.schedFiller:SchedFiller"
+"func:send-recv" = "pybatsim_functional.schedulers.schedSendRecv:SchedSendRecv"

pybatsim-core/src/pybatsim/batsim/sched/__init__.py → pybatsim-functional/src/pybatsim_functional/__init__.py

 """
-    batsim.sched
-    ~~~~~~~~~~~~
+    pybatsim_functional
+    ~~~~~~~~~~~~~~~~~~~
 
     An advanced scheduler API based on Pybatsim.
 
@@ -10,5 +10,5 @@ from .alloc import Allocation
 from .job import Job, Jobs
 from .profiles import Profile, Profiles
 from .resource import ComputeResource, Resource, ResourceRequirement, Resources
-from .scheduler import Scheduler, as_scheduler
+from .scheduler import Scheduler
 from .workloads import JobDescription, WorkloadDescription, generate_workload

pybatsim-core/src/pybatsim/batsim/sched/algorithms/__init__.py → pybatsim-functional/src/pybatsim_functional/algorithms/__init__.py

 """
-    batsim.sched.algorithms
-    ~~~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.algorithms
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     Helper modules for implementing concrete scheduling algorithms.
 

pybatsim-core/src/pybatsim/batsim/sched/algorithms/backfilling.py → pybatsim-functional/src/pybatsim_functional/algorithms/backfilling.py

 """
-    batsim.sched.algorithms.backfilling
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.algorithms.backfilling
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     Implementation of a simple backfilling algorithm.
 

pybatsim-core/src/pybatsim/batsim/sched/algorithms/filling.py → pybatsim-functional/src/pybatsim_functional/algorithms/filling.py

 """
-    batsim.sched.algorithms.filling
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.algorithms.filling
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     Implementation of a simple job filling algorithm.
 

pybatsim-core/src/pybatsim/batsim/sched/algorithms/utils.py → pybatsim-functional/src/pybatsim_functional/algorithms/utils.py

 """
-    batsim.sched.algorithms.utils
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.algorithms.utils
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     Utils for implementing scheduling algorithms.
 
@@ -295,7 +295,7 @@ def best_find_shortest_current_time(
 
 
 def generate_resources_filter(filter_funcs=[], find_best_funcs=[]):
-    """Generate a filter method (`batsim.sched.utils`) to filter the resources.
+    """Generate a filter method (`pybatsim_functional.utils`) to filter the resources.
 
     :param filter_funcs: filter methods which will be called on each resource whether
                          or not it should be added in the current iteration.

pybatsim-core/src/pybatsim/batsim/sched/alloc.py → pybatsim-functional/src/pybatsim_functional/alloc.py

 """
-    batsim.sched.allocs
-    ~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.alloc
+    ~~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module generalises the allocation of resources.
 """
-import sys
 
-from .resource import Resources, Resource, ComputeResource
+from .resource import Resource, ComputeResource
 from .utils import ListView
 
 

pybatsim-core/src/pybatsim/batsim/sched/events.py → pybatsim-functional/src/pybatsim_functional/events.py

 """
-batsim.sched.events
-~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.events
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This module provides handling of scheduling events.
+    This module provides handling of scheduling events.
 """
 
 import logging

pybatsim-core/src/pybatsim/batsim/sched/job.py → pybatsim-functional/src/pybatsim_functional/job.py

 """
-    batsim.sched.job
-    ~~~~~~~~~~~~~~~~
+    pybatsim_functional.job
+    ~~~~~~~~~~~~~~~~~~~~~~~
 
     This module provides general abstractions to manage jobs (either created by Batsim
     or by the user to submit dynamic jobs).
@@ -11,7 +11,7 @@ from pybatsim.batsim.batsim import Job as BatsimJob, Batsim
 from .utils import ObserveList, filter_list, ListView
 from .alloc import Allocation
 from .messages import MessageBuffer
-from .profiles import Profiles, Profile
+from .profiles import Profiles
 from .workloads import WorkloadDescription
 
 

pybatsim-core/src/pybatsim/batsim/sched/logging.py → pybatsim-functional/src/pybatsim_functional/logging.py

 """
-    batsim.sched.logging
-    ~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.logging
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module provides logging and exporting utilities for data in the scheduler.
 """

pybatsim-core/src/pybatsim/batsim/sched/messages.py → pybatsim-functional/src/pybatsim_functional/messages.py

 """
-    batsim.sched.messages
-    ~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.messages
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module provides abstractions for managing the message buffers with messages from jobs.
 """

pybatsim-core/src/pybatsim/batsim/sched/profiles.py → pybatsim-functional/src/pybatsim_functional/profiles.py

 """
-    batsim.sched.profiles
-    ~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.profiles
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module provides an abstraction layer for job profiles.
 

pybatsim-core/src/pybatsim/batsim/sched/reply.py → pybatsim-functional/src/pybatsim_functional/reply.py

 """
-    batsim.sched.reply
-    ~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.reply
+    ~~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module provides helper classes for replies sent by Batsim.
 

pybatsim-core/src/pybatsim/batsim/sched/resource.py → pybatsim-functional/src/pybatsim_functional/resource.py

 """
-    batsim.sched.resource
-    ~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.resource
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module provides an abstraction around resources to keep track of allocations.
 

pybatsim-core/src/pybatsim/batsim/sched/scheduler.py → pybatsim-functional/src/pybatsim_functional/scheduler.py

 """
-    batsim.sched.scheduler
-    ~~~~~~~~~~~~~~~~~~~~~~
+    pybatsim_functional.scheduler
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module provides a high-level interface for implementing schedulers for Batsim.
-    It contains a basic scheduler used by Pybatsim directly and a high-level scheduler API which will
+    It contains a basic scheduler used by PyBatsim directly and a high-level scheduler API which will
     interact with the basic scheduler to provide a richer interface.
 
 """
 from abc import ABCMeta, abstractmethod
 
 from pybatsim.batsim.batsim import BatsimScheduler, Batsim
-from pybatsim.batsim.network import NetworkHandler
 from pybatsim.batsim.tools.launcher import launch_scheduler_main
 
 from .resource import Resources, ComputeResource
 from .job import Job, Jobs
-from .reply import ConsumedEnergyReply
 from .utils import DictWrapper
 from .messages import Message
-from .utils import ListView
 from .logging import Logger
 from .events import LoggingEvent, EventLogger, EventList
 from .workloads import WorkloadDescription
 
 
 class BaseBatsimScheduler(BatsimScheduler):
-    """The basic Pybatsim scheduler.
+    """The basic PyBatsim scheduler.
 
     :param scheduler: the high-level scheduler which uses this basic scheduler.
 
@@ -243,7 +240,7 @@ class Scheduler(metaclass=ABCMeta):
 
         self._events = EventList()
 
-        # Use the basic Pybatsim scheduler to wrap the Batsim API
+        # Use the basic PyBatsim scheduler to wrap the Batsim API
         self._scheduler = BaseBatsimScheduler(self, options)
 
         self._time = 0
@@ -346,7 +343,7 @@ class Scheduler(metaclass=ABCMeta):
         self._batsim.request_consumed_energy()
 
     def __call__(self):
-        """Return the underlying Pybatsim scheduler."""
+        """Return the underlying PyBatsim scheduler."""
         return self._scheduler
 
     def _format_log_msg(self, msg, **kwargs):

pybatsim-core/src/pybatsim/schedulers/schedEasySjfBackfill.py → pybatsim-functional/src/pybatsim_functional/schedulers/schedEasySjfBackfill.py

@@ -6,9 +6,9 @@
     of the new scheduler api.
 """
 
-from pybatsim.batsim.sched.algorithms.backfilling import backfilling_sched
-from pybatsim.batsim.sched.algorithms.utils import consecutive_resources_filter
-from pybatsim.batsim.sched.scheduler import as_scheduler, adapt_functional_scheduler
+from pybatsim_functional.algorithms.backfilling import backfilling_sched
+from pybatsim_functional.algorithms.utils import consecutive_resources_filter
+from pybatsim_functional.scheduler import as_scheduler, adapt_functional_scheduler
 
 
 def _func_SchedEasySjfBackfill(scheduler):

pybatsim-core/src/pybatsim/schedulers/schedFcfs.py → pybatsim-functional/src/pybatsim_functional/schedulers/schedFcfs.py

@@ -6,9 +6,9 @@
 
 """
 
-from pybatsim.batsim.sched.algorithms.filling import filler_sched
-from pybatsim.batsim.sched.algorithms.utils import consecutive_resources_filter
-from pybatsim.batsim.sched.scheduler import as_scheduler, adapt_functional_scheduler
+from pybatsim_functional.algorithms.filling import filler_sched
+from pybatsim_functional.algorithms.utils import consecutive_resources_filter
+from pybatsim_functional.scheduler import as_scheduler, adapt_functional_scheduler
 
 
 def _func_SchedFcfs(scheduler):

pybatsim-core/src/pybatsim/schedulers/schedFiller.py → pybatsim-functional/src/pybatsim_functional/schedulers/schedFiller.py

@@ -6,9 +6,9 @@
 
 """
 
-from pybatsim.batsim.sched.algorithms.filling import filler_sched
-from pybatsim.batsim.sched.algorithms.utils import consecutive_resources_filter
-from pybatsim.batsim.sched.scheduler import as_scheduler, adapt_functional_scheduler
+from pybatsim_functional.algorithms.filling import filler_sched
+from pybatsim_functional.algorithms.utils import consecutive_resources_filter
+from pybatsim_functional.scheduler import as_scheduler, adapt_functional_scheduler
 
 
 def _func_SchedFiller(scheduler):

pybatsim-core/src/pybatsim/schedulers/schedSendRecv.py → pybatsim-functional/src/pybatsim_functional/schedulers/schedSendRecv.py

@@ -7,9 +7,9 @@
 
 """
 
-from pybatsim.batsim.sched.algorithms.filling import filler_sched
-from pybatsim.batsim.sched.algorithms.utils import consecutive_resources_filter
-from pybatsim.batsim.sched.scheduler import Scheduler, adapt_functional_scheduler
+from pybatsim_functional.algorithms.filling import filler_sched
+from pybatsim_functional.algorithms.utils import consecutive_resources_filter
+from pybatsim_functional.scheduler import Scheduler, adapt_functional_scheduler
 
 
 class _func_SchedSendRecv(Scheduler):