Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

# Copyright (C) 2012, 2013, 2014 Ben Elliston 

# Copyright (C) 2014, 2015 The University of New South Wales 

# 

# This file is free software; you can redistribute it and/or modify it 

# under the terms of the GNU General Public License as published by 

# the Free Software Foundation; either version 3 of the License, or 

# (at your option) any later version. 

 

"""Supply and demand side scenarios.""" 

import heapq 

 

import numpy as np 

 

import configfile 

import consts 

import generators 

import polygons 

import regions 

 

 

def supply_switch(label): 

    """ 

    Return a callback function to set up a given scenario. 

 

    >>> supply_switch('re100') # doctest: +ELLIPSIS 

    <function re100 at 0x...> 

    >>> supply_switch('foo') 

    Traceback (most recent call last): 

      ... 

    ValueError: unknown supply scenario foo 

    """ 

    try: 

        callback = supply_scenarios[label] 

    except KeyError: 

        raise ValueError('unknown supply scenario %s' % label) 

    return callback 

 

 

def _demand_response(): 

    """ 

    Return a list of DR 'generators'. 

 

    >>> dr = _demand_response() 

    >>> len(dr) 

    3 

    """ 

    dr1 = generators.DemandResponse(regions.nsw, 1000, 100, "DR100") 

    dr2 = generators.DemandResponse(regions.nsw, 1000, 500, "DR500") 

    dr3 = generators.DemandResponse(regions.nsw, 1000, 1000, "DR1000") 

    return [dr1, dr2, dr3] 

 

 

def _hydro(): 

    """ 

    Return a list of existing hydroelectric generators. 

 

    >>> h = _hydro() 

    >>> len(h) 

    5 

    """ 

    # Ignore the one small hydro plant in SA. 

    hydro1 = generators.Hydro(regions.tas, 2255, 

                              label=regions.tas.id + ' hydro') 

    hydro2 = generators.Hydro(regions.nsw, 910, 

                              label=regions.nsw.id + ' hydro') 

    hydro3 = generators.Hydro(regions.vic, 2237, 

                              label=regions.vic.id + ' hydro') 

    # QLD: Wivenhoe (http://www.csenergy.com.au/content-%28168%29-wivenhoe.htm) 

    psh1 = generators.PumpedHydro(regions.qld, 500, 5000, 

                                  label='QLD1 pumped-hydro') 

    # NSW: Tumut 3 (6x250), Bendeela (2x80) and Kangaroo Valley (2x40) 

    psh2 = generators.PumpedHydro(regions.nsw, 1740, 15000, 

                                  label='NSW1 pumped-hydro') 

    return [psh1, psh2, hydro1, hydro2, hydro3] 

 

 

def replacement(context): 

    """The current NEM fleet, more or less. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> replacement(c) 

    >>> len(c.generators) 

    7 

    """ 

    coal = generators.Black_Coal(regions.nsw, 0) 

    ocgt = generators.OCGT(regions.nsw, 0) 

    context.generators = [coal] + _hydro() + [ocgt] 

 

 

def _one_ccgt(context): 

    """One CCGT only. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> _one_ccgt(c) 

    >>> len(c.generators) 

    1 

    """ 

    context.generators = [generators.CCGT(regions.nsw, 0)] 

 

 

def ccgt(context): 

    """All gas scenario. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> ccgt(c) 

    >>> len(c.generators) 

    7 

    """ 

    # pylint: disable=redefined-outer-name 

    ccgt = generators.CCGT(regions.nsw, 0) 

    ocgt = generators.OCGT(regions.nsw, 0) 

    context.generators = [ccgt] + _hydro() + [ocgt] 

 

 

def ccgt_ccs(context): 

    """CCGT CCS scenario. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> ccgt_ccs(c) 

    >>> len(c.generators) 

    7 

    """ 

    # pylint: disable=redefined-outer-name 

    ccgt = generators.CCGT_CCS(regions.nsw, 0) 

    ocgt = generators.OCGT(regions.nsw, 0) 

    context.generators = [ccgt] + _hydro() + [ocgt] 

 

 

