scipplan 0.1.0a0__tar.gz

scipplan-0.1.0a0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Ari Gestetner
+
+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.

scipplan-0.1.0a0/MANIFEST.in

@@ -0,0 +1 @@
+include translation/*.txt

scipplan-0.1.0a0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.1
+Name: scipplan
+Version: 0.1.0a0
+Summary: Metric Hybrid Factored Planning in Nonlinear Domains with Constraint Generation in Python.
+Author: Ari Gestetner, Buser Say
+Author-email: ages0001@student.monash.edu, buser.say@monash.edu
+License: MIT License
+Keywords: scip,automated planner
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# SCIPPlan
+
+SCIPPlan [1,2,3] is a SCIP-based [4] hybrid planner for domains with i) mixed (i.e., real and/or discrete valued) state and action spaces, ii) nonlinear state transitions that are functions of time, and iii) general reward functions. SCIPPlan iteratively i) finds violated constraints (i.e., zero-crossings) by simulating the state transitions, and ii) adds the violated (symbolic) constraints back to its underlying optimisation model, until a valid plan is found.
+
+## Example Domain: Navigation
+
+<img src=./visualisation/scipplan_navigation_1.gif width="32%" height="32%"> <img src=./visualisation/scipplan_navigation_2.gif width="32%" height="32%"> <img src=./visualisation/scipplan_navigation_3.gif width="32%" height="32%">
+
+
+Figure 1: Visualisation of different plans generated by SCIPPlan [1,2,3] for example navigation domains where the red square represents the agent, the blue shapes represent the obstacles, the gold star represents the goal location and the delta represents time. The agent can control its acceleration and the duration of its control input to modify its speed and location in order to navigate in a two-dimensional maze. The purpose of the domain is to find a path for the agent with minimum makespan such that the agent reaches its the goal without colliding with the obstacles. 
+
+Note that SCIPPlan does not linearise or discretise the domain to find a valid plan.
+
+## Dependencies
+
+i) Solver: SCIP (the current implementation uses the python interface to the SCIP solver, i.e., PySCIPOpt [5]). This version of SCIPPlan has only been tested on PySCIOpt>=4.0.0 using earlier an version of pyscipopt may result in unintended behaviour. 
+
+## Installing and Running SCIPPlan
+In order to Install SCIPPlan you need to ensure you have a working version of the SCIP optimisation suite on your system which can be installed from [the SCIP website](https://www.scipopt.org). For more information about SCIP and PySCIPOpt refer to this [installation guide](https://github.com/scipopt/PySCIPOpt/blob/master/INSTALL.md).
+
+After installing SCIP you will be able to install SCIPPlan using
+```bash
+pip install scipplan
+```
+Now you will be able to run some of the example domains which include 
+- Navigation (3 instances)
+
+To run one of these examples all you need to do is run
+```bash
+scipplan -D navigation -I 1
+```
+which will run the 1st instance of the navigation domain. For more information regarding the available tags and what they mean run `scipplan --help`.
+
+Alternatively you can import scipplan classes to run it using python.
+```py
+from scipplan.scipplan import SCIPPlan
+from scipplan.config import Config
+from scipplan.helpers import write_to_csv
+```
+this will import the only 2 classes and function needed to run SCIPPlan. Then to set the configuration either create an instance of the Config class by setting the params or by retrieving the cli input
+```py
+# Set params
+config = Config(domain="navigation", instance=1)
+# Retrieve cli args
+config = Config.get_config()
+```
+after which you are able to solve problem by either using the solve or optimize methods
+```py
+# The optimize method just optimises the problem for the given horizon
+plan = SCIPPlan(config)
+plan.optimize()
+# Class method which takes input the config, solves the problem 
+# with auto incrementing the horizon until a solution is found then 
+# returns the plan as well as the time taken to solve the problem
+plan, solve_time = SCIPPlan.solve(config)  
+```
+In order to save the generated constraints for the horizon solved as well as the results, use the following code
+```py
+write_to_csv("new_constraints", plan.new_constraints, config)
+write_to_csv("results", plan.results_table, config)
+```
+
+
+
+## Custom Domains
+If you would like to create your own domain you will need to create a directory named "translation" in the directory which scipplan is run from with txt files of the format "{translation type}\_{domain name}\_{instance number}.txt" (e.g. "pvariables_navigation_1.txt"). Note that the files in the translation directory will override any example files if they share domain name and instance number (e.g. navigation 1 would override the example).
+
+For each domain instance the following translation files are required
+- constants
+- pvariables
+- initials
+- goals
+- instantaneous_constraints
+- temporal_constraints
+- transitions
+- reward
+
+As a part of SCIPPlan, all the constraint files allow for the use of "and" and "or" expressions, polynomials and `exp`, `log`, `sqrt`, `sin` and `cos` functions (Note: `sin` and `cos` are only available in PySCIPOpt>=4.3.0 so if your version is below that you will not be able to use the trig functions unless you update).
+
+### Constants
+The constants file allows for constant values to be defined as a variable to be used in other files in the model. To use add constants as follows
+```txt
+HalfVal = 0.5
+Epsilon = config_epsilon
+bigM = config_bigM
+```  
+
+Some config values can be accessed in the constants file to be used in other files and are available as 
+- `config_epsilon`
+- `config_gap`
+- `config_bigM`  
+Note that these variables are only accessible in the constants file and you will need to define a new constants variable to store the value 
+
+### Pvariables
+When creating the pvariables file, the variables should be listed in the following format
+```txt
+action_continuous: Accelerate_x
+action_continuous: Accelerate_y
+action_continuous: Dt
+action_boolean: Mode
+state_continuous: Location_x
+state_continuous: Location_y
+state_continuous: Speed_x
+state_continuous: Speed_y
+```
+where the variable and value type of the variable is set in the format "{variable type}_{value type}" and the variable itself has to be in a Python compatible format (e.g. variables can't use - sign like `some-var` but can use _ like `some_var` as well as the dash sign ' cannot be used). The use of next state variables which is often written using the dash symbol will be explained further in the Transitions section.  
+Additionally a variable for Dt has to be defined and has to be the same as the dt_var in the config object so if you would like to use a different variable name for Dt (e.g. dt) please also ensure you add it to the config via the `--dt-var` tag or the `dt_var` parameter.  
+The available variable types are
+- state
+- action
+- auxiliary
+
+The available value types are 
+- continuos
+- integer 
+- boolean 
+
+Please note that constants don't need to have their variable names defined in pvariables as they are defined in constants.
+
+### Initials
+The initials file defines the initial state values for time t=0, for example
+```txt
+Location_x == 0.0
+Location_y == 0.0
+Speed_x == 0.0
+Speed_y == 0.0
+```
+notice te use of teh constant value defined earlier in the constants file.
+### Goals
+The goals file should encode the final state values such that t=H+1, for example
+```txt
+Location_x == 8.0
+Location_y == 8.0
+```
+### Instantaneous Constraints
+This is where the instantaneous constraints go.
+An example is as follows
+```txt
+Location_x <= 10.0
+Location_y <= 10.0
+Location_x >= 0.0
+Location_y >= 0.0
+Accelerate_x <= 0.5
+Accelerate_y <= 0.5
+Accelerate_x >= -0.5
+Accelerate_y >= -0.5
+(Location_x <= 4.0) or (Location_x >= 6.0) or (Location_y <= 4.0) or (Location_y >= 6.0)
+```
+### Temporal Constraints
+The temporal constraints are the constraints which SCIPPlan will ensure that the solution never violates by iterating through every epsilon value of Dt and checking for zero crossings. An example of a temporal constraint is as follows
+```txt
+Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 10.0
+Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 10.0
+Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 0.0
+Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 0.0
+
+((Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 4.0) or 
+(Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 6.0) or 
+(Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 4.0) or 
+(Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 6.0))
+```
+
+The use of mode switches are used in these constraints (`Dt + Epsilon*Mode`). Please note that the or expression is enclosed in round brackets which allows the constraints to be parsed as a singular expression
+### Transitions
+Transitions are to be added here with the following syntax.  
+For example $S_{t+1} = \frac 12 A_t\cdot t^2 + V_t\cdot t + S_t$.  
+Alternatively this can be written as $S' = \frac 12 A\cdot t^2 + V\cdot t + S$.
+Since Python doesn't allow variables to use the ' symbol it should be replaced with `_dash`, for example
+```txt
+Location_x_dash - 1.0*Location_x - 1.0*Speed_x*(Dt + Epsilon*Mode) - 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) == 0.0
+Location_y_dash - 1.0*Location_y - 1.0*Speed_y*(Dt + Epsilon*Mode) - 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) == 0.0
+Speed_x_dash - 1.0*Speed_x - 1.0*Accelerate_x*(Dt + Epsilon*Mode) == 0.0
+Speed_y_dash - 1.0*Speed_y - 1.0*Accelerate_y*(Dt + Epsilon*Mode) == 0.0
+```
+
+### Reward
+As for the reward function, SCIPPlan maximises the reward thus if using a cost function it should be negated as per the example
+```txt
+-1.0*(Dt + Mode * Epsilon)
+```
+Only one reward function is able to be optimised for in SCIPPlan
+
+## Citation
+
+If you are using SCIPPlan, please cite the papers [1,2,3] and the underlying SCIP solver [4].
+
+## References
+[1] Buser Say and Scott Sanner. [Metric Nonlinear Hybrid Planning with Constraint Generation](http://icaps18.icaps-conference.org/fileadmin/alg/conferences/icaps18/workshops/workshop06/docs/proceedings.pdf#page=23). In PlanSOpt, pages 19-25, 2018.
+
+[2] Buser Say and Scott Sanner. [Metric Hybrid Factored Planning in Nonlinear Domains with Constraint Generation](https://link.springer.com/chapter/10.1007/978-3-030-19212-9_33). In CPAIOR, pages 502-518, 2019.
+
+[3] Buser Say. [Robust Metric Hybrid Planning in Stochastic Nonlinear Domains Using Mathematical Optimization](https://ojs.aaai.org/index.php/ICAPS/article/view/27216). In ICAPS, pages 375-383, 2023.
+
+[4] [SCIP](https://www.scipopt.org/)
+
+[5] [PySCIPOpt](https://github.com/SCIP-Interfaces/PySCIPOpt)

scipplan-0.1.0a0/README.md

@@ -0,0 +1,196 @@
+# SCIPPlan
+
+SCIPPlan [1,2,3] is a SCIP-based [4] hybrid planner for domains with i) mixed (i.e., real and/or discrete valued) state and action spaces, ii) nonlinear state transitions that are functions of time, and iii) general reward functions. SCIPPlan iteratively i) finds violated constraints (i.e., zero-crossings) by simulating the state transitions, and ii) adds the violated (symbolic) constraints back to its underlying optimisation model, until a valid plan is found.
+
+## Example Domain: Navigation
+
+<img src=./visualisation/scipplan_navigation_1.gif width="32%" height="32%"> <img src=./visualisation/scipplan_navigation_2.gif width="32%" height="32%"> <img src=./visualisation/scipplan_navigation_3.gif width="32%" height="32%">
+
+
+Figure 1: Visualisation of different plans generated by SCIPPlan [1,2,3] for example navigation domains where the red square represents the agent, the blue shapes represent the obstacles, the gold star represents the goal location and the delta represents time. The agent can control its acceleration and the duration of its control input to modify its speed and location in order to navigate in a two-dimensional maze. The purpose of the domain is to find a path for the agent with minimum makespan such that the agent reaches its the goal without colliding with the obstacles. 
+
+Note that SCIPPlan does not linearise or discretise the domain to find a valid plan.
+
+## Dependencies
+
+i) Solver: SCIP (the current implementation uses the python interface to the SCIP solver, i.e., PySCIPOpt [5]). This version of SCIPPlan has only been tested on PySCIOpt>=4.0.0 using earlier an version of pyscipopt may result in unintended behaviour. 
+
+## Installing and Running SCIPPlan
+In order to Install SCIPPlan you need to ensure you have a working version of the SCIP optimisation suite on your system which can be installed from [the SCIP website](https://www.scipopt.org). For more information about SCIP and PySCIPOpt refer to this [installation guide](https://github.com/scipopt/PySCIPOpt/blob/master/INSTALL.md).
+
+After installing SCIP you will be able to install SCIPPlan using
+```bash
+pip install scipplan
+```
+Now you will be able to run some of the example domains which include 
+- Navigation (3 instances)
+
+To run one of these examples all you need to do is run
+```bash
+scipplan -D navigation -I 1
+```
+which will run the 1st instance of the navigation domain. For more information regarding the available tags and what they mean run `scipplan --help`.
+
+Alternatively you can import scipplan classes to run it using python.
+```py
+from scipplan.scipplan import SCIPPlan
+from scipplan.config import Config
+from scipplan.helpers import write_to_csv
+```
+this will import the only 2 classes and function needed to run SCIPPlan. Then to set the configuration either create an instance of the Config class by setting the params or by retrieving the cli input
+```py
+# Set params
+config = Config(domain="navigation", instance=1)
+# Retrieve cli args
+config = Config.get_config()
+```
+after which you are able to solve problem by either using the solve or optimize methods
+```py
+# The optimize method just optimises the problem for the given horizon
+plan = SCIPPlan(config)
+plan.optimize()
+# Class method which takes input the config, solves the problem 
+# with auto incrementing the horizon until a solution is found then 
+# returns the plan as well as the time taken to solve the problem
+plan, solve_time = SCIPPlan.solve(config)  
+```
+In order to save the generated constraints for the horizon solved as well as the results, use the following code
+```py
+write_to_csv("new_constraints", plan.new_constraints, config)
+write_to_csv("results", plan.results_table, config)
+```
+
+
+
+## Custom Domains
+If you would like to create your own domain you will need to create a directory named "translation" in the directory which scipplan is run from with txt files of the format "{translation type}\_{domain name}\_{instance number}.txt" (e.g. "pvariables_navigation_1.txt"). Note that the files in the translation directory will override any example files if they share domain name and instance number (e.g. navigation 1 would override the example).
+
+For each domain instance the following translation files are required
+- constants
+- pvariables
+- initials
+- goals
+- instantaneous_constraints
+- temporal_constraints
+- transitions
+- reward
+
+As a part of SCIPPlan, all the constraint files allow for the use of "and" and "or" expressions, polynomials and `exp`, `log`, `sqrt`, `sin` and `cos` functions (Note: `sin` and `cos` are only available in PySCIPOpt>=4.3.0 so if your version is below that you will not be able to use the trig functions unless you update).
+
+### Constants
+The constants file allows for constant values to be defined as a variable to be used in other files in the model. To use add constants as follows
+```txt
+HalfVal = 0.5
+Epsilon = config_epsilon
+bigM = config_bigM
+```  
+
+Some config values can be accessed in the constants file to be used in other files and are available as 
+- `config_epsilon`
+- `config_gap`
+- `config_bigM`  
+Note that these variables are only accessible in the constants file and you will need to define a new constants variable to store the value 
+
+### Pvariables
+When creating the pvariables file, the variables should be listed in the following format
+```txt
+action_continuous: Accelerate_x
+action_continuous: Accelerate_y
+action_continuous: Dt
+action_boolean: Mode
+state_continuous: Location_x
+state_continuous: Location_y
+state_continuous: Speed_x
+state_continuous: Speed_y
+```
+where the variable and value type of the variable is set in the format "{variable type}_{value type}" and the variable itself has to be in a Python compatible format (e.g. variables can't use - sign like `some-var` but can use _ like `some_var` as well as the dash sign ' cannot be used). The use of next state variables which is often written using the dash symbol will be explained further in the Transitions section.  
+Additionally a variable for Dt has to be defined and has to be the same as the dt_var in the config object so if you would like to use a different variable name for Dt (e.g. dt) please also ensure you add it to the config via the `--dt-var` tag or the `dt_var` parameter.  
+The available variable types are
+- state
+- action
+- auxiliary
+
+The available value types are 
+- continuos
+- integer 
+- boolean 
+
+Please note that constants don't need to have their variable names defined in pvariables as they are defined in constants.
+
+### Initials
+The initials file defines the initial state values for time t=0, for example
+```txt
+Location_x == 0.0
+Location_y == 0.0
+Speed_x == 0.0
+Speed_y == 0.0
+```
+notice te use of teh constant value defined earlier in the constants file.
+### Goals
+The goals file should encode the final state values such that t=H+1, for example
+```txt
+Location_x == 8.0
+Location_y == 8.0
+```
+### Instantaneous Constraints
+This is where the instantaneous constraints go.
+An example is as follows
+```txt
+Location_x <= 10.0
+Location_y <= 10.0
+Location_x >= 0.0
+Location_y >= 0.0
+Accelerate_x <= 0.5
+Accelerate_y <= 0.5
+Accelerate_x >= -0.5
+Accelerate_y >= -0.5
+(Location_x <= 4.0) or (Location_x >= 6.0) or (Location_y <= 4.0) or (Location_y >= 6.0)
+```
+### Temporal Constraints
+The temporal constraints are the constraints which SCIPPlan will ensure that the solution never violates by iterating through every epsilon value of Dt and checking for zero crossings. An example of a temporal constraint is as follows
+```txt
+Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 10.0
+Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 10.0
+Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 0.0
+Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 0.0
+
+((Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 4.0) or 
+(Location_x + Speed_x*(Dt + Epsilon*Mode) + 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 6.0) or 
+(Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) <= 4.0) or 
+(Location_y + Speed_y*(Dt + Epsilon*Mode) + 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) >= 6.0))
+```
+
+The use of mode switches are used in these constraints (`Dt + Epsilon*Mode`). Please note that the or expression is enclosed in round brackets which allows the constraints to be parsed as a singular expression
+### Transitions
+Transitions are to be added here with the following syntax.  
+For example $S_{t+1} = \frac 12 A_t\cdot t^2 + V_t\cdot t + S_t$.  
+Alternatively this can be written as $S' = \frac 12 A\cdot t^2 + V\cdot t + S$.
+Since Python doesn't allow variables to use the ' symbol it should be replaced with `_dash`, for example
+```txt
+Location_x_dash - 1.0*Location_x - 1.0*Speed_x*(Dt + Epsilon*Mode) - 0.5*Accelerate_x*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) == 0.0
+Location_y_dash - 1.0*Location_y - 1.0*Speed_y*(Dt + Epsilon*Mode) - 0.5*Accelerate_y*(Dt + Epsilon*Mode)*(Dt + Epsilon*Mode) == 0.0
+Speed_x_dash - 1.0*Speed_x - 1.0*Accelerate_x*(Dt + Epsilon*Mode) == 0.0
+Speed_y_dash - 1.0*Speed_y - 1.0*Accelerate_y*(Dt + Epsilon*Mode) == 0.0
+```
+
+### Reward
+As for the reward function, SCIPPlan maximises the reward thus if using a cost function it should be negated as per the example
+```txt
+-1.0*(Dt + Mode * Epsilon)
+```
+Only one reward function is able to be optimised for in SCIPPlan
+
+## Citation
+
+If you are using SCIPPlan, please cite the papers [1,2,3] and the underlying SCIP solver [4].
+
+## References
+[1] Buser Say and Scott Sanner. [Metric Nonlinear Hybrid Planning with Constraint Generation](http://icaps18.icaps-conference.org/fileadmin/alg/conferences/icaps18/workshops/workshop06/docs/proceedings.pdf#page=23). In PlanSOpt, pages 19-25, 2018.
+
+[2] Buser Say and Scott Sanner. [Metric Hybrid Factored Planning in Nonlinear Domains with Constraint Generation](https://link.springer.com/chapter/10.1007/978-3-030-19212-9_33). In CPAIOR, pages 502-518, 2019.
+
+[3] Buser Say. [Robust Metric Hybrid Planning in Stochastic Nonlinear Domains Using Mathematical Optimization](https://ojs.aaai.org/index.php/ICAPS/article/view/27216). In ICAPS, pages 375-383, 2023.
+
+[4] [SCIP](https://www.scipopt.org/)
+
+[5] [PySCIPOpt](https://github.com/SCIP-Interfaces/PySCIPOpt)

scipplan-0.1.0a0/scipplan/__init__.py

@@ -0,0 +1,5 @@
+__version__ = "0.1.0alpha0"
+print(f"SCIPPlan Version: {__version__}")
+__release__ = "v0.1.0"
+__author__ = "Ari Gestetner, Buser Say"
+__email__ = "ages0001@student.monash.edu, buser.say@monash.edu"

scipplan-0.1.0a0/scipplan/config.py

@@ -0,0 +1,152 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from textwrap import dedent
+import argparse
+
+@dataclass
+class Config:
+    """
+    The Config class provides an interface to set the configuration for SCIPPlan. 
+    Config can be set by creating an instance of the class adding the variables desired. 
+    Alternatively, the `get_config` class method will return a config instance using variables set by the programs args (e.g. -D 'domain').
+    """
+    domain: str
+    instance: int
+    horizon: int = field(default=None)
+    epsilon: float = field(default=None)
+    gap: float = field(default=None)
+    show_output: bool = False
+    save_sols: bool = False
+    bigM: float = 1000.0
+    dt_var: str = "Dt"
+    _defaults: dict[str, bool] = field(default_factory=dict, repr=False)
+    
+    def __post_init__(self) -> None:
+        # Set all defaults to False and if the value is None then it will be updated to true
+        self._defaults = {
+            "domain": False,
+            "instance": False,
+            "horizon": False,
+            "epsilon": False,
+            "gap": False
+        }
+        if self.horizon is None:
+            print("Horizon is not provided, and is set to 1")
+            self.horizon = 1
+            self._defaults["horizon"] = True
+            
+        if self.epsilon is None:
+            print("Epsilon is not provided, and is set to 0.1")
+            self.epsilon = 0.1
+            self._defaults["epsilon"] = True
+            
+        if self.gap is None:
+            print("Gap is not provided, and is set to 10.0%")
+            self.gap = 0.1
+            self._defaults["gap"] = True
+            
+    def __str__(self) -> str:
+        text = f"""
+        Configuration:
+        
+        Display SCIP Output: {self.show_output}
+        Save Solutions: {self.show_output}
+        Dt Variable Name: {self.dt_var}
+        
+        Domain (str): {self.domain}
+        Instance (int): {self.instance}
+        Horizon (int): {self.horizon} {'(default)' if self._defaults['horizon'] is True else ''}
+        Epsilon (float): {self.epsilon} {'(default)' if self._defaults['epsilon'] is True else ''}
+        Gap (float): {self.gap * 100}% {'(default)' if self._defaults['gap'] is True else ''}
+        BigM (float): {self.bigM}
+        """
+        return dedent(text)
+    
+    def increment_horizon(self, value: int = 1):
+        self._defaults["horizon"] = False
+        self.horizon += value
+        
+    
+    @classmethod
+    def get_config(cls) -> Config:
+        parser = argparse.ArgumentParser(
+            prog="SCIPPlan"
+        )
+        parser.add_argument(
+            "-D", 
+            "--domain", 
+            required=True,
+            type=str,
+            help="This variable is the name of the domain (e.g. pandemic or navigation)"
+        )
+        parser.add_argument(
+            "-I", 
+            "--instance", 
+            required=True,
+            type=int,
+            help="This is the instance number of the domain (e.g. navigation has instances 1, 2 and 3)"
+        )
+        parser.add_argument(
+            "-H", 
+            "--horizon", 
+            required=False,
+            # default=1,
+            type=int,
+            help="The initial horizon. The solve method will initially begin with this horizon until it finds a feasible solution"
+        )
+        parser.add_argument(
+            "-E", 
+            "--epsilon", 
+            required=False,
+            # default=0.1,
+            type=float,
+            help="SCIPPlan iteratively checks solution for violations at each epsilon value"
+        )
+        parser.add_argument(
+            "-G", 
+            "--gap", 
+            required=False,
+            # default=0.1,
+            type=float,
+            help="SCIP will search for solution with an optimality gap by at least this value"
+        )
+        
+        parser.add_argument(
+            "--bigM", 
+            required=False,
+            default=1000.0,
+            type=float,
+            help="A large value which is used for some constraint encoding formulations, defaults to 1000.0 and can be changed as needed"
+        )
+        
+        parser.add_argument(
+            "--dt-var", 
+            required=False,
+            default="Dt",
+            type=str,
+            help="When writing the constraints, dt_var is the variable name for Dt, defaults to 'Dt' and can be changed based on users preference (e.g. 'dt')"
+        )
+        
+        parser.add_argument(
+            "--show-output", 
+            action="store_true", 
+            default=False, 
+            help="Include this flag to show output from SCIP"
+        )
+        
+        parser.add_argument(
+            "--save-sols", 
+            action="store_true", 
+            default=False, 
+            help="Include this flag to save the solutions from each of the scipplan iterations as well as constraints generated (note, only saves for horizon which has been solved)"
+        )
+        
+        args = parser.parse_args()
+        
+        return Config(**vars(args))
+    
+    
+if __name__ == "__main__":
+    
+    print(Config.get_config())

scipplan-0.1.0a0/scipplan/helpers.py

@@ -0,0 +1,30 @@
+import os
+import csv
+
+from typing import Generator
+from .config import Config
+
+class InfeasibilityError(Exception):
+    """Raise this error when there are no valid solutions for the given horizon"""
+
+def iterate(start: float, stop: float, step: float = 1) -> Generator[float, None, None]:
+    n = start
+    while n <= stop:
+        yield n
+        n += step
+        
+        
+def list_accessible_files(directory):
+    try:
+        files = os.listdir(directory)
+        return files
+    except FileNotFoundError:
+        return []  # Return an empty list if the directory doesn't exist
+
+def write_to_csv(file_name: str, data: list[dict], config: Config) -> None:
+    with open(f"{file_name}_{config.domain}_{config.instance}.csv", 'w', encoding='utf8', newline='') as output_file:
+            fc = csv.DictWriter(output_file, 
+                                fieldnames=data[0].keys(),
+                            )
+            fc.writeheader()
+            fc.writerows(data)