Skip to main content

Component-based systems modelling library.

Project description

SysOpt - Systems Modelling and Optimisation

Overview

sysopt is a python3 framework for component based modelling, simulation and optimisation of continuous time dynamic and control systems.

It allows users to design modular plant and control systems, simulate the trajectory of closed loop systems, and run joint parameter/path optimisation studies.

A Minimal Example

Test problem 3 from Herber and Allison[^1] provides a minimal example of sysopt usage. First, we define some components (plant, and controller), assemble a composite model then setup a optimsation problem for that model and solve it.

from sysopt import Metadata, Composite, SolverContext, PiecewiseConstantSignal, Parameter
from sysopt.modelling.builders import FullStateOutput
from sysopt.blocks import ConstantSignal

k_star = 0.8543 # Known optimal gain. 
t_f = 10

# Define the plant    
def dxdt(t, x, u, p):
    return [x[1], - p[0] * x[0]  + u[0]]

def x0(p):
    return [0, 0]

plant_metadata = Metadata(inputs=['u'], states=['x', 'v'], parameters=['k'])
plant = FullStateOutput(plant_metadata, dxdt, x0)

# Define the controller
controller = ConstantSignal(['u'], name='Controller')

# Define the Composite system via components and wires
model = Composite(name='Model', components=[plant, controller])
model.declare_outputs(['x', 'v', 'u'])
model.wires = [(controller.outputs, plant.inputs),
               (plant.outputs, model.outputs[0:2]),
               (controller.outputs, model.outputs[2])]

k = Parameter('k'')
u = PiecewiseConstantSignal('u', 100)
parameters = {
    plant.parameters['k']: k,
    controller.parameters['u']:u
}
# Setup the joint optimisation problem. 
with SolverContext(model=model, t_final=t_f, parameters=parameters) as solver:

    
    y_final = model.outputs(solver.t_final)
    
    cost = -y_final[0]

    constraints = [u <= 1, u >= -1,
                   y_final[1] >= 0, y_final[1] <= 0]

    problem = solver.problem(arguments=[k, u],  
                             cost=cost,
                             subject_to=constraints)
    
    soln = problem.solve(guess=[0, 0])
    k_min, u_min = soln.argmin
    assert abs(k_min - k_star) < 1e-2

[^1]: Herber, Daniel R., and James T. Allison. "Nested and simultaneous solution strategies for general combined plant and control design problems." Journal of Mechanical Design 141.1 (2019).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sysopt-0.6.4.tar.gz (87.9 kB view details)

Uploaded Source

Built Distribution

sysopt-0.6.4-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

File details

Details for the file sysopt-0.6.4.tar.gz.

File metadata

  • Download URL: sysopt-0.6.4.tar.gz
  • Upload date:
  • Size: 87.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for sysopt-0.6.4.tar.gz
Algorithm Hash digest
SHA256 ebc145d58995d5ac81cd8361c31f113af2ecebb5eeefb062dfb77e8f7e0669bf
MD5 b453a02c6db3dc343fb5ba8f8f38fa87
BLAKE2b-256 07ba8fc0d5b4f62988582859d856c309abb832bd51fb6f3f286a39ef627b4b70

See more details on using hashes here.

File details

Details for the file sysopt-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: sysopt-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 66.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for sysopt-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 edd65d2421138412014342666a1463bb990dea74185abc2a7f9949bb4808c8b3
MD5 099f94e7b2c5897e9f9110bceef852a8
BLAKE2b-256 cd91b90afe7d7560b4d5248629da34f0d267a64af195bfc7573cbd3666222eb2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page