def coal_ccs(context): 

    """Coal CCS scenario. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> coal_ccs(c) 

    >>> len(c.generators) 

    7 

    """ 

    coal = generators.Coal_CCS(regions.nsw, 0) 

    ocgt = generators.OCGT(regions.nsw, 0) 

    context.generators = [coal] + _hydro() + [ocgt] 

 

 

def re100(context): 

    # pylint: disable=unused-argument 

    """100% renewable electricity. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100(c) 

    >>> len(c.generators) 

    22 

    """ 

    from generators import CentralReceiver, Wind, PV1Axis, Hydro, PumpedHydro, Biofuel 

 

    capfactor = {CentralReceiver: 0.60, Wind: 0.40, PV1Axis: 0.33, Hydro: None, PumpedHydro: None, Biofuel: None} 

    energy_fraction = {CentralReceiver: 0.40, Wind: 0.30, PV1Axis: 0.10, Hydro: None, PumpedHydro: None, Biofuel: None} 

 

    result = [] 

    # The following list is in merit order. 

    for g in [PV1Axis, Wind, PumpedHydro, Hydro, CentralReceiver, Biofuel]: 

        if capfactor[g] is not None: 

            capacity = 204.4 * consts.twh * energy_fraction[g] / (capfactor[g] * 8760) 

        if g == PumpedHydro: 

            result += [h for h in _hydro() if isinstance(h, PumpedHydro)] 

        elif g == Hydro: 

            result += [h for h in _hydro() if isinstance(h, Hydro) and not isinstance(h, PumpedHydro)] 

        elif g == Biofuel: 

            # 24 GW biofuelled gas turbines (fixed) 

            # distribute 24GW of biofuelled turbines across chosen regions 

            # the region list is in order of approximate demand 

            rgns = [regions.nsw, regions.qld, regions.sa, regions.tas, regions.vic] 

            for r in rgns: 

                result.append(Biofuel(r, 24000 / len(rgns), label=r.id + ' GT')) 

        elif g == PV1Axis: 

            # Hand chosen polygons with high capacity factors 

            for poly in [14, 21, 13, 37]: 

                rgn = polygons.region_table[poly] 

                # Put 25% PV capacity in each region. 

                result.append(g(rgn, capacity * 0.25, 

                                configfile.get('generation', 'pv1axis-trace'), 

                                poly - 1, 

                                build_limit=polygons.pv_limit[poly], 

                                label='polygon %d PV' % poly)) 

        elif g == CentralReceiver: 

            polys = [14, 20, 21] 

            capacity /= len(polys) 

            for poly in polys: 

                rgn = polygons.region_table[poly] 

                result.append(g(rgn, capacity, 2, 6, 

                                configfile.get('generation', 'cst-trace'), 

                                poly - 1, 

                                build_limit=polygons.cst_limit[poly], 

                                label='polygon %d CST' % poly)) 

        elif g == Wind: 

            # Hand chosen polygons with high capacity factors 

            for poly in [1, 20, 24, 39, 43]: 

                rgn = polygons.region_table[poly] 

                # Put 20% wind capacity in each region. 

                result.append(g(rgn, capacity * 0.2, 

                                configfile.get('generation', 'wind-trace'), 

                                poly - 1, 

                                delimiter=',', 

                                build_limit=polygons.wind_limit[poly], 

                                label='polygon %d wind' % poly)) 

        else:  # pragma: no cover 

            raise ValueError 

 

    context.generators = result 

 

 

def re100_batteries(context): 

    """Use lots of renewables plus battery storage. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re100_batteries(c) 

    >>> len(c.generators) 

    23 

    """ 

    re100(context) 

    nsw_battery = generators.Battery(regions.nsw, 0, 0) 

    g = context.generators 

    context.generators = g[0:9] + [nsw_battery] + g[9:] 

 

 

