Introduction

Installation

Simply run:

python3 -m pip install icoco

Quick start

Implement your own ICoCo class

Your ICoCo class must derive from icoco.problem.Problem:

from icoco import Problem

class MyICoCoProblem(Problem):

    def __init__(self):
        pass

    ...

Once all abstractmethods must be implmemented, you have a functional API.

Use it in a safe way (EXPERIMENTAL)

The icoco.problem_wrapper.ProblemWrapper wrapper implements checks for calls inside/outside time step context and other coherency verifications.

from icoco import Problem, ProblemWrapper

class MyICoCoProblem(Problem):

    def __init__(self):
        pass

    ...

my_problem = ProblemWrapper(MyICoCoProblem())

my_problem.solveTimeStep() # FAILS! since neither initialize nor initTimeStep have been called.