electricity-plan-analyzer

1.3.1 • Public • Published

⚡ Electricity Plan Analyzer

Overview

The Electricity Plan Analyzer is a command-line utility that aids consumers in Israel in making informed decisions about their electricity plan. Users can analyze their electricity consumption data from the Israel Electric Company (IEC) to determine which electricity plan offers the best value based on their usage patterns.

Israeli customers can download their consumption data here, which includes KwH usage for every 15-minute interval, and use this tool to compare different plans.

The CLI outputs:

  • Discounted KwH for each timeslot
  • Total annual KwH consumption
  • Total annual cost
  • Total annual discount
  • Discount percentage for each plan

Plans

Currently, 12 plans from 5 vendors are analyzed:

Usage

To run the Electricity Plan Analyzer, execute the following command with the path to your electricity consumption CSV file:

npx electricity-plan-analyzer --input <path-to-csv> --output <output-csv> --cost <cost-multiplier>

Options

  • --input, -i: Path to your electricity usage CSV file. Required.
  • --output, -o: Path for the output CSV file. Defaults to meter_output.csv.
  • --cost, -c: The cost multiplier used for calculating the total cost. Defaults to 0.6007.

Examples

  • Using the default output and cost:
npx electricity-plan-analyzer --input /path/to/your/usage.csv
  • Specifying both input and output files:
npx electricity-plan-analyzer --input /path/to/your/usage.csv --output /path/to/your/result.csv
  • Specifying both input file and custom cost multiplier:
npx electricity-plan-analyzer --input /path/to/your/usage.csv --cost 0.65

Acknowledgments

I would like to thank everyone who contributed to the ideation of this tool, especially those who provided valuable feedback and suggestions to improve its functionality.

Code, readme and license were written using GPT4-turbo.

License

This project is free to use for non-commercial purposes. Commercial use is not permitted.

Readme

Keywords

none

Package Sidebar

Install

npm i electricity-plan-analyzer

Weekly Downloads

24

Version

1.3.1

License

SEE LICENSE IN LICENSE.md

Unpacked Size

783 kB

Total Files

5

Last publish

Collaborators

  • mluggy