def _one_per_poly(region): 

    """Return three lists of wind, PV and CST generators, one per polygon. 

 

    >>> import regions 

    >>> wind, pv, cst = _one_per_poly(regions.tas) 

    >>> len(wind), len(pv), len(cst) 

    (4, 4, 4) 

    """ 

    pv = [] 

    wind = [] 

    cst = [] 

 

    for poly in polygons.in_region(region): 

        wind.append(generators.Wind(region, 0, 

                                    configfile.get('generation', 'wind-trace'), 

                                    poly - 1, 

                                    delimiter=',', 

                                    build_limit=polygons.wind_limit[poly], 

                                    label='poly %d wind' % poly)) 

        pv.append(generators.PV1Axis(region, 0, 

                                     configfile.get('generation', 'pv1axis-trace'), 

                                     poly - 1, 

                                     build_limit=polygons.pv_limit[poly], 

                                     label='poly %d PV' % poly)) 

        cst.append(generators.CentralReceiver(region, 0, 2, 6, 

                                              configfile.get('generation', 'cst-trace'), 

                                              poly - 1, 

                                              build_limit=polygons.cst_limit[poly], 

                                              label='poly %d CST' % poly)) 

    return wind, pv, cst 

 

 

def re100_one_region(context, region): 

    """100% renewables in one region only. 

 

    >>> import regions 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re100_one_region(c, regions.tas) 

    >>> for g in c.generators: assert g.region is regions.tas 

    """ 

    re100(context) 

    context.regions = [region] 

    wind, pv, cst = _one_per_poly(region) 

    newlist = wind 

    newlist += pv 

    newlist += [g for g in context.generators if isinstance(g, generators.Hydro) and g.region is region] 

    newlist += cst 

    newlist += [g for g in context.generators if isinstance(g, generators.Biofuel) and g.region is region] 

    context.generators = newlist 

 

 

def re_plus_ccs(context): 

    """Mostly renewables with fossil and CCS augmentation. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re_plus_ccs(c) 

    >>> len(c.generators) 

    23 

    """ 

    re100(context) 

    coal = generators.Black_Coal(regions.nsw, 0) 

    # pylint: disable=redefined-outer-name 

    coal_ccs = generators.Coal_CCS(regions.nsw, 0) 

    # pylint: disable=redefined-outer-name 

    ccgt = generators.CCGT(regions.nsw, 0) 

    ccgt_ccs = generators.CCGT_CCS(regions.nsw, 0) 

    ocgt = generators.OCGT(regions.nsw, 0) 

    g = context.generators 

    context.generators = [coal, coal_ccs, ccgt, ccgt_ccs] + g[:-4] + [ocgt] 

 

 

def re_plus_fossil(context): 

    """Mostly renewables with some fossil augmentation. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re_plus_fossil(c) 

    >>> len(c.generators) 

    21 

    """ 

    re100(context) 

    # pylint: disable=redefined-outer-name 

    coal = generators.Black_Coal(regions.nsw, 0) 

    ccgt = generators.CCGT(regions.nsw, 0) 

    ocgt = generators.OCGT(regions.nsw, 0) 

    g = context.generators 

    context.generators = [coal, ccgt] + g[:-4] + [ocgt] 

 

 

def re100_dsp(context): 

    """Mostly renewables with demand side participation. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re100_dsp(c) 

    >>> len(c.generators) 

    25 

    >>> isinstance(c.generators[-1], generators.DemandResponse) 

    True 

    """ 

    re100(context) 

    g = context.generators 

    context.generators = g + _demand_response() 

 

 

def re100_geothermal_egs(context): 

    """100% renewables plus EGS geothermal. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_geothermal_egs(c) 

    >>> isinstance(c.generators[0], generators.Geothermal) 

    True 

    """ 

    re100(context) 

    g = context.generators 

    geo = generators.Geothermal_EGS(regions.qld, 0, 

                                    configfile.get('generation', 'egs-geothermal-trace'), 

                                    14,  # (polygon 14) 

                                    'EGS geothermal') 

    context.generators = [geo] + g 

 

 

def re100_geothermal_hsa(context): 

    """100% renewables plus HSA geothermal. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_geothermal_hsa(c) 

    >>> isinstance(c.generators[0], generators.Geothermal_HSA) 

    True 

    """ 

    re100(context) 

    g = context.generators 

    geo = generators.Geothermal_HSA(regions.vic, 0, 

                                    configfile.get('generation', 'hsa-geothermal-trace'), 

                                    38,  # (polygon 38) 

                                    'HSA geothermal') 

    context.generators = [geo] + g 

 

 

