Logo
  • Installation
    • Pre-requisites
    • Installing from source
      • Obtaining the source code
      • Creating the conda environment
      • Installing pommes
      • Running the test suite
      • Compiling a local version of the documentation
  • How To Use
  • Examples
    • Example notebook
  • Methodology
    • Model Description
      • Nomenclature
        • Indices and Index Sets
        • General Parameters
        • Retrofit Parameters
        • Conversion Parameters
        • Storage Parameters
        • Transport Parameters
        • Networks Parameters
        • Investment Variables
        • Operation Variables
        • Cost Variables
      • Objective function
        • Costs definition
      • Adequacy constraint
      • Capacity constraints
      • Storage constraints
      • Carbon related constraints
      • Imports constraints
      • TURPE constraints
    • Dataset Description
  • API Reference
    • test
    • pommes
      • Submodules
        • pommes.common_plots
        • pommes.io
        • pommes.model
        • pommes.post_process
        • pommes.solver
        • pommes.tests
        • pommes.utils
        • pommes.visualisation
      • Functions
      • Package Contents
        • build_input_parameters()
        • read_config_file()
        • generate_summary_dataframes_from_results()
        • save_solution()
        • build_model()
        • check_inputs()
        • get_capacities()
        • get_net_generation()
    • pre_process
      • Attributes
      • Functions
      • Module Contents
        • pre_process_test_case()
        • repo
    • draft_multi_index
      • Attributes
      • Module Contents
        • study
    • revert_pre_process
      • Attributes
      • Module Contents
        • repo
pommes
  • API Reference
  • View page source

API Reference

This page contains auto-generated API reference documentation [1].

  • test
  • pommes
    • pommes.common_plots
    • pommes.io
      • pommes.io.build_input_dataset
      • pommes.io.calculate_summaries
      • pommes.io.read_solution
      • pommes.io.save_solution
    • pommes.model
      • pommes.model.build_model
      • pommes.model.carbon
      • pommes.model.combined
      • pommes.model.conversion
      • pommes.model.data_validation
        • pommes.model.data_validation.dataset_check
      • pommes.model.net_import
      • pommes.model.retrofit
      • pommes.model.storage
      • pommes.model.transport
      • pommes.model.turpe
    • pommes.post_process
    • pommes.solver
      • pommes.solver.utils_xpress
    • pommes.tests
      • pommes.tests.conftest
      • pommes.tests.test_build_input_dataset
      • pommes.tests.test_carbon_net_import
      • pommes.tests.test_combined
      • pommes.tests.test_conversion
      • pommes.tests.test_io
      • pommes.tests.test_net_import
      • pommes.tests.test_post_processes
      • pommes.tests.test_storage
      • pommes.tests.test_test_case
      • pommes.tests.test_test_case_aggregate_link_data
      • pommes.tests.test_test_case_calculate_summaries
      • pommes.tests.test_time_slice
      • pommes.tests.test_transport
      • pommes.tests.tests_utils
        • pommes.tests.tests_utils.test_sort_dataset
        • pommes.tests.tests_utils.test_variable_selection_from_dims
    • pommes.utils
    • pommes.visualisation
      • pommes.visualisation.annual_energy_plot
      • pommes.visualisation.capacity_plot
      • pommes.visualisation.energy_cost_plot
  • pre_process
  • draft_multi_index
  • revert_pre_process
[1]

Created with sphinx-autoapi

Previous Next

© Copyright 2024, PERSEE - Mines Paris PSL.

Built with Sphinx using a theme provided by Read the Docs.