[Offgridders V4.6.1] - RTD and Installation fix

[Offgridders V4.6.1] - 2020-11-07

Added

• Docstrings to A1, B, C, D0, D1, E, F, G0-2 (#131, #132, #133, #134, #135, #136)
• Literature file to readthedocs (#129)
• Added some docstrings to functions in G2a, copied from Components.rst (#125)
• Replaced "Yes" and "No" with True and False. In H0 and inside the Excel Files (#127)

Changed

• Update README (#129)
• Bump black version number (#144)
• Devided the requirements.txt into a base one (users) and an extended one for developers and for troubleshooting (requirements_dev.txt) (#145)
• Updated the installation instructions in Readme.md and of the RTD (#145)

Fixed

• Small content corrections to readthedocs (#119,#123,#125)
• Fixed parsing issue with evaluation_prespective by fixing definition of logging message and constant varibale definition of AC_SYSTEM (#143)

Offgridders V4.6 - Major oemof-solph update

[Offgridders V4.6] - 2020-08-17

Changed

• Replaced == False with is False and == True with is True
• Facilitated upgrade to unbundled oemof version: oemof.solph == 0.4.0, oemof.network==0.4.0rc0, oemof.tools==0.4.0 and update requirements.txt

Offgridders V4.5 - Replacing parameter strings with variables

[Offgridders V4.5] 2020-08-12

Added

• Constant variables for strings are gathered in constants.py (#89,#117, #118)

Changed

• Replaced parameter strings with variable calls (#89,#117, #118)
• Changed path calls to os.path.join to enable compatability (#118)
• Log messages now call variable of parameter name (#117, #118)

Removed

• Try/Except clauses at module import (#103)

Fixed

[Offgridders V4.4] - Bug fixes

[Offgridders V4.4] - 2020-07-09

Added

• Error message if parameter evaluation_perspective is not chosen correctly (#97)
• Warning message if fuel_price_change_annual != 0, as calculation may be faulty (#97)

Changed

• Added parameter consumption_fuel_annual_kWh to simulation outputs (#97)
• Input template file so that it runs MCA and gives options of evaluation_perspective (#97)
• If fuel_price_change_annual == 0, function present_value_changing_fuel_price is not executed and returns fuel price (#97)
• Order of cost results in simulation outputs, as first_investment_cost, operation_mantainance_expenditures as these are not to be added to costs, expenditures and revenues to calculate the NPC (#97)
• Formula calculating the residual value of an asset. Now, the sales revenue is translated into a present value:
  linear_depreciation_last_investment = last_investment / lifetime and capex = capex - linear_depreciation_last_investment * (number_of_investments * lifetime - project_life) / (1 + wacc) ** (project_life) (#97)
  )`

Removed

• Removed unused function call in G2a (genset_oem_minload) (#97)

Fixed

• Miscalculation of total_demand_supplied_annual_kWh due to wrong evaluation_perspective on tab case_definitions (#97)
• Function call of present_value_changing_fuel_price (#97)
• Typo: Replace operation_mantainance_expenditures by operation_maintenance_expenditures (#97)

[Offgridders v4.3] - Fixed function imports

Fixed

• Faulty function calls from module structure change: 'get_universal_parameters', 'get_combinations_around_base', 'get_number_of_blackouts' (#86)

[Offgridders V4.2] - Additional outputs

Added

• total_excess_annual_kWh to list of output parameters. Calculation: total_excess_annual_kWh = total_excess_ac_annual_kWh + total_excess_dc_annual (#73)
• Optional parameters and their default values fuel_co2_emission_factor (2.68 kgCO2eq/l diesel) and maingrid_co2_emission_factor (0.9 kgCO2eq/kWh) to input template, sheet input_constant and module B (#77)
• Calculation of C02 emissions and new output value: co2_emissions_kgCO2eq. It is based on the kWh consumption from the national grid (before transfromer station losses) and diesel consumption (#77)

Fixed

• Typo when calling for the inverter capacity (capacity_inverter_dc_ac_kW and not capacity_inverter_kW), (#75)
• Typo for unit of maingrid_extension_lifetime (a)

[Offgridders V4.1] - Updated class structure and readthedocs

Added

• readthedocs.yml file (#59)

Changed

• Moved Wiki to Readthedocs (#41)
• Changed class structure to modules/functions (#53)
• Script A0 was refactored to Offgridders. It runs now through python Offgridders.py YOUR_INPUT_EXCEL_SHEET_PATH

Fixed

• Compilation of readthedocs by changing advanced settings on readthedocs.io (#59)

New Feature: Multi-Criteria Analysis

[Offgridders V4.0] 2020-04-30

Added

• Multi-Criteria Analysis (MCA), a post-processing comparison of the optimization results with H0 and H1
• Plotting bar charts of most relevant criteria
• Calculation of total first time investment costs ("first_investment") and total O&M costs ("operation_mantainance_expenditures")

Changed

• Changelog.md was updated with old release infos
• requirements.txt: added scipy, xlsxwriter
• test_input_template.xlsx: Setting whether to perform the multicriteria analysis (MCA) in settings tab; Electricity sales tariff (for MCA only) in case_definitions
• test_input_template.xlsx: New tab "multicriteria_data": weights of dimensions and criteria (all with default values) and which sensibility parameters should be included in the MCA
• A0 to call MCA
• B to read data from xlsx for MCA
• C: Extend set of parameters that are an output of simulation by "total_pv_generation_kWh", "total_wind_generation_kWh", "total_genset_generation_kWh"

Removed

Offgridders V3.1.1

Intermediary release, maily focussing on restructuring the code into a code folder and adding a readthedocs.
Readthedocs is still dysfunctional. When starting to use Offgridders, please use release v3.1.

Offgridders V3.1

Release that includes all changes up to October 2019

• Version that is used for PSBs Cobrador paper + Book chapter
• Version that is used for MMHs Backup system paper

Info: Up to this point, no Changelog.md was in place. Changes will be tracked more carefully starting v4.0