def re100_geothermal_both(context): 

    """100% renewables plus both HSA and EGS geothermal. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_geothermal_both(c) 

    >>> isinstance(c.generators[0], generators.Geothermal_HSA) 

    True 

    >>> isinstance(c.generators[1], generators.Geothermal_EGS) 

    True 

    """ 

    # Grab the HSA generator. 

    re100_geothermal_hsa(context) 

    hsa = context.generators[0] 

 

    # Prepend it to the EGS geothermal scenario. 

    re100_geothermal_egs(context) 

    context.generators = [hsa] + context.generators 

 

 

def re100_geothermal_both_nocst(context): 

    """100% renewables plus geothermal, but no CST. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_geothermal_both_nocst(c) 

    >>> for g in c.generators: assert not isinstance(g, generators.CST) 

    """ 

    re100_geothermal_both(context) 

    newlist = [g for g in context.generators if not isinstance(g, generators.CST)] 

    context.generators = newlist 

 

 

def re100_geothermal_both_nopv(context): 

    """100% renewables plus geothermal, but no CST. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_geothermal_both_nopv(c) 

    >>> for g in c.generators: assert not isinstance(g, generators.PV) 

    """ 

    re100_geothermal_both(context) 

    newlist = [g for g in context.generators if not isinstance(g, generators.PV)] 

    context.generators = newlist 

 

 

def re100_geothermal_both_nowind(context): 

    """100% renewables plus geothermal, but no CST. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_geothermal_both_nowind(c) 

    >>> for g in c.generators: assert not isinstance(g, generators.Wind) 

    """ 

    re100_geothermal_both(context) 

    newlist = [g for g in context.generators if not isinstance(g, generators.Wind)] 

    context.generators = newlist 

 

 

def re100_geothermal_both_novre(context): 

    """100% renewables plus geothermal, but no variable renewable energy (VRE). 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_geothermal_both_novre(c) 

    >>> for g in c.generators: assert not isinstance(g, generators.Wind) and not isinstance(g, generators.PV) 

    """ 

    re100_geothermal_both(context) 

    newlist = [g for g in context.generators if not isinstance(g, generators.Wind) and not isinstance(g, generators.PV)] 

    context.generators = newlist 

 

 

def re100_nocst(context): 

    """100% renewables, but no CST. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_nocst(c) 

    >>> for g in c.generators: assert not isinstance(g, generators.CST) 

    """ 

    re100(context) 

    newlist = [g for g in context.generators if not isinstance(g, generators.CST)] 

    context.generators = newlist 

 

 

def re100_egs_nocst(context): 

    """100% renewables with EGS geothermal but no CST. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_egs_nocst(c) 

    >>> for g in c.generators: assert not isinstance(g, generators.CST) 

    """ 

    re100_geothermal_egs(context) 

    newlist = [g for g in context.generators if not isinstance(g, generators.CST)] 

    context.generators = newlist 

 

 

def re100_hsa_nocst(context): 

    """100% renewables with HSA geothermal, but no CST. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> re100_hsa_nocst(c) 

    >>> for g in c.generators: assert not isinstance(g, generators.CST) 

    """ 

    re100_geothermal_hsa(context) 

    newlist = [g for g in context.generators if not isinstance(g, generators.CST)] 

    context.generators = newlist 

 

 

def re100_nsw(context): 

    """100% renewables in New South Wales only. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re100_nsw(c) 

    >>> for g in c.generators: assert g.region is regions.nsw 

    """ 

    re100_one_region(context, regions.nsw) 

 

 

def re100_qld(context): 

    """100% renewables in Queensland only. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re100_qld(c) 

    >>> for g in c.generators: assert g.region is regions.qld 

    """ 

    re100_one_region(context, regions.qld) 

 

 

def re100_south_aus(context): 

    """100% renewables in South Australia only. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> re100_south_aus(c) 

    >>> for g in c.generators: assert g.region is regions.sa 

    """ 

    re100_one_region(context, regions.sa) 

 

 

