pygcam
v1.10.1
What is pygcam?
Installation
Initializing the configuration file
Configuration System
Tutorial
GCAM tool (
gt
)
GCAM XML-Setup
Graphical User Interface
XML File Formats
Conditional XML
pygcam Python API
Monte Carlo Simulation support
Using pygcam on PIC
pygcam
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
absPath() (pygcam.xmlEditor.XMLEditor method)
activeYears() (in module pygcam.mcs.util)
add() (pygcam.xmlEditor.XMLEditor method)
addArgs() (pygcam.subcommand.SubcommandABC method)
addConfigElement() (pygcam.mcs.XMLConfigFile.XMLConfigFile method)
addMarketConstraint() (pygcam.xmlEditor.XMLEditor method)
addScenarioComponent() (pygcam.xmlEditor.XMLEditor method)
adjustForestResidueSupply() (pygcam.sectorEditors.BioenergyEditor method)
adjustResidueSupply() (pygcam.sectorEditors.BioenergyEditor method)
analyzeSimulation() (in module pygcam.mcs.analysis)
analyzeSimulationNew() (in module pygcam.mcs.analysis)
applyTrial() (pygcam.mcs.XMLParameterFile.XMLParameter class method)
B
BaseSpecError
beforeSavingRun() (in module pygcam.mcs.Database)
BioenergyEditor (class in pygcam.sectorEditors)
buildingElectrification() (pygcam.xmlEditor.XMLEditor method)
buildingTechEfficiency() (pygcam.xmlEditor.XMLEditor method)
C
cached() (in module pygcam.mcs.explorer)
callFileFunctions() (pygcam.mcs.XMLParameterFile.XMLInputFile method)
canonicalizeRegion() (in module pygcam.mcs.Database)
cfgPath() (pygcam.xmlEditor.XMLEditor method)
chartGCAM() (in module pygcam.chart)
chunkify() (in module pygcam.utils)
Code (class in pygcam.mcs.schema)
coercible() (in module pygcam.utils)
collectResults() (in module pygcam.mcs.XMLResultFile)
CommandlineError
computeDifference() (in module pygcam.diff)
ConfigFileError
configureLogs() (in module pygcam.log)
constant (class in pygcam.mcs.distro)
convert() (pygcam.units.UnitNamespace method)
copyFileOrTree() (in module pygcam.utils)
copyfiles() (in module pygcam.mcs.util)
copyIfMissing() (in module pygcam.xmlEditor)
copyOriginal() (pygcam.mcs.XMLConfigFile.XMLConfigFile method)
copyResource() (in module pygcam.utils)
copyWorkspace() (in module pygcam.scenarioSetup)
corrMatrix() (pygcam.mcs.XMLParameterFile.XMLCorrelation class method)
createBatchFile() (in module pygcam.query)
createCorrelations() (pygcam.mcs.XMLParameterFile.XMLCorrelation class method)
createProtected() (in module pygcam.landProtection)
createSandbox() (in module pygcam.scenarioSetup)
createTrialString() (in module pygcam.utils)
csv2xlsx() (in module pygcam.query)
csvPathname() (pygcam.mcs.XMLResultFile.XMLResult method)
D
decache() (in module pygcam.mcs.XMLParameterFile)
deleteConfigElement() (pygcam.mcs.XMLConfigFile.XMLConfigFile method)
deleteFile() (in module pygcam.utils)
deleteScenarioComponent() (pygcam.xmlEditor.XMLEditor method)
delMarketConstraint() (pygcam.xmlEditor.XMLEditor method)
Delta (class in pygcam.mcs.sensitivity)
DGSM (class in pygcam.mcs.sensitivity)
diffCsvPathname() (in module pygcam.diff)
digitColumns() (in module pygcam.utils)
dirFromNumber() (in module pygcam.mcs.util)
DistributionSpecError
DistroGen (class in pygcam.mcs.distro)
dropExtraCols() (in module pygcam.query)
E
ensureCSV() (in module pygcam.utils)
ensureExtension() (in module pygcam.utils)
evaluateVars() (pygcam.project.Variable class method)
expandYearRanges() (in module pygcam.xmlEditor)
Experiment (class in pygcam.mcs.schema)
extractStubTechnology() (in module pygcam.xmlEditor)
F
FAST (class in pygcam.mcs.sensitivity)
filecopy() (in module pygcam.mcs.util)
FileExistsError
,
[1]
FileFormatError
FileMissingError
,
[1]
fileReader() (in module pygcam.mcs.util)
findAndSave() (in module pygcam.mcs.XML)
findParamData() (in module pygcam.mcs.util)
flatten() (in module pygcam.utils)
freezeRegionPopulation() (pygcam.xmlEditor.XMLEditor method)
G
GcamError
GcamSolverError
GcamToolError
genCarbonTax() (in module pygcam.carbonTax)
genCarbonTaxFile() (in module pygcam.carbonTax)
genDistros() (pygcam.mcs.distro.DistroGen class method)
generateDropdownDefaults() (in module pygcam.mcs.explorer)
generateRandomVars() (pygcam.mcs.XMLParameterFile.XMLInputFile method)
genLinkedBioCarbonPolicyFile() (in module pygcam.carbonTax)
get() (pygcam.units.UnitNamespace method)
get_path() (in module pygcam.utils)
getApply() (pygcam.mcs.XMLParameterFile.XMLTrialData method)
getBatchDir() (in module pygcam.utils)
getBooleanXML() (in module pygcam.mcs.XML)
(in module pygcam.utils)
getComponentName() (pygcam.mcs.XMLParameterFile.XMLInputFile method)
getConfig() (in module pygcam.config)
getConfigDict() (in module pygcam.config)
getConfigElement() (pygcam.mcs.XMLConfigFile.XMLConfigFile method)
getConfigForScenario() (pygcam.mcs.XMLConfigFile.XMLConfigFile class method)
getCorrDF() (in module pygcam.mcs.analysis)
getData() (pygcam.mcs.XMLParameterFile.XMLDataFile class method)
getDatabase() (in module pygcam.mcs.Database)
getFilename() (pygcam.mcs.XMLParameterFile.XMLParameterFile method)
(pygcam.XMLFile.XMLFile method)
getGcamVersion() (in module pygcam.gcam)
getInstance() (pygcam.mcs.XMLParameterFile.XMLParameter class method)
getInstances() (pygcam.mcs.XMLParameterFile.XMLParameter class method)
getKnownGroups() (pygcam.project.Project method)
getKnownScenarios() (pygcam.project.Project method)
getKnownSteps() (pygcam.project.Project method)
getLocalCopy() (pygcam.xmlEditor.XMLEditor method)
getLogger() (in module pygcam.log)
getMode() (pygcam.mcs.XMLParameterFile.XMLTrialData method)
getOptionalArgs() (in module pygcam.mcs.util)
getParam() (in module pygcam.config)
getParamAsBoolean() (in module pygcam.config)
getParamAsFloat() (in module pygcam.config)
getParamAsInt() (in module pygcam.config)
getRegionList() (in module pygcam.utils)
getResource() (in module pygcam.utils)
getResultDefs() (pygcam.mcs.XMLResultFile.XMLResultFile method)
getRoot() (pygcam.XMLFile.XMLFile method)
getRunQueryDir() (in module pygcam.mcs.util)
getSimConfigFile() (in module pygcam.mcs.XMLConfigFile)
getSimLocalXmlDir() (in module pygcam.mcs.util)
getSimParameterFile() (in module pygcam.mcs.util)
getSimResultFile() (in module pygcam.mcs.util)
getSimScenarioFile() (in module pygcam.mcs.util)
getSimXmlFile() (in module pygcam.mcs.util)
getTree() (pygcam.XMLFile.XMLFile method)
getUnits() (in module pygcam.units)
getYearCols() (in module pygcam.utils)
GridRV (class in pygcam.mcs.distro)
I
importFrom() (in module pygcam.utils)
importFromDotSpec() (in module pygcam.utils)
industryTechEfficiency() (pygcam.xmlEditor.XMLEditor method)
Input (class in pygcam.mcs.schema)
insertScenarioComponent() (pygcam.xmlEditor.XMLEditor method)
insertStubTechParameter() (pygcam.xmlEditor.XMLEditor method)
insertStubTechRetirement() (pygcam.xmlEditor.XMLEditor method)
insertSubsectorParameter() (pygcam.xmlEditor.XMLEditor method)
interpolateYears() (in module pygcam.query)
InValue (class in pygcam.mcs.schema)
IpyparallelError
is_abspath() (in module pygcam.utils)
L
LandProtection (class in pygcam.landProtection)
LatinSampler (class in pygcam.mcs.sensitivity)
limitYears() (in module pygcam.query)
loadFiles() (pygcam.mcs.XMLParameterFile.XMLInputFile method)
loadInputFiles() (pygcam.mcs.XMLParameterFile.XMLParameterFile method)
loadModuleFromPath() (in module pygcam.mcs.util)
(in module pygcam.utils)
loadObjectFromPath() (in module pygcam.mcs.util)
loadResults() (pygcam.mcs.sensitivity.SensitivityAnalysis method)
localizeCellEthanolTechnologyUSA() (pygcam.sectorEditors.BioenergyEditor method)
localizeCornEthanolTechnologyUSA() (pygcam.sectorEditors.BioenergyEditor method)
localizeFtBiofuelsTechnologyUSA() (pygcam.sectorEditors.BioenergyEditor method)
lognormalRv() (in module pygcam.mcs.distro)
lognormalRvFor95th() (in module pygcam.mcs.distro)
lognormalRvForNormal() (in module pygcam.mcs.distro)
M
makeDirPath() (in module pygcam.xmlEditor)
makeDistroKey() (in module pygcam.mcs.distro)
makeRV() (pygcam.mcs.distro.DistroGen method)
makeScenarioComponentsUnique() (pygcam.xmlEditor.XMLEditor method)
maybeListProjectArgs() (pygcam.project.Project method)
McsValues (class in pygcam.XMLFile)
mergeParameters() (pygcam.mcs.XMLParameterFile.XMLInputFile method)
mkdirs() (in module pygcam.utils)
MonteCarlo (class in pygcam.mcs.sensitivity)
Morris (class in pygcam.mcs.sensitivity)
multiply() (pygcam.xmlEditor.XMLEditor method)
N
normalizeDF() (in module pygcam.mcs.analysis)
normalizeSeries() (in module pygcam.mcs.analysis)
O
Output (class in pygcam.mcs.schema)
OutValue (class in pygcam.mcs.schema)
P
ParseCommaList (class in pygcam.utils)
parseDistroKey() (in module pygcam.mcs.distro)
parseLevels() (in module pygcam.log)
parseScenarioString() (pygcam.mcs.XMLResultFile.QueryResult static method)
parseSqlScript() (in module pygcam.mcs.Database)
parseTrialString() (in module pygcam.mcs.util)
(in module pygcam.utils)
pidFileExists() (in module pygcam.mcs.master)
plotConvergence() (in module pygcam.mcs.analysis)
plotGroupSensitivityResults() (in module pygcam.mcs.analysis)
plotInputDistributions() (in module pygcam.mcs.analysis)
plotSensitivityResults() (in module pygcam.mcs.analysis)
plotStackedBarsScalar() (in module pygcam.chart)
plotTornado() (in module pygcam.mcs.analysis)
plotUnstackedRegionComparison() (in module pygcam.chart)
ppf() (pygcam.mcs.distro.GridRV method)
(pygcam.mcs.XMLParameterFile.XMLDataFile method)
(pygcam.mcs.XMLParameterFile.XMLDistribution method)
(pygcam.mcs.XMLParameterFile.XMLPythonFunc method)
(pygcam.mcs.XMLParameterFile.XMLRandomVar method)
predictN() (pygcam.mcs.sensitivity.SensitivityAnalysis method)
printExtraText() (in module pygcam.mcs.analysis)
printSeries() (in module pygcam.utils)
Program (class in pygcam.mcs.schema)
ProgramExecutionError
Project (class in pygcam.project)
protectionScenario() (pygcam.xmlEditor.XMLEditor method)
protectLand() (in module pygcam.landProtection)
(pygcam.landProtection.LandProtection method)
(pygcam.xmlEditor.XMLEditor method)
protectLandTree() (in module pygcam.landProtection)
(pygcam.landProtection.LandProtection method)
purposeGrownOffInRegion() (pygcam.sectorEditors.BioenergyEditor method)
pushd() (in module pygcam.utils)
pygcam.carbonTax (module)
pygcam.chart (module)
pygcam.config (module)
pygcam.diff (module)
pygcam.error (module)
pygcam.gcam (module)
pygcam.landProtection (module)
pygcam.log (module)
pygcam.mcs.analysis (module)
pygcam.mcs.Database (module)
pygcam.mcs.distro (module)
pygcam.mcs.error (module)
pygcam.mcs.explorer (module)
pygcam.mcs.master (module)
pygcam.mcs.schema (module)
pygcam.mcs.sensitivity (module)
pygcam.mcs.util (module)
pygcam.mcs.worker (module)
pygcam.mcs.XML (module)
pygcam.mcs.XMLConfigFile (module)
pygcam.mcs.XMLParameterFile (module)
pygcam.mcs.XMLResultFile (module)
pygcam.project (module)
pygcam.query (module)
pygcam.scenarioSetup (module)
pygcam.sectorEditors (module)
pygcam.subcommand (module)
pygcam.units (module)
pygcam.utils (module)
pygcam.xmlEditor (module)
pygcam.XMLFile (module)
PygcamException
PygcamMcsException
PygcamMcsSystemError
PygcamMcsUserError
Q
Queries (class in pygcam.project)
queryCsvPathname() (in module pygcam.diff)
QueryResult (class in pygcam.mcs.XMLResultFile)
queueForStream() (in module pygcam.utils)
R
read() (pygcam.XMLFile.XMLFile method)
readConfigFiles() (in module pygcam.config)
readCsv() (in module pygcam.query)
readCSV() (pygcam.mcs.XMLResultFile.QueryResult method)
readQueryResult() (in module pygcam.query)
readRegionMap() (in module pygcam.query)
readScenarioName() (in module pygcam.utils)
readTrialDataFile() (in module pygcam.mcs.util)
Region (class in pygcam.mcs.schema)
regions() (pygcam.XMLFile.McsValues method)
removeFileOrTree() (in module pygcam.utils)
renameScenarioComponent() (pygcam.xmlEditor.XMLEditor method)
replaceValue() (pygcam.xmlEditor.XMLEditor method)
resourceStream() (in module pygcam.utils)
Run (class in pygcam.mcs.schema)
run() (pygcam.project.Project method)
(pygcam.subcommand.SubcommandABC method)
runBatchQuery() (in module pygcam.query)
runGCAM() (in module pygcam.gcam)
runModelInterface() (in module pygcam.query)
runMultiQueryBatch() (in module pygcam.query)
runProtectionScenario() (in module pygcam.landProtection)
runQueries() (pygcam.mcs.XMLParameterFile.XMLInputFile method)
runQuery() (pygcam.mcs.XMLParameterFile.XMLParameter method)
(pygcam.mcs.XMLParameterFile.XMLQuery method)
runTrial() (in module pygcam.mcs.worker)
(pygcam.mcs.worker.Worker method)
S
SAException
saveForEMA() (in module pygcam.mcs.analysis)
saveOutputDefs() (pygcam.mcs.XMLResultFile.XMLResultFile method)
savePathMap() (in module pygcam.config)
saveResults() (in module pygcam.mcs.XMLResultFile)
saveToFile() (in module pygcam.utils)
SensitivityAnalysis (class in pygcam.mcs.sensitivity)
sequence (class in pygcam.mcs.distro)
setBiofuelBiomassCoefficients() (pygcam.sectorEditors.BioenergyEditor method)
setCellEthanolShareWeightUSA() (pygcam.sectorEditors.BioenergyEditor method)
setClimateOutputInterval() (pygcam.xmlEditor.XMLEditor method)
setConfigValue() (pygcam.xmlEditor.XMLEditor method)
setCornEthanolCoefficients() (pygcam.sectorEditors.BioenergyEditor method)
setCornEthanolCoefficientsUSA() (pygcam.sectorEditors.BioenergyEditor method)
setEnergyTechnologyCoefficients() (pygcam.xmlEditor.XMLEditor method)
setGlobalTechNonEnergyCost() (pygcam.xmlEditor.XMLEditor method)
setGlobalTechShareWeight() (pygcam.xmlEditor.XMLEditor method)
setGlobalTechShutdownRate() (pygcam.xmlEditor.XMLEditor method)
setInputFilesByVersion() (in module pygcam.config)
setInterpolationFunction() (pygcam.xmlEditor.XMLEditor method)
setJavaPath() (in module pygcam.gcam)
setLogLevels() (in module pygcam.log)
setMacJavaVars() (in module pygcam.config)
setParam() (in module pygcam.config)
setPriceElasticity() (pygcam.xmlEditor.XMLEditor method)
setRegionalNonCO2Emissions() (pygcam.xmlEditor.XMLEditor method)
setRegionalShareWeights() (pygcam.xmlEditor.XMLEditor method)
setRegionPopulation() (pygcam.xmlEditor.XMLEditor method)
setSection() (in module pygcam.config)
setStopPeriod() (pygcam.xmlEditor.XMLEditor method)
setup() (pygcam.xmlEditor.XMLEditor method)
setupDynamic() (pygcam.xmlEditor.XMLEditor method)
SetupException
setupSolver() (pygcam.xmlEditor.XMLEditor method)
setupStatic() (pygcam.xmlEditor.XMLEditor method)
setValue() (pygcam.mcs.XMLParameterFile.XMLVariable method)
shellCommand() (in module pygcam.utils)
ShellCommandError
signature() (pygcam.mcs.distro.DistroGen class method)
Sim (class in pygcam.mcs.schema)
simpleFormat() (in module pygcam.utils)
SimpleVariable (class in pygcam.project)
Sobol (class in pygcam.mcs.sensitivity)
sortScenarios() (pygcam.project.Project method)
spearmanCorrelation() (in module pygcam.mcs.analysis)
sqlite_FK_pragma() (in module pygcam.mcs.Database)
startCluster() (in module pygcam.mcs.master)
startEngines() (in module pygcam.mcs.master)
storeFloatValue() (pygcam.mcs.XMLParameterFile.XMLVariable method)
stringMatch() (pygcam.mcs.XMLResultFile.XMLResult method)
stringReplace() (pygcam.xmlEditor.XMLEditor method)
stripYearPrefix() (in module pygcam.mcs.util)
SubcommandABC (class in pygcam.subcommand)
sumYears() (in module pygcam.query)
sumYearsByGroup() (in module pygcam.query)
symlinkOrCopyFile() (in module pygcam.utils)
systemOpenFile() (in module pygcam.utils)
T
tail() (in module pygcam.mcs.util)
taxBioCarbon() (pygcam.xmlEditor.XMLEditor method)
taxCarbon() (pygcam.xmlEditor.XMLEditor method)
TimeSeries (class in pygcam.mcs.schema)
trialRelativePath() (in module pygcam.mcs.XMLParameterFile)
U
UnitNamespace (class in pygcam.units)
unixPath() (in module pygcam.config)
unProtectLand() (in module pygcam.landProtection)
updateConfigComponent() (pygcam.xmlEditor.XMLEditor method)
updateConfigElement() (pygcam.mcs.XMLConfigFile.XMLConfigFile method)
updateElements() (pygcam.mcs.XMLParameterFile.XMLParameter method)
updateScenarioComponent() (pygcam.xmlEditor.XMLEditor method)
usingMCS() (in module pygcam.config)
usingPostgres() (in module pygcam.mcs.Database)
usingSqlite() (in module pygcam.mcs.Database)
V
validate() (pygcam.XMLFile.XMLFile method)
validateProjectArgs() (pygcam.project.Project method)
values() (pygcam.XMLFile.McsValues method)
Variable (class in pygcam.project)
W
Worker (class in pygcam.mcs.worker)
WorkerResult (class in pygcam.mcs.worker)
write() (pygcam.mcs.XMLConfigFile.XMLConfigFile method)
writeAll() (pygcam.mcs.XMLConfigFile.XMLConfigFile class method)
writeCsv() (in module pygcam.query)
writeDiffsToCSV() (in module pygcam.diff)
writeDiffsToFile() (in module pygcam.diff)
writeDiffsToXLSX() (in module pygcam.diff)
writeLocalXmlFiles() (pygcam.mcs.XMLParameterFile.XMLParameterFile method)
writeSystemDefaultsFile() (in module pygcam.config)
writeTrialDataFile() (in module pygcam.mcs.util)
writeXmldbDriverProperties() (in module pygcam.utils)
X
XMLColumn (class in pygcam.mcs.XMLResultFile)
XMLConfigFile (class in pygcam.mcs.XMLConfigFile)
XMLConstraint (class in pygcam.mcs.XMLResultFile)
XMLCorrelation (class in pygcam.mcs.XMLParameterFile)
XMLDataFile (class in pygcam.mcs.XMLParameterFile)
XMLDistribution (class in pygcam.mcs.XMLParameterFile)
xmlEdit() (in module pygcam.xmlEditor)
XMLEditor (class in pygcam.xmlEditor)
XMLFile (class in pygcam.XMLFile)
XmlFormatError
XMLInputFile (class in pygcam.mcs.XMLParameterFile)
xmlIns() (in module pygcam.xmlEditor)
XMLParameter (class in pygcam.mcs.XMLParameterFile)
XMLParameterFile (class in pygcam.mcs.XMLParameterFile)
XMLPythonFunc (class in pygcam.mcs.XMLParameterFile)
XMLQuery (class in pygcam.mcs.XMLParameterFile)
XMLRandomVar (class in pygcam.mcs.XMLParameterFile)
XMLRelFile (class in pygcam.mcs.XMLParameterFile)
XMLResult (class in pygcam.mcs.XMLResultFile)
XMLResultFile (class in pygcam.mcs.XMLResultFile)
xmlSel() (in module pygcam.xmlEditor)
XMLTrialData (class in pygcam.mcs.XMLParameterFile)
XMLVariable (class in pygcam.mcs.XMLParameterFile)
XMLWrapper (class in pygcam.mcs.XML)
Read the Docs
v: v1.10.1
Versions
master
latest
stable
v1.10.1
v1.10.0
v1.9.4
v1.8.0
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.