pycsp3-scheduling 0.2.0__tar.gz

pycsp3_scheduling-0.2.0/.github/workflows/docs.yml

@@ -0,0 +1,60 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    paths:
+      - 'docs/**'
+      - 'pycsp3_scheduling/**'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+          pip install -r docs/requirements.txt
+
+      - name: Build Sphinx documentation
+        run: |
+          cd docs
+          make html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pycsp3_scheduling-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build-and-publish:
+    environment:
+      name: pypi
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - run: python -m pip install --upgrade pip build
+      - run: python -m build
+      - uses: pypa/gh-action-pypi-publish@release/v1

pycsp3_scheduling-0.2.0/.gitignore

@@ -0,0 +1,104 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# XCSP3 output files
+*.xml
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+*.log

pycsp3_scheduling-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,103 @@
+# Contributing to pycsp3-scheduling
+
+Thank you for your interest in contributing to pycsp3-scheduling!
+
+## Development Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/sohaibafifi/pycsp3-scheduling.git
+   cd pycsp3-scheduling
+   ```
+
+2. Create a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   ```
+
+3. Install development dependencies:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+## Code Style
+
+This project uses:
+- **ruff** for linting and formatting
+- **mypy** for type checking
+
+Run checks before committing:
+
+```bash
+# Linting
+ruff check .
+
+# Formatting
+ruff format .
+
+# Type checking
+mypy pycsp3_scheduling
+```
+
+## Testing
+
+Run tests with pytest:
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=pycsp3_scheduling --cov-report=html
+```
+
+## Project Structure
+
+```
+pycsp3_scheduling/
+├── variables/       # IntervalVar, SequenceVar
+├── expressions/     # start_of, end_of, etc.
+├── constraints/     # Precedence, grouping, sequence constraints
+├── functions/       # CumulFunction, StateFunction
+├── output/          # XCSP3 output generator
+└── solvers/         # Solver adapters
+```
+
+## Adding New Features
+
+### Adding a New Constraint
+
+1. Create or update the appropriate module in `constraints/`
+2. Follow the existing constraint class pattern
+3. Add exports to `constraints/__init__.py`
+4. Add exports to main `__init__.py`
+5. Write unit tests in `tests/`
+6. Update documentation
+
+### Adding a New Variable Type
+
+1. Create the variable class in `variables/`
+2. Implement required methods for pycsp3 integration
+3. Add XCSP3 output support in `output/`
+4. Write comprehensive tests
+
+## Pull Request Process
+
+1. Create a feature branch from `master`
+2. Make your changes with clear commit messages
+3. Ensure all tests pass
+4. Update documentation if needed
+5. Submit a pull request with a description of changes
+
+## Reporting Issues
+
+When reporting issues, please include:
+- Python version
+- pycsp3-scheduling version
+- Minimal reproducible example
+- Expected vs actual behavior
+
+## Questions
+
+For questions about the project, open a GitHub issue or discussion.

pycsp3_scheduling-0.2.0/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.

pycsp3_scheduling-0.2.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: pycsp3-scheduling
+Version: 0.2.0
+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/)