def theworks(context): 

    """All technologies. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.generators = [] 

    >>> theworks(c) 

    >>> len(c.generators) 

    28 

    """ 

    re100(context) 

    # pylint: disable=redefined-outer-name 

    # use polygon 38 

    geo = generators.Geothermal_HSA(regions.nsw, 0, 

                                    configfile.get('generation', 'hsa-geothermal-trace'), 38) 

    pt = generators.ParabolicTrough(regions.nsw, 0, 2, 6, 

                                    configfile.get('generation', 'cst-trace'), 12) 

    coal = generators.Black_Coal(regions.nsw, 0) 

    coal_ccs = generators.Coal_CCS(regions.nsw, 0) 

    ccgt = generators.CCGT(regions.nsw, 0) 

    ccgt_ccs = generators.CCGT_CCS(regions.nsw, 0) 

    ocgt = generators.OCGT(regions.nsw, 0) 

    batt = generators.Battery(regions.nsw, 0, 0) 

    diesel = generators.Diesel(regions.nsw, 0) 

    dem = generators.DemandResponse(regions.nsw, 0, 300) 

    g = context.generators 

    context.generators = [geo, pt, coal, coal_ccs, ccgt, ccgt_ccs] + \ 

        g[:-4] + [ocgt, diesel, batt, dem] 

 

supply_scenarios = {'__one_ccgt__': _one_ccgt,  # nb. for testing only 

                    'ccgt': ccgt, 

                    'ccgt-ccs': ccgt_ccs, 

                    'coal-ccs': coal_ccs, 

                    're+ccs': re_plus_ccs, 

                    're+fossil': re_plus_fossil, 

                    're100': re100, 

                    're100-qld': re100_qld, 

                    're100-nsw': re100_nsw, 

                    're100-sa': re100_south_aus, 

                    're100+batteries': re100_batteries, 

                    're100+dsp': re100_dsp, 

                    're100+egs': re100_geothermal_egs, 

                    're100+egs-nocst': re100_egs_nocst, 

                    're100+geo': re100_geothermal_both, 

                    're100+geo-nocst': re100_geothermal_both_nocst, 

                    're100+geo-nopv': re100_geothermal_both_nopv, 

                    're100+geo-novre': re100_geothermal_both_novre, 

                    're100+geo-nowind': re100_geothermal_both_nowind, 

                    're100+hsa': re100_geothermal_hsa, 

                    're100+hsa-nocst': re100_hsa_nocst, 

                    're100-nocst': re100_nocst, 

                    'replacement': replacement, 

                    'theworks': theworks 

                    } 

 

 

### Demand modifiers 

 

def demand_switch(label): 

    """Return a callback function to modify the demand. 

 

    >>> demand_switch('unchanged')        # doctest: +ELLIPSIS 

    <function unchanged at ...> 

    >>> demand_switch('roll:10')      # doctest: +ELLIPSIS 

    <function <lambda> at ...> 

    >>> demand_switch('scale:5')    # doctest: +ELLIPSIS 

    <function <lambda> at ...> 

    >>> demand_switch('shift:100:10:12') # doctest: +ELLIPSIS 

    <function <lambda> at ...> 

    >>> demand_switch('shift:100:-2:12') 

    Traceback (most recent call last): 

      ... 

    ValueError: invalid scenario: shift:100:-2:12 

    >>> demand_switch('peaks:10:34000') # doctest: +ELLIPSIS 

    <function <lambda> at ...> 

    >>> demand_switch('npeaks:10:5') # doctest: +ELLIPSIS 

    <function <lambda> at ...> 

    >>> demand_switch('foo') 

    Traceback (most recent call last): 

      ... 

    ValueError: invalid scenario: foo 

    """ 

    try: 

        if label == 'unchanged': 

            return unchanged 

 

        elif label.startswith('roll:'): 

            # label form: "roll:X" rolls the load by X timesteps 

            _, posns = label.split(':') 

            posns = int(posns) 

            return lambda context: roll_demand(context, posns) 

 

        elif label.startswith('scale:'): 

            # label form: "scale:X" scales the load by X% 

            _, factor = label.split(':') 

            factor = 1 + int(factor) / 100. 

            return lambda context: scale_demand(context, factor) 

 

        elif label.startswith('shift:'): 

            # label form: "shift:N:H1:H2" load shifts N MW every day 

            _, demand, h1, h2 = label.split(':') 

            demand = int(demand) 

            fromHour = int(h1) 

            toHour = int(h2) 

            if fromHour < 0 or fromHour >= 24 or toHour < 0 or toHour >= 24: 

                raise ValueError 

            return lambda context: shift_demand(context, demand, fromHour, toHour) 

 

        elif label.startswith('peaks:'): 

            # label form: "peaks:N:X" adjust demand peaks over N megawatts 

            # by X% 

            _, power, factor = label.split(':') 

            power = int(power) 

            factor = 1 + int(factor) / 100. 

            return lambda context: scale_peaks(context, power, factor) 

 

        elif label.startswith('npeaks:'): 

            # label form: "npeaks:N:X" adjust top N demand peaks by X% 

            _, topn, factor = label.split(':') 

            topn = int(topn) 

            factor = 1 + int(factor) / 100. 

            return lambda context: scale_npeaks(context, topn, factor) 

        else: 

            raise ValueError 

 

    except ValueError: 

        raise ValueError('invalid scenario: %s' % label) 

 

 

