You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
UnitCommitment.jl/0.1/search/search_index.json

1 line
37 KiB

{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"UnitCommitment.jl UnitCommitment.jl (UC.jl) is a Julia optimization package for the Security-Constrained Unit Commitment Problem (SCUC), a fundamental optimization problem in power systems used, for example, to clear the day-ahead electricity markets. The package provides benchmark instances for the problem and Julia/JuMP implementations of state-of-the-art mixed-integer programming formulations. Package Components Data Format: The package proposes an extensible and fully-documented JSON-based data specification format for SCUC, developed in collaboration with Independent System Operators (ISOs), which describes the most important aspects of the problem. The format supports all the most common generator characteristics (including ramping, piecewise-linear production cost curves and time-dependent startup costs), as well as operating reserves, price-sensitive loads, transmission networks and contingencies. Benchmark Instances: The package provides a diverse collection of large-scale benchmark instances collected from the literature and extended to make them more challenging and realistic. Model Implementation : The package provides a Julia/JuMP implementation of state-of-the-art formulations and solution methods for SCUC. Our goal is to keep this implementation up-to-date, as new methods are proposed in the literature. Benchmark Tools: The package provides automated benchmark scripts to accurately evaluate the performance impact of proposed code changes. Documentation Usage Data Format Source code https://github.com/ANL-CEEESA/unitcommitment.jl Authors Alinson Santos Xavier (Argonne National Laboratory) Feng Qiu (Argonne National Laboratory) Acknowledgments We would like to thank Aleksandr M. Kazachkov (University of Florida), Yonghong Chen (Midcontinent Independent System Operator), Feng Pan (Pacific Northwest National Laboratory) for valuable feedback on early versions of this package. Based upon work supported by Laboratory Directed Research and Development (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357. License Released under the modified BSD license. See LICENSE.md for more details.","title":"Home"},{"location":"#unitcommitmentjl","text":"UnitCommitment.jl (UC.jl) is a Julia optimization package for the Security-Constrained Unit Commitment Problem (SCUC), a fundamental optimization problem in power systems used, for example, to clear the day-ahead electricity markets. The package provides benchmark instances for the problem and Julia/JuMP implementations of state-of-the-art mixed-integer programming formulations.","title":"UnitCommitment.jl"},{"location":"#package-components","text":"Data Format: The package proposes an extensible and fully-documented JSON-based data specification format for SCUC, developed in collaboration with Independent System Operators (ISOs), which describes the most important aspects of the problem. The format supports all the most common generator characteristics (including ramping, piecewise-linear production cost curves and time-dependent startup costs), as well as operating reserves, price-sensitive loads, transmission networks and contingencies. Benchmark Instances: The package provides a diverse collection of large-scale benchmark instances collected from the literature and extended to make them more challenging and realistic. Model Implementation : The package provides a Julia/JuMP implementation of state-of-the-art formulations and solution methods for SCUC. Our goal is to keep this implementation up-to-date, as new methods are proposed in the literature. Benchmark Tools: The package provides automated benchmark scripts to accurately evaluate the performance impact of proposed code changes.","title":"Package Components"},{"location":"#documentation","text":"Usage Data Format","title":"Documentation"},{"location":"#source-code","text":"https://github.com/ANL-CEEESA/unitcommitment.jl","title":"Source code"},{"location":"#authors","text":"Alinson Santos Xavier (Argonne National Laboratory) Feng Qiu (Argonne National Laboratory)","title":"Authors"},{"location":"#acknowledgments","text":"We would like to thank Aleksandr M. Kazachkov (University of Florida), Yonghong Chen (Midcontinent Independent System Operator), Feng Pan (Pacific Northwest National Laboratory) for valuable feedback on early versions of this package. Based upon work supported by Laboratory Directed Research and Development (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357.","title":"Acknowledgments"},{"location":"#license","text":"Released under the modified BSD license. See LICENSE.md for more details.","title":"License"},{"location":"format/","text":"Data Format 1. Input Data Format Instances are specified by JSON files containing the following main sections: Parameters Buses Generators Price-sensitive loads Transmission lines Reserves Contingencies Each section is described in detail below. For a complete example, see case14.json . 1.1 Parameters This section describes system-wide parameters, such as power balance penalties, and optimization parameters, such as the length of the planning horizon. Key Description Default Time series? Time (h) Length of the planning horizon (in hours) Required N Power balance penalty ($/MW) Penalty for system-wide shortage or surplus in production (in $/MW). This is charged per time period. For example, if there is a shortage of 1 MW for three time periods, three times this amount will be charged. 1000.0 Y Example { \"Parameters\": { \"Time (h)\": 4, \"Power balance penalty ($/MW)\": 1000.0 } } 1.2 Buses This section describes the characteristics of each bus in the system. Key Description Default Time series? Load (MW) Fixed load connected to the bus (in MW). Required Y Example { \"Buses\": { \"b1\": { \"Load (MW)\": 0.0 }, \"b2\": { \"Load (MW)\": [ 26.01527, 24.46212, 23.29725, 22.90897 ] } } } 1.3 Generators This section describes all generators in the system, including thermal units, renewable units and virtual units. Key Description Default Time series? Bus Identifier of the bus where this generator is located (string) Required N Production cost curve (MW) and Production cost curve ($) Parameters describing the piecewise-linear production costs. See below for more details. Required Y Startup costs ($) and Startup delays (h) Parameters describing how much it costs to start the generator after it has been shut down for a certain amount of time. If Startup costs ($) and Startup delays (h) are set to [300.0, 400.0] and [1, 4] , for example, and the generator is shut down at time t , then it costs 300 to start up the generator at times t+1 , t+2 or t+3 , and 400 to start the generator at time t+4 or any time after that. The number of startup cost points is unlimited, and may be different for each generator. Startup delays must be strictly increasing. [0.0] and [1] N Minimum uptime (h) Minimum amount of time the generator must stay operational after starting up (in hours). For example, if the generator starts up at time 1 and Minimum uptime (h) is set to 4, then the generator can only shut down at time 5. 1 N Minimum downtime (h) Minimum amount of time the generator must stay offline after shutting down (in hours). For example, if the generator shuts down at time 1 and Minimum downtime (h) is set to 4, then the generator can only start producing power again at time 5. 1 N Ramp up limit (MW) Maximum increase in production from one time period to the next (in MW). For example, if the generator is producing 100 MW at time 1 and if this parameter is set to 40 MW, then the generator will produce at most 140 MW at time 2. +inf N Ramp down limit (MW) Maximum decrease in production from one time period to the next (in MW). For example, if the generator is producing 100 MW at time 1 and this parameter is set to 40 MW, then the generator will produce at least 60 MW at time 2. +inf N Startup limit (MW) Maximum amount of power a generator can produce immediately after starting up (in MW). +inf N Shutdown limit (MW) Maximum amount of power a generator can produce immediately before shutting down (in MW). Specifically, the generator can only shut down at time t+1 if its production at time t is below this limit. +inf N Initial status (h) If set to a positive number, indicates the amount of time the generator has been on at the beginning of the simulation, and if set to a negative number, the amount of time the generator has been off. For example, if Initial status (h) is -2 , this means that the generator was off at simulation time -2 and -1 . The simulation starts at time 0 . Required N Initial power (MW) Amount of power the generator at time period -1 , immediately before the planning horizon starts. Required N Must run? If true , the generator should be committed, even that is not economical (Boolean). false Y Provides spinning reserves? If true , this generator may provide spinning reserves (Boolean). true Y Production costs and limits Production costs are represented as piecewise-linear curves. Figure 1 shows an example cost curve with three segments, where it costs 1400, 1600, 2200 and 2400 dollars to generate, respectively, 100, 110, 130 and 135 MW of power. To model this generator, Production cost curve (MW) should be set to [100, 110, 130, 135] , and Production cost curve ($) should be set to [1400, 1600, 2200, 2400] . Note that this curve also specifies the production limits. Specifically, the first point identifies the minimum power output when the unit is operational, while the last point identifies the maximum power output. Figure 1. Piecewise-linear production cost curve. Additional remarks: For time-dependent production limits or time-dependent production costs, the usage of nested arrays is allowed. For example, if Production cost curve (MW) is set to [5.0, [10.0, 12.0, 15.0, 20.0]] , then the unit may generate at most 10, 12, 15 and 20 MW of power during time periods 1, 2, 3 and 4, respectively. The minimum output for all time periods is fixed to at 5 MW. There is no limit to the number of piecewise-linear segments, and different generators may have a different number of segments. If Production cost curve (MW) and Production cost curve ($) both contain a single element, then the generator must produce exactly that amount of power when operational. To specify that the generator may produce any amount of power up to a certain limit P , the parameter Production cost curve (MW) should be set to [0, P] . Production cost curves must be convex. Example { \"Generators\": { \"gen1\": { \"Bus\": \"b1\", \"Production cost curve (MW)\": [100.0, 110.0, 130.0, 135.0], \"Production cost curve ($)\": [1400.0, 1600.0, 2200.0, 2400.0], \"Startup costs ($)\": [300.0, 400.0], \"Startup delays (h)\": [1, 4], \"Ramp up limit (MW)\": 232.68, \"Ramp down limit (MW)\": 232.68, \"Startup limit (MW)\": 232.68, \"Shutdown limit (MW)\": 232.68, \"Minimum downtime (h)\": 4, \"Minimum uptime (h)\": 4, \"Initial status (h)\": 12, \"Must run?\": false, \"Provides spinning reserves?\": true, }, \"gen2\": { \"Bus\": \"b5\", \"Production cost curve (MW)\": [0.0, [10.0, 8.0, 0.0, 3.0]], \"Production cost curve ($)\": [0.0, 0.0], \"Provides spinning reserves?\": true, } } } 1.4 Price-sensitive loads This section describes components in the system which may increase or reduce their energy consumption according to the energy prices. Fixed loads (as described in the buses section) are always served, regardless of the price, unless there is significant congestion in the system or insufficient production capacity. Price-sensitive loads, on the other hand, are only served if it is economical to do so. Key Description Default Time series? Bus Bus where the load is located. Multiple price-sensitive loads may be placed at the same bus. Required N Revenue ($/MW) Revenue obtained for serving each MW of power to this load. Required Y Demand (MW) Maximum amount of power required by this load. Any amount lower than this may be served. Required Y Example { \"Price-sensitive loads\": { \"p1\": { \"Bus\": \"b3\", \"Revenue ($/MW)\": 23.0, \"Demand (MW)\": 50.0 } } } 1.5 Transmission Lines This section describes the characteristics of transmission system, such as its topology and the susceptance of each transmission line. Key Description Default Time series? Source bus Identifier of the bus where the transmission line originates. Required N Target bus Identifier of the bus where the transmission line reaches. Required N Reactance (ohms) Reactance of the transmission line (in ohms). Required N Susceptance (S) Susceptance of the transmission line (in siemens). Required N Normal flow limit (MW) Maximum amount of power (in MW) allowed to flow through the line when the system is in its regular, fully-operational state. May be null is there is no limit. +inf Y Emergency flow limit (MW) Maximum amount of power (in MW) allowed to flow through the line when the system is in degraded state (for example, after the failure of another transmission line). +inf Y Flow limit penalty ($/MW) Penalty for violating the flow limits of the transmission line (in $/MW). This is charged per time period. For example, if there is a thermal violation of 1 MW for three time periods, three times this amount will be charged. 5000.0 Y Example { \"Transmission lines\": { \"l1\": { \"Source bus\": \"b1\", \"Target bus\": \"b2\", \"Reactance (ohms)\": 0.05917, \"Susceptance (S)\": 29.49686, \"Normal flow limit (MW)\": 15000.0, \"Emergency flow limit (MW)\": 20000.0, \"Flow limit penalty ($/MW)\": 5000.0 } } } 1.6 Reserves This section describes the hourly amount of operating reserves required. Key Description Default Time series? Spinning (MW) Minimum amount of system-wide spinning reserves (in MW). Only generators which are online may provide this reserve. 0.0 Y Example { \"Reserves\": { \"Spinning (MW)\": [ 57.30552, 53.88429, 51.31838, 50.46307 ] } } 1.7 Contingencies This section describes credible contingency scenarios in the optimization, such as the loss of a transmission line or generator. Key Description Default Affected generators List of generators affected by this contingency. May be omitted if no generators are affected. [] Affected lines List of transmission lines affected by this contingency. May be omitted if no lines are affected. [] Example { \"Contingencies\": { \"c1\": { \"Affected lines\": [\"l1\", \"l2\", \"l3\"], \"Affected generators\": [\"g1\"] }, \"c2\": { \"Affected lines\": [\"l4\"] }, } } 1.8 Additional remarks Time series parameters Many numerical properties in the JSON file can be specified either as a single floating point number if they are time-independent, or as an array containing exactly T elements, where T is the length of the planning horizon, if they are time-dependent. For example, both formats below are valid when T=3 : { \"Load (MW)\": 800.0, \"Load (MW)\": [800.0, 850.0, 730.0] } Current limitations All reserves are system-wide (no zonal reserves) Network topology remains the same for all time periods Only N-1 transmission contingencies are supported. Generator contingencies are not supported. Time-varying minimum production amounts are not currently compatible with ramp/startup/shutdown limits. 2. Output Data Format The output data format is also JSON-based, but it is not currently documented since we expect it to change significantly in a future version of the package.","title":"Format"},{"location":"format/#data-format","text":"","title":"Data Format"},{"location":"format/#1-input-data-format","text":"Instances are specified by JSON files containing the following main sections: Parameters Buses Generators Price-sensitive loads Transmission lines Reserves Contingencies Each section is described in detail below. For a complete example, see case14.json .","title":"1. Input Data Format"},{"location":"format/#11-parameters","text":"This section describes system-wide parameters, such as power balance penalties, and optimization parameters, such as the length of the planning horizon. Key Description Default Time series? Time (h) Length of the planning horizon (in hours) Required N Power balance penalty ($/MW) Penalty for system-wide shortage or surplus in production (in $/MW). This is charged per time period. For example, if there is a shortage of 1 MW for three time periods, three times this amount will be charged. 1000.0 Y","title":"1.1 Parameters"},{"location":"format/#example","text":"{ \"Parameters\": { \"Time (h)\": 4, \"Power balance penalty ($/MW)\": 1000.0 } }","title":"Example"},{"location":"format/#12-buses","text":"This section describes the characteristics of each bus in the system. Key Description Default Time series? Load (MW) Fixed load connected to the bus (in MW). Required Y","title":"1.2 Buses"},{"location":"format/#example_1","text":"{ \"Buses\": { \"b1\": { \"Load (MW)\": 0.0 }, \"b2\": { \"Load (MW)\": [ 26.01527, 24.46212, 23.29725, 22.90897 ] } } }","title":"Example"},{"location":"format/#13-generators","text":"This section describes all generators in the system, including thermal units, renewable units and virtual units. Key Description Default Time series? Bus Identifier of the bus where this generator is located (string) Required N Production cost curve (MW) and Production cost curve ($) Parameters describing the piecewise-linear production costs. See below for more details. Required Y Startup costs ($) and Startup delays (h) Parameters describing how much it costs to start the generator after it has been shut down for a certain amount of time. If Startup costs ($) and Startup delays (h) are set to [300.0, 400.0] and [1, 4] , for example, and the generator is shut down at time t , then it costs 300 to start up the generator at times t+1 , t+2 or t+3 , and 400 to start the generator at time t+4 or any time after that. The number of startup cost points is unlimited, and may be different for each generator. Startup delays must be strictly increasing. [0.0] and [1] N Minimum uptime (h) Minimum amount of time the generator must stay operational after starting up (in hours). For example, if the generator starts up at time 1 and Minimum uptime (h) is set to 4, then the generator can only shut down at time 5. 1 N Minimum downtime (h) Minimum amount of time the generator must stay offline after shutting down (in hours). For example, if the generator shuts down at time 1 and Minimum downtime (h) is set to 4, then the generator can only start producing power again at time 5. 1 N Ramp up limit (MW) Maximum increase in production from one time period to the next (in MW). For example, if the generator is producing 100 MW at time 1 and if this parameter is set to 40 MW, then the generator will produce at most 140 MW at time 2. +inf N Ramp down limit (MW) Maximum decrease in production from one time period to the next (in MW). For example, if the generator is producing 100 MW at time 1 and this parameter is set to 40 MW, then the generator will produce at least 60 MW at time 2. +inf N Startup limit (MW) Maximum amount of power a generator can produce immediately after starting up (in MW). +inf N Shutdown limit (MW) Maximum amount of power a generator can produce immediately before shutting down (in MW). Specifically, the generator can only shut down at time t+1 if its production at time t is below this limit. +inf N Initial status (h) If set to a positive number, indicates the amount of time the generator has been on at the beginning of the simulation, and if set to a negative number, the amount of time the generator has been off. For example, if Initial status (h) is -2 , this means that the generator was off at simulation time -2 and -1 . The simulation starts at time 0 . Required N Initial power (MW) Amount of power the generator at time period -1 , immediately before the planning horizon starts. Required N Must run? If true , the generator should be committed, even that is not economical (Boolean). false Y Provides spinning reserves? If true , this generator may provide spinning reserves (Boolean). true Y","title":"1.3 Generators"},{"location":"format/#production-costs-and-limits","text":"Production costs are represented as piecewise-linear curves. Figure 1 shows an example cost curve with three segments, where it costs 1400, 1600, 2200 and 2400 dollars to generate, respectively, 100, 110, 130 and 135 MW of power. To model this generator, Production cost curve (MW) should be set to [100, 110, 130, 135] , and Production cost curve ($) should be set to [1400, 1600, 2200, 2400] . Note that this curve also specifies the production limits. Specifically, the first point identifies the minimum power output when the unit is operational, while the last point identifies the maximum power output. Figure 1. Piecewise-linear production cost curve.","title":"Production costs and limits"},{"location":"format/#additional-remarks","text":"For time-dependent production limits or time-dependent production costs, the usage of nested arrays is allowed. For example, if Production cost curve (MW) is set to [5.0, [10.0, 12.0, 15.0, 20.0]] , then the unit may generate at most 10, 12, 15 and 20 MW of power during time periods 1, 2, 3 and 4, respectively. The minimum output for all time periods is fixed to at 5 MW. There is no limit to the number of piecewise-linear segments, and different generators may have a different number of segments. If Production cost curve (MW) and Production cost curve ($) both contain a single element, then the generator must produce exactly that amount of power when operational. To specify that the generator may produce any amount of power up to a certain limit P , the parameter Production cost curve (MW) should be set to [0, P] . Production cost curves must be convex.","title":"Additional remarks:"},{"location":"format/#example_2","text":"{ \"Generators\": { \"gen1\": { \"Bus\": \"b1\", \"Production cost curve (MW)\": [100.0, 110.0, 130.0, 135.0], \"Production cost curve ($)\": [1400.0, 1600.0, 2200.0, 2400.0], \"Startup costs ($)\": [300.0, 400.0], \"Startup delays (h)\": [1, 4], \"Ramp up limit (MW)\": 232.68, \"Ramp down limit (MW)\": 232.68, \"Startup limit (MW)\": 232.68, \"Shutdown limit (MW)\": 232.68, \"Minimum downtime (h)\": 4, \"Minimum uptime (h)\": 4, \"Initial status (h)\": 12, \"Must run?\": false, \"Provides spinning reserves?\": true, }, \"gen2\": { \"Bus\": \"b5\", \"Production cost curve (MW)\": [0.0, [10.0, 8.0, 0.0, 3.0]], \"Production cost curve ($)\": [0.0, 0.0], \"Provides spinning reserves?\": true, } } }","title":"Example"},{"location":"format/#14-price-sensitive-loads","text":"This section describes components in the system which may increase or reduce their energy consumption according to the energy prices. Fixed loads (as described in the buses section) are always served, regardless of the price, unless there is significant congestion in the system or insufficient production capacity. Price-sensitive loads, on the other hand, are only served if it is economical to do so. Key Description Default Time series? Bus Bus where the load is located. Multiple price-sensitive loads may be placed at the same bus. Required N Revenue ($/MW) Revenue obtained for serving each MW of power to this load. Required Y Demand (MW) Maximum amount of power required by this load. Any amount lower than this may be served. Required Y","title":"1.4 Price-sensitive loads"},{"location":"format/#example_3","text":"{ \"Price-sensitive loads\": { \"p1\": { \"Bus\": \"b3\", \"Revenue ($/MW)\": 23.0, \"Demand (MW)\": 50.0 } } }","title":"Example"},{"location":"format/#15-transmission-lines","text":"This section describes the characteristics of transmission system, such as its topology and the susceptance of each transmission line. Key Description Default Time series? Source bus Identifier of the bus where the transmission line originates. Required N Target bus Identifier of the bus where the transmission line reaches. Required N Reactance (ohms) Reactance of the transmission line (in ohms). Required N Susceptance (S) Susceptance of the transmission line (in siemens). Required N Normal flow limit (MW) Maximum amount of power (in MW) allowed to flow through the line when the system is in its regular, fully-operational state. May be null is there is no limit. +inf Y Emergency flow limit (MW) Maximum amount of power (in MW) allowed to flow through the line when the system is in degraded state (for example, after the failure of another transmission line). +inf Y Flow limit penalty ($/MW) Penalty for violating the flow limits of the transmission line (in $/MW). This is charged per time period. For example, if there is a thermal violation of 1 MW for three time periods, three times this amount will be charged. 5000.0 Y","title":"1.5 Transmission Lines"},{"location":"format/#example_4","text":"{ \"Transmission lines\": { \"l1\": { \"Source bus\": \"b1\", \"Target bus\": \"b2\", \"Reactance (ohms)\": 0.05917, \"Susceptance (S)\": 29.49686, \"Normal flow limit (MW)\": 15000.0, \"Emergency flow limit (MW)\": 20000.0, \"Flow limit penalty ($/MW)\": 5000.0 } } }","title":"Example"},{"location":"format/#16-reserves","text":"This section describes the hourly amount of operating reserves required. Key Description Default Time series? Spinning (MW) Minimum amount of system-wide spinning reserves (in MW). Only generators which are online may provide this reserve. 0.0 Y","title":"1.6 Reserves"},{"location":"format/#example_5","text":"{ \"Reserves\": { \"Spinning (MW)\": [ 57.30552, 53.88429, 51.31838, 50.46307 ] } }","title":"Example"},{"location":"format/#17-contingencies","text":"This section describes credible contingency scenarios in the optimization, such as the loss of a transmission line or generator. Key Description Default Affected generators List of generators affected by this contingency. May be omitted if no generators are affected. [] Affected lines List of transmission lines affected by this contingency. May be omitted if no lines are affected. []","title":"1.7 Contingencies"},{"location":"format/#example_6","text":"{ \"Contingencies\": { \"c1\": { \"Affected lines\": [\"l1\", \"l2\", \"l3\"], \"Affected generators\": [\"g1\"] }, \"c2\": { \"Affected lines\": [\"l4\"] }, } }","title":"Example"},{"location":"format/#18-additional-remarks","text":"","title":"1.8 Additional remarks"},{"location":"format/#time-series-parameters","text":"Many numerical properties in the JSON file can be specified either as a single floating point number if they are time-independent, or as an array containing exactly T elements, where T is the length of the planning horizon, if they are time-dependent. For example, both formats below are valid when T=3 : { \"Load (MW)\": 800.0, \"Load (MW)\": [800.0, 850.0, 730.0] }","title":"Time series parameters"},{"location":"format/#current-limitations","text":"All reserves are system-wide (no zonal reserves) Network topology remains the same for all time periods Only N-1 transmission contingencies are supported. Generator contingencies are not supported. Time-varying minimum production amounts are not currently compatible with ramp/startup/shutdown limits.","title":"Current limitations"},{"location":"format/#2-output-data-format","text":"The output data format is also JSON-based, but it is not currently documented since we expect it to change significantly in a future version of the package.","title":"2. Output Data Format"},{"location":"usage/","text":"Usage 1. Installation UnitCommitment.jl was tested and developed with Julia 1.5 . To install Julia, please follow the installation guide on the official Julia website . To install UnitCommitment.jl, run the Julia interpreter, type ] to open the package manager, then type: pkg> add https://github.com/ANL-CEEESA/UnitCommitment.jl.git To test that the package has been correctly installed, run: pkg> test UnitCommitment If all tests pass, the package should now be ready to be used by any Julia script on the machine. To solve the optimization models, a mixed-integer linear programming (MILP) solver is also required. Please see the JuMP installation guide for more instructions on installing a solver. Typical open-source choices are Cbc and GLPK . In the instructions below, Cbc will be used, but any other MILP solver listed in JuMP installation guide should also be compatible. 2. Typical Usage 2.1 Solving user-provided instances The first step to use UC.jl is to construct a JSON file describing your unit commitment instance. See the data format page for a complete description of the data format UC.jl expects. The next steps, as shown below, are to read the instance from file, construct the optimization model, run the optimization and extract the optimal solution. using Cbc using UnitCommitment # Read instance instance = UnitCommitment.read(\"/path/to/input.json\") # Construct optimization model model = UnitCommitment.build_model(instance, Cbc.Optimizer) # Solve model UnitCommitment.optimize!(model) # Extract solution and write it to a file solution = UnitCommitment.get_solution(model) open(\"/path/to/output.json\", \"w\") do file JSON.print(file, solution, 2) end 2.2 Solving benchmark instances As described in the instances page , UnitCommitment.jl contains a number of benchmark instances collected from the literature. To solve one of these instances individually, instead of constructing your own, the function read_benchmark can be used: using UnitCommitment instance = UnitCommitment.read_benchmark(\"matpower/case3375wp/2017-01-01\") 3. Advanced usage 3.1 Modifying the formulation For the time being, the recommended way of modifying the MILP formulation used by UC.jl is to create a local copy of our git repository and directly modify the source code of the package. In a future version, it will be possible to switch between multiple formulations, or to simply add/remove constraints after the model has been generated. 3.2 Generating initial conditions When creating random unit commitment instances for benchmark purposes, it is often hard to compute, in advance, sensible initial conditions for all generators. Setting initial conditions naively (for example, making all generators initially off and producing no power) can easily cause the instance to become infeasible due to excessive ramping. Initial conditions can also make it hard to modify existing instances. For example, increasing the system load without carefully modifying the initial conditions may make the problem infeasible or unrealistically challenging to solve. To help with this issue, UC.jl provides a utility function which can generate feasible initial conditions by solving a single-period optimization problem, as shown below: using Cbc using UnitCommitment # Read original instance instance = UnitCommitment.read(\"instance.json\") # Generate initial conditions (in-place) UnitCommitment.generate_initial_conditions!(instance, Cbc.Optimizer) # Construct and solve optimization model model = UnitCommitment.build_model(instance, Cbc.Optimizer) UnitCommitment.optimize!(model) Warning The function generate_initial_conditions! may return different initial conditions after each call, even if the same instance and the same optimizer is provided. The particular algorithm may also change in a future version of UC.jl. For these reasons, it is recommended that you generate initial conditions exactly once for each instance and store them for later use. 3.3 Verifying solutions When developing new formulations, it is very easy to introduce subtle errors in the model that result in incorrect solutions. To help with this, UC.jl includes a utility function that verifies if a given solution is feasible, and, if not, prints all the validation errors it found. The implementation of this function is completely independent from the implementation of the optimization model, and therefore can be used to validate it. The function can also be used to verify solutions produced by other optimization packages, as long as they follow the UC.jl data format . using JSON using UnitCommitment # Read instance instance = UnitCommitment.read(\"instance.json\") # Read solution (potentially produced by other packages) solution = JSON.parsefile(\"solution.json\") # Validate solution and print validation errors UnitCommitment.validate(instance, solution)","title":"Usage"},{"location":"usage/#usage","text":"","title":"Usage"},{"location":"usage/#1-installation","text":"UnitCommitment.jl was tested and developed with Julia 1.5 . To install Julia, please follow the installation guide on the official Julia website . To install UnitCommitment.jl, run the Julia interpreter, type ] to open the package manager, then type: pkg> add https://github.com/ANL-CEEESA/UnitCommitment.jl.git To test that the package has been correctly installed, run: pkg> test UnitCommitment If all tests pass, the package should now be ready to be used by any Julia script on the machine. To solve the optimization models, a mixed-integer linear programming (MILP) solver is also required. Please see the JuMP installation guide for more instructions on installing a solver. Typical open-source choices are Cbc and GLPK . In the instructions below, Cbc will be used, but any other MILP solver listed in JuMP installation guide should also be compatible.","title":"1. Installation"},{"location":"usage/#2-typical-usage","text":"","title":"2. Typical Usage"},{"location":"usage/#21-solving-user-provided-instances","text":"The first step to use UC.jl is to construct a JSON file describing your unit commitment instance. See the data format page for a complete description of the data format UC.jl expects. The next steps, as shown below, are to read the instance from file, construct the optimization model, run the optimization and extract the optimal solution. using Cbc using UnitCommitment # Read instance instance = UnitCommitment.read(\"/path/to/input.json\") # Construct optimization model model = UnitCommitment.build_model(instance, Cbc.Optimizer) # Solve model UnitCommitment.optimize!(model) # Extract solution and write it to a file solution = UnitCommitment.get_solution(model) open(\"/path/to/output.json\", \"w\") do file JSON.print(file, solution, 2) end","title":"2.1 Solving user-provided instances"},{"location":"usage/#22-solving-benchmark-instances","text":"As described in the instances page , UnitCommitment.jl contains a number of benchmark instances collected from the literature. To solve one of these instances individually, instead of constructing your own, the function read_benchmark can be used: using UnitCommitment instance = UnitCommitment.read_benchmark(\"matpower/case3375wp/2017-01-01\")","title":"2.2 Solving benchmark instances"},{"location":"usage/#3-advanced-usage","text":"","title":"3. Advanced usage"},{"location":"usage/#31-modifying-the-formulation","text":"For the time being, the recommended way of modifying the MILP formulation used by UC.jl is to create a local copy of our git repository and directly modify the source code of the package. In a future version, it will be possible to switch between multiple formulations, or to simply add/remove constraints after the model has been generated.","title":"3.1 Modifying the formulation"},{"location":"usage/#32-generating-initial-conditions","text":"When creating random unit commitment instances for benchmark purposes, it is often hard to compute, in advance, sensible initial conditions for all generators. Setting initial conditions naively (for example, making all generators initially off and producing no power) can easily cause the instance to become infeasible due to excessive ramping. Initial conditions can also make it hard to modify existing instances. For example, increasing the system load without carefully modifying the initial conditions may make the problem infeasible or unrealistically challenging to solve. To help with this issue, UC.jl provides a utility function which can generate feasible initial conditions by solving a single-period optimization problem, as shown below: using Cbc using UnitCommitment # Read original instance instance = UnitCommitment.read(\"instance.json\") # Generate initial conditions (in-place) UnitCommitment.generate_initial_conditions!(instance, Cbc.Optimizer) # Construct and solve optimization model model = UnitCommitment.build_model(instance, Cbc.Optimizer) UnitCommitment.optimize!(model) Warning The function generate_initial_conditions! may return different initial conditions after each call, even if the same instance and the same optimizer is provided. The particular algorithm may also change in a future version of UC.jl. For these reasons, it is recommended that you generate initial conditions exactly once for each instance and store them for later use.","title":"3.2 Generating initial conditions"},{"location":"usage/#33-verifying-solutions","text":"When developing new formulations, it is very easy to introduce subtle errors in the model that result in incorrect solutions. To help with this, UC.jl includes a utility function that verifies if a given solution is feasible, and, if not, prints all the validation errors it found. The implementation of this function is completely independent from the implementation of the optimization model, and therefore can be used to validate it. The function can also be used to verify solutions produced by other optimization packages, as long as they follow the UC.jl data format . using JSON using UnitCommitment # Read instance instance = UnitCommitment.read(\"instance.json\") # Read solution (potentially produced by other packages) solution = JSON.parsefile(\"solution.json\") # Validate solution and print validation errors UnitCommitment.validate(instance, solution)","title":"3.3 Verifying solutions"}]}