pycsp3-scheduling 0.2.1__py3-none-any.whl

pycsp3_scheduling-0.2.1.dist-info/METADATA

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: pycsp3-scheduling
+Version: 0.2.1
+Summary: Scheduling extension for PyCSP3 with interval variables, sequence variables, and scheduling constraints
+Project-URL: Homepage, https://github.com/sohaibafifi/pycsp3-scheduling
+Project-URL: Repository, https://github.com/sohaibafifi/pycsp3-scheduling
+Project-URL: Issues, https://github.com/sohaibafifi/pycsp3-scheduling/issues
+Author-email: Sohaib AFIFI <sohaib.lafifi@univ-artois.fr>
+License: MIT
+License-File: LICENSE
+Keywords: constraint-programming,interval-variables,job-shop,optimization,pycsp3,rcpsp,scheduling,xcsp3
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: lxml>=4.9
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: pycsp3>=2.5
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == 'docs'
+Requires-Dist: sphinx>=6.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# pycsp3-scheduling
+
+Scheduling extension for [pycsp3](https://pycsp.org) with interval variables, sequence variables, and scheduling constraints.
+
+## Features
+
+- **Interval Variables**: Represent tasks/activities with start, end, size, length, and optional presence
+- **Intensity Functions**: Stepwise intensity metadata with granularity scaling for size/length
+- **Sequence Variables**: Ordered sequences of intervals on disjunctive resources
+- **Precedence Constraints**: `end_before_start`, `start_at_start`, etc.
+- **Grouping Constraints**: `span`, `alternative`, `synchronize`
+- **Cumulative Functions**: `pulse`, `step_at_start`, `step_at_end` for resource modeling
+- **State Functions**: Model resource states with transitions
+- **XCSP3 Extension**: Output scheduling models in extended XCSP3 format
+- **Visualization**: Gantt charts and resource profiles
+
+## Installation
+
+```bash
+pip install pycsp3-scheduling
+```
+
+For development:
+
+```bash
+git clone https://github.com/sohaibafifi/pycsp3-scheduling.git
+cd pycsp3-scheduling
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+from pycsp3 import *
+from pycsp3_scheduling import *
+
+# Create interval variables for tasks
+task1 = IntervalVar(size=10, name="task1")
+task2 = IntervalVar(size=15, name="task2")
+task3 = IntervalVar(size=8, name="task3")
+
+# Precedence: task1 must finish before task2 starts
+satisfy(end_before_start(task1, task2))
+
+# No overlap: task2 and task3 cannot overlap
+satisfy(SeqNoOverlap([task2, task3]))
+
+# Minimize makespan
+minimize(max(end_time(task1), end_time(task2), end_time(task3)))
+```
+
+## Example: Job Shop Scheduling
+
+```python
+from pycsp3 import *
+from pycsp3_scheduling import *
+
+# Data
+n_jobs, n_machines = 3, 3
+durations = [[3, 2, 2], [2, 1, 4], [4, 3, 3]]
+machines = [[0, 1, 2], [0, 2, 1], [1, 0, 2]]
+
+# Create interval variables for each operation
+ops = [[IntervalVar(size=durations[j][o], name=f"op_{j}_{o}")
+        for o in range(n_machines)] for j in range(n_jobs)]
+
+# Sequences for each machine
+sequences = [SequenceVar(
+    intervals=[ops[j][o] for j in range(n_jobs)
+               for o in range(n_machines) if machines[j][o] == m],
+    name=f"machine_{m}"
+) for m in range(n_machines)]
+
+# Precedence within jobs
+satisfy(
+    end_before_start(ops[j][o], ops[j][o+1])
+    for j in range(n_jobs) for o in range(n_machines-1)
+)
+
+# No overlap on machines
+satisfy(SeqNoOverlap(seq) for seq in sequences)
+
+# Minimize makespan
+minimize(Maximum(end_time(ops[j][-1]) for j in range(n_jobs)))
+```
+
+## Example: RCPSP (Resource-Constrained Project Scheduling)
+
+```python
+from pycsp3 import *
+from pycsp3_scheduling import *
+
+# Data
+durations = [3, 2, 5, 4, 2]
+demands = [[2, 1], [1, 2], [3, 0], [2, 1], [1, 3]]
+capacities = [4, 3]
+precedences = [(0, 2), (1, 3), (2, 4)]
+
+# Interval variables
+tasks = [IntervalVar(size=durations[i], name=f"task_{i}")
+         for i in range(len(durations))]
+
+# Precedence constraints
+satisfy(end_before_start(tasks[p], tasks[s]) for p, s in precedences)
+
+# Cumulative resource constraints
+for r in range(len(capacities)):
+    resource = sum(pulse(tasks[i], demands[i][r])
+                   for i in range(len(tasks)) if demands[i][r] > 0)
+    satisfy(resource <= capacities[r])
+
+# Minimize makespan
+minimize(Maximum(end_time(t) for t in tasks))
+```
+
+## API Reference
+
+### Variables
+
+| Function | Description |
+|----------|-------------|
+| `IntervalVar(size, start, end, length, intensity, granularity, optional, name)` | Create an interval variable |
+| `IntervalVarArray(size, ...)` | Create array of interval variables |
+| `SequenceVar(intervals, types, name)` | Create a sequence variable |
+
+### Expressions
+
+| Function | Description |
+|----------|-------------|
+| `start_of(interval, absent_value=0)` | Start time of interval |
+| `end_of(interval, absent_value=0)` | End time of interval |
+| `size_of(interval, absent_value=0)` | Size/duration of interval |
+| `length_of(interval, absent_value=0)` | Length of interval |
+| `presence_of(interval)` | Boolean presence status |
+
+### Interop Helpers
+
+| Function | Description |
+|----------|-------------|
+| `start_time(interval)` | pycsp3 variable for start time |
+| `end_time(interval)` | pycsp3 expression for end time |
+
+### Precedence Constraints
+
+| Constraint | Semantics (when both present) |
+|------------|------------------------------|
+| `start_before_start(a, b, delay)` | `start(b) >= start(a) + delay` |
+| `start_before_end(a, b, delay)` | `end(b) >= start(a) + delay` |
+| `end_before_start(a, b, delay)` | `start(b) >= end(a) + delay` |
+| `end_before_end(a, b, delay)` | `end(b) >= end(a) + delay` |
+| `start_at_start(a, b, delay)` | `start(b) == start(a) + delay` |
+| `start_at_end(a, b, delay)` | `start(b) == end(a) + delay` |
+| `end_at_start(a, b, delay)` | `end(a) == start(b) + delay` |
+| `end_at_end(a, b, delay)` | `end(b) == end(a) + delay` |
+
+### Grouping Constraints
+
+| Constraint | Description |
+|------------|-------------|
+| `span(main, subtasks)` | Main interval spans all present subtasks |
+| `alternative(main, alts, card=1)` | Select `card` alternatives matching main |
+| `synchronize(main, intervals)` | All present intervals sync with main |
+
+### Cumulative Functions
+
+| Function | Description |
+|----------|-------------|
+| `pulse(interval, height)` | Constant consumption during interval |
+| `step_at(time, height)` | Step at fixed time point |
+| `step_at_start(interval, height)` | Step at interval start |
+| `step_at_end(interval, height)` | Step at interval end |
+| `cumul_range(cumul, min, max)` | Constrain cumul to [min, max] |
+
+### State Functions
+
+| Function | Description |
+|----------|-------------|
+| `StateFunction(transition_matrix)` | Create state function |
+| `always_in(func, interval, min, max)` | State in range during interval |
+| `always_equal(func, interval, value)` | State equals value during interval |
+| `always_constant(func, interval)` | State constant during interval |
+
+## Requirements
+
+- Python >= 3.10
+- pycsp3 >= 2.5
+- lxml >= 4.9
+- matplotlib >= 3.7 (optional, for visualization)
+- java >= 8 (optional, for solving with ACE/Choco)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file.
+
+## References
+
+- [PyCSP3 Documentation](https://pycsp.org)
+- [XCSP3 Specification](https://xcsp.org/specifications/)

pycsp3_scheduling-0.2.1.dist-info/RECORD

@@ -0,0 +1,26 @@
+pycsp3_scheduling/__init__.py,sha256=pY6d0BYJ5Xvw7f3MEgg1GLnN51POPZHe_van6Q_lU2M,4645
+pycsp3_scheduling/interop.py,sha256=q8G7olLg692Z9XSFp6C9IbeCwv5pdlUo-DTP97ONAFw,11840
+pycsp3_scheduling/visu.py,sha256=m2IxL-A9jcDxhYT0uYWrBe3HWiZkL4S7ZdjUQb1_auM,39170
+pycsp3_scheduling/constraints/__init__.py,sha256=BYn3OJDygxx1YwrxwLCcICNPdbpUCyFyQJc7RuDvQDA,2106
+pycsp3_scheduling/constraints/_pycsp3.py,sha256=ZvQ7cTljzhuVGnTTTCWbFmdZQVH_S88GYWrVRWsRY4I,23584
+pycsp3_scheduling/constraints/cumulative.py,sha256=dJ9ORKa8mKXpoGQN_lo8eAqJ_7pCYLAQFfbCpEoMYrc,7523
+pycsp3_scheduling/constraints/grouping.py,sha256=Wbh_cKTlHcJN2aCuSp5zgwR-xO2TEbS_5dqFnr1brE8,14645
+pycsp3_scheduling/constraints/precedence.py,sha256=Nd5XbEjYuEN8O-1wI1G5-sYE5CcBLuK6cNOl9kTkEwI,12167
+pycsp3_scheduling/constraints/sequence.py,sha256=IS893C4nknYXrjScRzgcFcX1kGNBuDIBiO-7SbEbnSA,31883
+pycsp3_scheduling/expressions/__init__.py,sha256=HBwOkiyx3huPrbbor3bBZE88wcFV1FUlkJEQD6M2DuA,1691
+pycsp3_scheduling/expressions/element.py,sha256=5SC1VAWJZq3BpaOW-I63gv0JkqdhrZWqOSq4ngrS5U0,10873
+pycsp3_scheduling/expressions/interval_expr.py,sha256=SVRoct3-i9DBizx5LdFDPbVKQEatz901_iDkp7_SFFg,15982
+pycsp3_scheduling/expressions/sequence_expr.py,sha256=8K4aKwd0LmB6zvudlRjnSjJBifFKR5MIJEzSXgl5lhc,28172
+pycsp3_scheduling/functions/__init__.py,sha256=E4SKqRh4PKZqkbn6KoLzxwALBE5azgEXII0GgWkS34Y,3029
+pycsp3_scheduling/functions/cumul_functions.py,sha256=7qgkR65eXOAOQxrIjgVWjFHQtPqCieugD0jNVl8K2G8,32100
+pycsp3_scheduling/functions/state_functions.py,sha256=1lDELvuF-FH6MlL5A-q71__RXj7CFevM0AXjLnEqJcY,17086
+pycsp3_scheduling/output/__init__.py,sha256=F7JbwGeEEhSvSCACVUgYaLxhf8uRaP4YpUD6g_5v4Ww,283
+pycsp3_scheduling/solvers/__init__.py,sha256=pVe3yy05OurQnfOD9KrdFWQEBp6mpfJFTW2fuBUScPk,325
+pycsp3_scheduling/solvers/adapters/__init__.py,sha256=AZ6vFqq6acQ0zOGuyS5cyoXpKoKuHDepkdxs0BjoTqM,95
+pycsp3_scheduling/variables/__init__.py,sha256=A6lCnArwiY9r8n2setrwFKUan-NkWM6wXQSvMzVG8fc,1046
+pycsp3_scheduling/variables/interval.py,sha256=2V1spB2VXUUscxYnzYffY0-FDoME2YxpVqDZ6C0EFcQ,16454
+pycsp3_scheduling/variables/sequence.py,sha256=0vgptgt1QFBa1BiQEaYvKTEcj2UIm0A7pNRVGHyY-a8,8352
+pycsp3_scheduling-0.2.1.dist-info/METADATA,sha256=Wr4C98rGdEGv_PvZIUEVtTXoFAThR7SEaQp6CZWy-Q0,7856
+pycsp3_scheduling-0.2.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+pycsp3_scheduling-0.2.1.dist-info/licenses/LICENSE,sha256=k49NebQVmSdOr9Ot0_VWG8MZ0ruM19qhV2rHFBGUYbk,1069
+pycsp3_scheduling-0.2.1.dist-info/RECORD,,

pycsp3_scheduling-0.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pycsp3_scheduling-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Univ. Artois
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.