def unchanged(context): 

    """No demand modification. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> unchanged(c) 

    """ 

    # pylint: disable=unused-argument 

    pass 

 

 

def roll_demand(context, posns): 

    """ 

    Roll demand by posns timesteps. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.demand = np.arange(3) 

    >>> roll_demand(c, 1) 

    >>> print c.demand 

    [2 0 1] 

    """ 

    context.demand = np.roll(context.demand, posns) 

 

 

def scale_demand(context, factor): 

    """ 

    Scale demand by factor%. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.demand = np.arange(3) 

    >>> scale_demand(c, 1.2) 

    >>> print c.demand   # doctest: +NORMALIZE_WHITESPACE 

    [ 0. 1.2 2.4] 

    """ 

    context.demand = context.demand * factor 

 

 

def shift_demand(context, demand, fromHour, toHour): 

    """Move N MW of demand from fromHour to toHour. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.demand = np.zeros ((5,10)) 

    >>> c.demand[::,3] = 5000 

    >>> shift_demand(c, 2500, 3, 4) 

    >>> c.demand[::,3] 

    array([ 4500.,  4500.,  4500.,  4500.,  4500.]) 

    >>> c.demand[::,4] 

    array([ 500.,  500.,  500.,  500.,  500.]) 

    """ 

    # Shed equally in each region for simplicity 

    demand /= 5 

    context.demand[::, fromHour::24] -= demand 

    context.demand[::, toHour::24] += demand 

    # Ensure load never goes negative 

    context.demand = np.where(context.demand < 0, 0, context.demand) 

 

 

def scale_peaks(context, power, factor): 

    """Adjust demand peaks over N megawatts by factor%. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.demand = np.zeros ((5,10)) 

    >>> c.demand[::,3] = 5000 

    >>> scale_peaks(c, 3000, 0.5) 

    >>> c.demand[::,3] 

    array([ 2500.,  2500.,  2500.,  2500.,  2500.]) 

    """ 

    agg_demand = context.demand.sum(axis=0) 

    where = np.where(agg_demand > power) 

    context.demand[::, where] *= factor 

 

 

def scale_npeaks(context, topn, factor): 

    """Adjust top N demand peaks by X%. 

 

    >>> class C: pass 

    >>> c = C() 

    >>> c.demand = np.zeros ((5,10)) 

    >>> c.demand[::,3] = 5000 

    >>> c.demand[::,4] = 3000 

    >>> scale_npeaks(c, 1, 0.5) 

    >>> c.demand[::,4] 

    array([ 3000.,  3000.,  3000.,  3000.,  3000.]) 

    >>> c.demand[::,3] 

    array([ 2500.,  2500.,  2500.,  2500.,  2500.]) 

    """ 

    agg_demand = context.demand.sum(axis=0) 

    top_demands = heapq.nlargest(topn, agg_demand) 

    # A trick from: 

    # http://docs.scipy.org/doc/numpy/reference/generated/ 

    #   numpy.where.html#numpy.where 

    ix = np.in1d(agg_demand.ravel(), top_demands).reshape(agg_demand.shape) 

    where = np.where(ix) 

    context.demand[::, where] *= factor