Skip to content

calliope.examples

Example models that can be loaded directly into a session.

milp(*args, **kwargs)

Returns the built-in urban-scale example model with MILP constraints enabled.

Source code in src/calliope/examples.py 
35
36
37
def milp(*args, **kwargs):
    """Returns the built-in urban-scale example model with MILP constraints enabled."""
    return urban_scale(scenario="milp", *args, **kwargs)

national_scale(*args, **kwargs)

Returns the built-in national-scale example model.

Source code in src/calliope/examples.py 
13
14
15
16
17
def national_scale(*args, **kwargs):
    """Returns the built-in national-scale example model."""
    return read_yaml(
        _EXAMPLE_MODEL_DIR / "national_scale" / "model.yaml", *args, **kwargs
    )

operate(*args, **kwargs)

Returns the built-in urban-scale example model in operate mode.

Source code in src/calliope/examples.py 
40
41
42
def operate(*args, **kwargs):
    """Returns the built-in urban-scale example model in operate mode."""
    return urban_scale(scenario="operate", *args, **kwargs)

operate_milp(*args, **kwargs)

Returns the built-in urban-scale example model in operate mode with MILP constraints enabled.

Source code in src/calliope/examples.py 
45
46
47
def operate_milp(*args, **kwargs):
    """Returns the built-in urban-scale example model in operate mode with MILP constraints enabled."""
    return urban_scale(scenario="operate,milp", *args, **kwargs)

time_clustering(*args, **kwargs)

Returns the built-in national-scale example model with time clustering.

Source code in src/calliope/examples.py 
20
21
22
def time_clustering(*args, **kwargs):
    """Returns the built-in national-scale example model with time clustering."""
    return national_scale(scenario="time_clustering", *args, **kwargs)

time_resampling(*args, **kwargs)

Returns the built-in national-scale example model with time resampling.

Source code in src/calliope/examples.py 
25
26
27
def time_resampling(*args, **kwargs):
    """Returns the built-in national-scale example model with time resampling."""
    return national_scale(scenario="time_resampling", *args, **kwargs)

urban_scale(*args, **kwargs)

Returns the built-in urban-scale example model.

Source code in src/calliope/examples.py 
30
31
32
def urban_scale(*args, **kwargs):
    """Returns the built-in urban-scale example model."""
    return read_yaml(_EXAMPLE_MODEL_DIR / "urban_scale" / "model.yaml", *args, **kwargs)