Metadata-Version: 2.1
Name: ProcessScheduler
Version: 0.6.1
Summary: A package to solve resource-constrained scheduling problems using SAT/SMT.
Home-page: https://github.com/tpaviot/ProcessScheduler
Author: Thomas Paviot
Author-email: tpaviot@gmail.com
License: GPLv3
Description: [![Codacy Badge](https://app.codacy.com/project/badge/Grade/7221205f866145bfa4f18c08bd96e71f)](https://www.codacy.com/gh/tpaviot/ProcessScheduler/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tpaviot/ProcessScheduler&amp;utm_campaign=Badge_Grade)
        [![codecov](https://codecov.io/gh/tpaviot/ProcessScheduler/branch/master/graph/badge.svg?token=9HI1FPJUDL)](https://codecov.io/gh/tpaviot/ProcessScheduler)
        [![Azure Build Status](https://dev.azure.com/tpaviot/ProcessScheduler/_apis/build/status/tpaviot.ProcessScheduler?branchName=master)](https://dev.azure.com/tpaviot/ProcessScheduler/_build?definitionId=9)
        [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tpaviot/ProcessScheduler/HEAD?filepath=examples-notebooks)
        [![Documentation Status](https://readthedocs.org/projects/processscheduler/badge/?version=latest)](https://processscheduler.readthedocs.io/en/latest/?badge=latest)
        [![PyPI version](https://badge.fury.io/py/ProcessScheduler.svg)](https://badge.fury.io/py/ProcessScheduler)
        [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4480745.svg)](https://doi.org/10.5281/zenodo.4480745)
        
        # ProcessScheduler
        A python library to compute resource-constrained task schedules.
        
        The computation is based on a set of constraints expressed under the form of first-order logic assertions. Problem solving is performed by the SAT/SMT [Z3 Theorem Prover](https://github.com/Z3Prover/z3).
        
        ## Documentation
        
        User-end documentation available at https://processscheduler.readthedocs.io/
        
        ## Slack
        
        Join the [ProcesScheduler slack workspace](https://join.slack.com/t/processscheduler/shared_invite/zt-pa152rki-126YyMsuLNxhOv_suqKtkQ) for any question/suggestion/discussion.
        
        ## Features
        
        *   tasks: zero duration task, fixed duration task, variable duration task, work amount, optional task,
        *   resources: worker, cumulative workers, workers selection, cost_per_period and productivity attributes,
        *   task constraints: precedence, start synced, end synced, start at, end at, start after, end before,
        *   optional tasks and task constraints: task schedule condition, tasks schedule dependencies,
        *   resource and optional resource constraints: AllSameSelected, AllDifferentSelected,
        *   first-order-logic operations (not, or, xor, and, implies, if/then/else) between task or resource constraints,
        *   builtin and customized indicators (resource utilization, resource cost),
        *   single and multiobjective optimization (makespan, flowtime, earliest, latest, resource cost, etc.),
        *   exporters: smtlib2.0, json
        *   Gantt chart rendering using matplotlib or plotly
        
        ## Install
        
        Install with pip.
        
        ```bash
        pip install ProcessScheduler
        ```
        
        The Z3 theorem prover is the only required dependency.
        
        Optional dependencies (install either with pip or conda):
        
        *   matplotlib (Gantt chart rendering),
        *   plotly (Gantt chart rendering).
        
        ## Try online
        
        There are some [Jupypter notebooks](https://github.com/tpaviot/ProcessScheduler/tree/master/example-notebooks). They can be executed online at [myBinder.org](https://mybinder.org/v2/gh/tpaviot/ProcessScheduler/HEAD?filepath=example-notebooks)
        
        ## Helloworld
        
        ```python
        import processscheduler as ps
        # a simple problem, without horizon (solver will find it)
        pb = ps.SchedulingProblem('HelloWorldProcessScheduler')
        
        # add two tasks
        task_hello = ps.FixedDurationTask('Process', duration=2)
        task_world = ps.FixedDurationTask('Scheduler', duration=2)
        
        # precedence constraint: task_world must be scheduled
        # after task_hello
        c1 = ps.TaskPrecedence(task_hello, task_world, offset=0)
        pb.add_constraint(c1) # explicitly add this constraint to the problem
        
        # solve
        solver = ps.SchedulingSolver(pb)
        solution = solver.solve()
        
        # displays solution, ascii or matplotlib gantt diagram
        solution.render_gantt_matplotlib()
        ```
        
        ![png](examples-notebooks/pics/hello_world_gantt.svg)
        
        ## Code quality
        
        ProcessScheduler uses the following tools to ensure code quality:
        
        *   unittests,
        *   code coverage (coverage.py, codecov.io),
        *   continuous-integration at MS azure,
        *   static code analysis (codacy),
        *   spelling mistakes tracking (codespell)
        
        ## License/Author
        
        ProcessScheduler is distributed under the terms of the GNU General Public License v3 or (at your option) any later version. It is currently developed and maintained by Thomas Paviot (tpaviot@gmail.com).
        
Platform: Platform Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Healthcare Industry
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Office/Business :: Scheduling
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
