GenXProject / GenX.jl

GenX: a configurable power system capacity expansion model for studying low-carbon energy futures. More details at : https://genx.mit.edu
https://genxproject.github.io/GenX.jl/
GNU General Public License v2.0
269 stars 114 forks source link

[Bug]: Model Settings Parameters Documentation #701

Closed nd8696 closed 3 months ago

nd8696 commented 4 months ago

Bug description

The documentation of model settings looks incomplete -- there are ~10+ model settings for which there's no documentation. Not sure if that's fully intentional, but examples are OverwriteResults, DC_OPF, ...

The model settings documentation page is here. Below is the default_settings code block from configure_settings.jl -- a full list of available settings.

function default_settings()
    Dict{Any, Any}("PrintModel" => 0,
        "OverwriteResults" => 0,
        "NetworkExpansion" => 0,
        "Trans_Loss_Segments" => 1,
        "OperationalReserves" => 0,
        "EnergyShareRequirement" => 0,
        "CapacityReserveMargin" => 0,
        "CO2Cap" => 0,
        "StorageLosses" => 1,
        "VirtualChargeDischargeCost" => 1,  # $/MWh
        "MinCapReq" => 0,
        "MaxCapReq" => 0,
        "ParameterScale" => 0,
        "WriteShadowPrices" => 0,
        "UCommit" => 0,
        "TimeDomainReduction" => 0,
        "TimeDomainReductionFolder" => "TDR_results",
        "ModelingToGenerateAlternatives" => 0,
        "ModelingtoGenerateAlternativeSlack" => 0.1,
        "MGAAnnualGeneration" => 0,
        "MultiStage" => 0,
        "MethodofMorris" => 0,
        "IncludeLossesInESR" => 0,
        "EnableJuMPStringNames" => false,
        "HydrogenHourlyMatching" => 0,
        "DC_OPF" => 0,
        "WriteOutputs" => "full",
        "ComputeConflicts" => 0,
        "StorageVirtualDischarge" => 1,
        "ResourcesFolder" => "resources",
        "ResourcePoliciesFolder" => "policy_assignments",
        "SystemFolder" => "system",
        "PoliciesFolder" => "policies",
        "ObjScale" => 1)
end

Environment and Version

GenX0.4.0

Relevant error messages

No response

Additional context

No response

sambuddhac commented 3 months ago

PR #721 has resolved this issue on develop