Python API

This section provides an extensive documentation of available classes and functions.

• Databases
  • resetDb()
  • deleteDb()
  • setForeground()
  • setBackground()
  • list_databases()
  • Import / export
    • export_db()
    • import_db()
• Parameters
  • Create parameters
    • Float parameters
      • newFloatParam()
      • Distribution types
        • DistributionType
          • DistributionType.BETA
          • DistributionType.FIXED
          • DistributionType.LINEAR
          • DistributionType.LOGNORMAL
          • DistributionType.NORMAL
          • DistributionType.TRIANGLE
    • Boolean parameters
      • newBoolParam()
    • Enum parameters
      • newEnumParam()
  • Utils
    • List of parameters
      • list_parameters()
      • all_params()
    • Save / load params
      • resetParams()
      • freezeParams()
      • loadParams()
      • persistParams()
    • Custom Sympy functions
      • user_function()
    • Misc
      • switchValue()
• Activities
  • class ActivityExtended
    • ActivityExtended
      • ActivityExtended.addExchanges()
      • ActivityExtended.deleteExchanges()
      • ActivityExtended.getAmount()
      • ActivityExtended.getExchange()
      • ActivityExtended.getOutputAmount()
      • ActivityExtended.listExchanges()
      • ActivityExtended.non_production_exchanges()
      • ActivityExtended.setOutputAmount()
      • ActivityExtended.updateExchanges()
      • ActivityExtended.updateMeta()
  • findActivity()
    • findActivity()
  • findBioAct()
    • findBioAct()
  • findTechAct()
    • findTechAct()
  • newActivity()
    • newActivity()
  • copyActivity()
    • copyActivity()
  • newSwitchAct()
    • newSwitchAct()
  • printAct()
    • printAct()
  • interpolate_activities()
    • interpolate_activities()
• Methods
  • findMethods()
  • method_unit()
  • method_name()
• Impacts
  • Compute impacts
    • compute_impacts()
  • Compute inventory
    • compute_inventory()
• Sensitivity analysis
  • One at a time
    • oat_matrix()
    • oat_dashboard()
  • GSA / Sobol analysis
    • incer_stochastic_dashboard()
  • Distribution of impacts
    • distrib()
  • Simplified models
    • sobol_simplify_model()
    • compare_simplified()
• Units
  • Activation
  • Usage
  • Convert between units
  • Unit registry
    • Adding new units
  • Units in exchanges
  • Auto scale
  • Full API
    • check_unit_consistency()
      • check_unit_consistency()
    • define_separate_unit()
      • define_separate_unit()
    • define_alias_unit()
      • define_alias_unit()