misc

11 files changed, 235 insertions, 7 deletions

diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
new file mode 100644
index 0000000..b5263f2
--- /dev/null
+++ b/.devcontainer/Dockerfile
@@ -0,0 +1,33 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.11-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+RUN pip3 --disable-pip-version-check --no-cache-dir install -U pip pre-commit 
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+COPY .devcontainer/requirements.txt /tmp/pip-tmp/
+RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+   && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+
+COPY .devcontainer/act4e-check /usr/local/bin
+RUN chmod +x /usr/local/bin/act4e-check
+
+
+# COPY src src
+# COPY setup.py .
+
+# RUN python3 -m pip install -e .
+
diff --git a/.devcontainer/act4e-check b/.devcontainer/act4e-check
new file mode 100644
index 0000000..d4fd9e7
--- /dev/null
+++ b/.devcontainer/act4e-check
@@ -0,0 +1,16 @@
+#!/bin/bash
+set -eux 
+if [ $# -eq 0 ]
+  then
+    act4e-test --collections act4e_checks --module act4e_solutions
+else
+if [ $# -eq 1 ]
+  then
+    act4e-test --collections act4e_checks --module act4e_solutions --group $1
+else
+    echo "Need to pass either 0 or 1 argument"
+    exit 3
+fi
+fi
+
+
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
new file mode 100644
index 0000000..67b76f6
--- /dev/null
+++ b/.devcontainer/devcontainer.json
@@ -0,0 +1,53 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.209.6/containers/python-3
+{
+	"name": "Python 3",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"context": "..",
+		"args": { 
+			// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3.11-bullseye",
+			// Options
+			"NODE_VERSION": "none"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": { 
+		"python.defaultInterpreterPath": "/usr/local/bin/python",
+		"python.linting.enabled": true,
+		"python.linting.pylintEnabled": true,
+		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
+	},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"ms-python.python",
+		"tht13.html-preview-vscode",
+		// "ms-python.vscode-pylance"
+	],
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode",
+	"features": {
+		"git": "os-provided",
+		"git-lfs": "latest"
+	}
+}
diff --git a/.devcontainer/requirements.txt b/.devcontainer/requirements.txt
new file mode 100644
index 0000000..f3b44a2
--- /dev/null
+++ b/.devcontainer/requirements.txt
@@ -0,0 +1,2 @@
+ACT4E-mcdp
+pre-commit
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..9a5bb0b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+__pycache__
+*.pyc
+*.egg-info
+.DS_Store
+.python-version
+.vscode/*log
+.out-results/*html
\ No newline at end of file
diff --git a/.pylintrc b/.pylintrc
deleted file mode 100644
index d13ca13..0000000
--- a/.pylintrc
+++ /dev/null
@@ -1,7 +0,0 @@
-[MASTER]
-disable=
-    C0114, # missing-module-docstring
-    C0115, # missing-class-docstring
-    C0116, # missing-function-docstring
-    C0103, # pylint complains about the TypeVar names https://github.com/PyCQA/pylint/issues/3324
-    R0903, # too few public methods
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..69bd087
--- /dev/null
+++ b/README.md
@@ -0,0 +1,73 @@
+## Setup
+
+### Install Docker
+
+<ul>
+    <li> (Mac, Linux) Follow the [installation instructions](https://docs.docker.com/get-docker/) </li>
+    <li>(Windows):
+        <ul>
+         <li>Follow the manual installation steps for Windows Subsystem for Linux [here](https://docs.microsoft.com/en-us/windows/wsl/install). On step 1, follow the recommendation of updating to WSL 2. You do not necessarily need to install Windows Terminal. </li>
+            <li>Now go [here](https://docs.docker.com/desktop/windows/install/) and follow the "Install Docker Desktop on Windows" instructions. You can then start Docker Desktop and follow the quick start quide.</li>
+        </ul>
+    </li>
+</ul>
+
+### Install VS Code.
+
+Select File -> Open and select *the entire folder*.
+
+VS Code will propose to install "Dev Container". Click "install".
+
+VS Code will give you a message similar to:
+
+> Folder contains a Dev Container configuration file. Reopen folder to develop in a container.
+
+Select "Reopen in container".
+
+Now you should have the folder open while VS Code is in "container development mode".
+
+You can create a new terminal using Terminal -> New Terminal.
+
+## Running tests
+
+Install this package and dependencies using:
+
+    pip install -e .
+
+The main dependency installed is `ACT4E-mcdp` which is also available [on this repo](https://github.com/ACT4E/ACT4E-mcdp).
+That library takes care of parsing the models and queries.
+
+If we tell you to update the library, use this:
+
+    pip install -U ACT4E-mcdp
+
+Use this command to download the test cases:
+
+    act4e-mcdp-download-tests --out downloaded
+
+Then you have available a few test cases in the directory `downloaded/`.
+
+You should be able to run this solver:
+
+    act4e-mcdp-solve \
+        --solver act4e_mcdp_solution.MySolution \
+        --query FixFunMinRes \
+        --model downloaded/lib1-parts.e03_splitter1.models.mcdpr1.yaml \
+        --data '{f: 10}'
+
+In turn:
+
+* `--solver act4e_mcdp_solution.MySolution`: this selects your solver;
+* `--query FixFunMinRes`: this selects `FixFunMinRes` (other choice: `FixResMaxFun`);
+* `--model downloaded/lib1-parts.e03_splitter1.models.mcdpr1.yaml`: this selects the model to use for optimization;
+* `--data '{f: 10}'`: this selects the query to give. It is a YAML dictionary with a key for each functionality name.
+
+You will see the result in the logs:
+
+```
+INFO query: {'f': Decimal('10')}
+INFO solution: UpperSet(minima=[])
+```
+
+The template `act4e_mcdp_solution.MySolution` always returns an empty `UpperSet` (= infeasible).
+At this point, you can start implementing your solver.
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..e70d7c5
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,28 @@
+[project]
+name = "ACT4E-mcdp-MySolution"
+version = "0.1"
+authors = [{ name = "My Name", email = "invalid@invalid.com" }]
+dependencies = [
+    "ACT4E-mcdp",
+]
+
+[tool]
+[tool.poetry]
+name = "ACT4E-mcdp-MySolution"
+version = "0.1"
+description = ""
+authors = ["My Name <invalid@invalid.com>"]
+packages = [
+    { from = "src", include = "act4e_mcdp_solution" },
+]
+[tool.poetry.dependencies]
+python = "^3.10"
+[tool.setuptools]
+packages = [
+    "act4e_mcdp_solution",
+]
+package-dir = { "" = "src" }
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
diff --git a/src/act4e_mcdp_solution/__init__.py b/src/act4e_mcdp_solution/__init__.py
new file mode 100644
index 0000000..c3fe37e
--- /dev/null
+++ b/src/act4e_mcdp_solution/__init__.py
@@ -0,0 +1,10 @@
+import coloredlogs
+
+coloredlogs.install(level="DEBUG")
+
+import logging
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+from .solution import *
diff --git a/src/act4e_mcdp_solution/py.typed b/src/act4e_mcdp_solution/py.typed
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/src/act4e_mcdp_solution/py.typed
diff --git a/src/act4e_mcdp_solution/solution.py b/src/act4e_mcdp_solution/solution.py
new file mode 100644
index 0000000..0a207d0
--- /dev/null
+++ b/src/act4e_mcdp_solution/solution.py
@@ -0,0 +1,13 @@
+from typing import Any, Mapping
+
+from act4e_mcdp import NamedDP, SolverInterface, UpperSet, LowerSet
+
+__all__ = ["MySolution"]
+
+
+class MySolution(SolverInterface):
+    def solve_FixFunMinRes(self, model: NamedDP, query: Mapping[str, Any]) -> UpperSet[Mapping[str, Any]]:
+        return UpperSet([])
+
+    def solve_FixResMaxFun(self, model: NamedDP, query: Mapping[str, Any]) -> LowerSet[Mapping[str, Any]]:
+        return LowerSet([])