View source for Solar Alone Multi-objective Advisor (SAMA)

'''SAMA (Solar Alone Multi-objective Advisor)''' is an open-source (GNU GPL v3) energy system optimizer and analyzer mainly concentrated on stand-alone off-grid solar photovoltaic (PV)-based renewable energy systems (RES). SAMA allows for hybrid systems in locations that need a form of non-battery backup generation. Using SAMA, users can find the optimum size of a hybrid energy system for their property based on the electric load profile and meteorological data (irradiation, temperature and wind speed). Users can access economic data for their optimal energy system as a result of SAMA optimization and calculations. SAMA is developed in '''Python 3.9''' using the ''NumPy, Numba, time, pandas, math, matplotlib and seaborn''.

More information: Seyyed Ali Sadat, Jonathan Takahashi, Joshua M. Pearce, A Free and open-source microgrid optimization tool: SAMA the solar alone Multi-Objective Advisor, ''Energy Conversion and Management'', 298, 2023, 117686, https://doi.org/10.1016/j.enconman.2023.117686. ([https://www.academia.edu/108416812/A_Free_and_Open_source_Microgrid_Optimization_Tool_SAMA_the_Solar_Alone_Multi_Objective_Advisor Academia.edu]){{YouTube|video=https://www.youtube.com/watch?v=jBLA-EiLpu8}}
[[File:SAMA_Logo-with_Typography.png|link=https://www.appropedia.org/File:SAMA_Logo-with_Typography.png|thumb|235x235px|SAMA Logo-with Typography]]
[[File:SAMA_typography.png|link=https://www.appropedia.org/File:SAMA_typography.png|thumb|237x237px|SAMA Typography]]

== Using SAMA ==
'''At the current version, SAMA is on the plain python code, but soon to be, an web tool and application exhibiting user interface will be designed for SAMA. To download SAMA newest version, please refer to its ''[https://github.com/Sas1997/SAMA GitHub repository] (Download all the files inside the SAMA V 1.01).'' Each part of software package back-end are described below. For comprehensive back-end discussion, please refer to [https://osf.io/7ztae SAMA user manual].'''

'''<big>''Watch this video discussing a case study in detail with SAMA and providing introductions how to use SAMA.''</big>'''{{video|HtazTP-tF9g}}

=== <big>How to run SAMA</big> ===
'''''Step.1'''''

Obtain the input data for simulations! To run SAMA, the user needs to define some data such as electrical load, temperature, irradiance, wind speed (if wind turbine is included in simulation), and costs. Hourly electrical load data for U.S different cities in a year (8760 values) can be downloaded from [https://data.openei.org/submissions/153 NREL library]. Then in this file, extract the second column values from second row to the last value (8760 values) and replace them with first column of '''Eload.csv''' inside the '''content folder'''. Meteorological data (temperature, irradiance, wind speed) can be downloaded for any location in the world from [https://nsrdb.nrel.gov/data-viewer NSRDB] and be placed inside the '''content folder''' with '''METEO.csv''' name. Please note that when you download these data from NSRDB, the time interval should be 60 mins, and check to download DHI, DNI, Fill Flag, GHI, Ozone, Relative Humidity, Solar Zenith Angle, Surface Albedo, Pressure, Precipitable Water, Wind Direction, and Wind Speed ('''all meteorological the data'''). When defined electrical load and meteorological data or you decide how you want to define them, you need to define other inputs as discussed below completely ('''under Input_Data.py''').

'''''Step.2'''''

Open the '''pso.py''' file in your preferred Python compiler and run it. For example, if user uses PyCharm environment, they just need to open '''pso.py''' in their PyCharm and run it! To run the code without error, user needs to make sure required Python packages ('''''NumPy, Numba, time, pandas, math, matplotlib and seaborn''''') are installed prior to the run.

Enjoy!

=== Input_Data.py: The input data for simulations are defined inside this file. ===

==== <nowiki>#</nowiki> Optimization inputs ====

# <code>self.MaxIt=200</code>: This parameter sets the maximum number of iterations or generations the PSO algorithm will run before terminating. The algorithm will stop once it reaches this limit.
# <code>self.nPop = 50</code>: This parameter determines the population size or swarm size. It specifies the number of particles in the swarm that will be used to explore the search space for an optimal solution.
# <code>self.w = 1</code>: This is the inertia weight, a coefficient that controls the balance between the particle's previous velocity and its cognitive and social components in updating its position. A higher value for 'w' means a greater emphasis on the particle's previous velocity.
# <code>self.wdamp = 0.99</code>: Inertia weight damping ratio. Over iterations, 'w' is typically reduced to decrease the impact of the previous velocity on particle movement. This parameter specifies the rate at which the inertia weight is reduced.
# <code>self.c1 = 2</code>: Personal learning coefficient, also known as cognitive coefficient. It controls the impact of a particle's best-known solution (individual experience) on its movement.
# <code>self.c2 = 2</code>: Global learning coefficient, also known as social coefficient. It controls the impact of the best-known solution within the entire swarm (collective experience) on a particle's movement.
# <code>self.Run_Time = 1</code>: This parameter sets the total number of runs in the simulation. In some cases, you might want to run the PSO algorithm multiple times and average the results to ensure robustness in finding the optimal solution.

==== <nowiki>#</nowiki> Lifetime and time definition ====

# <code>self.n = 25</code>: This parameter represents the lifetime of the energy system in the simulations, specified in years.
# <code>self.year = 2023</code>: This parameter specifies the desired year within the simulation.

==== <nowiki>#</nowiki> Defining the electrical load ====
<code>load_type</code> is a variable that determines how you want to input the electrical load data. Depending on its value, different methods are used to define the load.

* If <code>load_type</code> is set to 1, the electrical load is loaded from a CSV file located at 'content/Eload.csv'. The data is read from the CSV file and stored in the <code>self.Eload</code> array.
* If <code>load_type</code> is set to 2, the electrical load is defined as monthly hourly averages. The <code>self.Monthly_haverage_load</code> array contains the hourly averages for each month, and the <code>dataextender</code> function is used to extend this data into hourly values for the entire year.
* If <code>load_type</code> is set to 3, the electrical load is defined as monthly daily averages. The <code>self.Monthly_daverage_load</code> array contains the daily averages for each month, and the code converts these to hourly averages by dividing by 24. The <code>dataextender</code> function is then used to create hourly data for the entire year.
* If <code>load_type</code> is set to 4, the electrical load is defined as monthly total load. The <code>self.Monthly_total_load</code> array contains the total load for each month, and the code calculates monthly hourly averages based on the total load and the number of days in each month. The <code>dataextender</code> function is used to extend this data into hourly values for the entire year.
* If <code>load_type</code> is set to 5, the electrical load is based on a generic load profile defined by the variable <code>user_defined_load</code>. The <code>generic_load</code> function is used to generate hourly load values based on this generic profile.
* If <code>load_type</code> is set to 6, the electrical load is defined as an annual hourly average, and all 8760 hours of the year are set to this average value.
* If <code>load_type</code> is set to 7, the electrical load is defined as an annual daily average, and the code calculates the annual hourly average by dividing the daily average by 24. All 8760 hours of the year are set to this average value.
* If <code>load_type</code> is set to 8, the electrical load is defined as an annual total load, and the code calculates the annual hourly average based on the total load and the number of days in each month. The <code>generic_load</code> function is used to generate hourly load values based on this annual total load.
* If <code>load_type</code> is set to 9, a default generic load is used with a peak month definition of 'July or January'.

==== <nowiki>#</nowiki> Electrical load for previous year ====
It is defined similar to the electrical load discussed above. '''The electrical load for previous year is only needed for the situations we are going to calculate the grid costs and the monthly service charge scheme is tired rate structure.''' '''''In other situations, users do not need to deal with this parameter.'''''

==== <nowiki>#</nowiki> Irradiance definition ====

# <code>weather_url</code>: This variable stores the URL or path to a weather data file in CSV format. The file is named 'METEO.csv' and likely contains weather-related data needed for simulating solar energy generation, such as solar irradiance, temperature, and other meteorological parameters. The specific content and format of the file depend on the simulation's requirements.
# <code>azimuth</code>: This variable specifies the azimuth angle in degrees, which represents the orientation of the photovoltaic (PV) modules. In this case, the azimuth is set to 180 degrees, which typically means that the PV modules are facing south.
# <code>tilt</code>: The <code>tilt</code> variable represents the tilt angle of the PV modules in degrees. A tilt angle determines the inclination of the PV panels from the horizontal plane. In this case, the tilt angle is set to 34 degrees.
# <code>soiling</code>: This variable stores the soiling loss percentage. Soiling losses refer to the reduction in energy generation due to dirt, dust, or other contaminants that accumulate on the PV modules over time.
# <code>G_type</code> is a variable that determines how you want to input solar irradiance data. Depending on its value, different methods are used to define the irradiance data.
#* If <code>G_type</code> is set to 1, SAMA uses a built-in plane of array (POA) irradiance calculator based on the weather data stored in the CSV file specified by <code>weather_url</code>. The <code>tilt</code> and <code>azimuth</code> angles of the PV modules, as well as a soiling loss percentage, are used as inputs for the simulation. The result is stored in <code>temp_result</code>, and the POA irradiance values are extracted from it and stored in the <code>self.G</code> array.
#* If <code>G_type</code> is set to 2, the solar irradiance data is loaded from a CSV file located at 'content/Irradiance.csv'. The data is read from the CSV file and stored in the <code>self.G</code> array. '''Please note that if you use this option, soiling losses will not be induced by SAMA itself.'''

==== <nowiki>#</nowiki> Temperature definition ====
<code>T_type</code> is a variable that determines how you want to input temperature data for your simulation. Depending on its value, different methods are used to define the temperature data.

* If <code>T_type</code> is set to 1, the code imports the <code>runSimulation</code> function from the <code>sam_monofacial_poa</code> module. This function is used to simulate temperature data based on the provided weather data, tilt, azimuth, and soiling parameters. The temperature data is extracted and stored in the <code>self.T</code> array.
* If <code>T_type</code> is set to 2, the temperature data is loaded from a CSV file located at 'content/Temperature.csv'. The data is read from the CSV file and stored in the <code>self.T</code> array.
* If <code>T_type</code> is set to 3, the temperature data is defined as monthly hourly averages. The <code>self.Monthly_average_temperature</code> array contains the hourly averages for temperature for each month. The <code>dataextender</code> function is used to extend this data into hourly values for the entire year.
* If <code>T_type</code> is set to 4, the temperature data is defined as an annual average temperature. The <code>self.Annual_average_temperature</code> variable is set to desired annual average, and all 8760 hours of the year are set to this average temperature.

==== <nowiki>#</nowiki> Wind speed definition ====
<code>WS_type</code> is a variable that determines how you want to input wind speed data for your simulation. Depending on its value, different methods are used to define the wind speed data.

* If <code>WS_type</code> is set to 1, the code imports the <code>runSimulation</code> function from the <code>sam_monofacial_poa</code> module. This function is used to simulate wind speed data based on the provided weather data, tilt, azimuth, and soiling parameters. The wind speed data is extracted and stored in the <code>self.Vw</code> array.
* If <code>WS_type</code> is set to 2, the wind speed data is loaded from a CSV file located at 'content/WSPEED.csv'. The data is read from the CSV file and stored in the <code>self.Vw</code> array.
* If <code>WS_type</code> is set to 3, the wind speed data is defined as monthly hourly averages. The <code>self.Monthly_average_windspeed</code> array contains the hourly averages for wind speed for each month. The <code>dataextender</code> function is used to extend this data into hourly values for the entire year.
* If<code>WS_type</code> is set to 4, the wind speed data is defined as an annual average wind speed. The <code>self.Annual_average_windspeed</code> variable is set to desired annual wind speed, and all 8760 hours of the year are set to this average wind speed.

==== <nowiki>#</nowiki> Type of systems included in simulations ====

# <code>self.PV</code>: This indicates that a photovoltaic (PV) system is included in the simulation (with a value of 1) or not (with a value of 0).
# <code>self.WT</code>:This indicates that a a wind turbine (WT) system is included in the simulation (with a value of 1) or not (with a value of 0).
# <code>self.DG</code>: This indicates that a diesel generator (DG) system is included in the simulation (with a value of 1) or not (with a value of 0).
# <code>self.Bat</code>: This indicates that a battery system in the simulation (with a value of 1) or not (with a value of 0).
# <code>self.Grid = 1</code>: This indicates if grid interconnection is included in the simulation, indicated by a value of 1. If you want to simulate a off-grid system without a grid connection, you would set this to 0.
# <code>self.NEM = 1</code>: This parameter is related to net metering. If set to 1, it means that compensation in the net metering scheme is provided as credits, not as monetary compensation. In this case, yearly credits will be reconciled after 12 months.

==== <nowiki>#</nowiki> Constraints ====

# <code>self.LPSP_max_rate</code>: This parameter represents the maximum acceptable loss of power supply probability (LPSP) in percentage form.
# <code>self.RE_min_rate</code>: This parameter represents the minimum required renewable energy (RE) capacity as a percentage.

==== <nowiki>#</nowiki> Multi-objective optimization ====
If <code>self.EM = 0</code>the objective for optimization is only NPC while if <code>self.EM = 1</code>the objectives for optimization are NPC and levelized emission (LE).

==== <nowiki>#</nowiki> Rated capacity ('''DO NOT CHANGE''') ====

==== <nowiki>#</nowiki> PV technical parameters ====

# <code>self.fpv = 0.9</code>: This parameter represents the derating factor for the PV module, expressed as a percentage (90%). It accounts for efficiency losses and performance degradation in the PV module over time.
# <code>self.Tcof = 0</code>: The temperature coefficient for the PV module, expressed as a percentage per degree Celsius (%/°C). It quantifies how the PV module's performance is affected by changes in temperature.
# <code>self.Tref = 25</code>: The reference temperature at standard test conditions for the PV module, typically 25°C. This is used to normalize the module's performance data.
# <code>self.Tc_noct = 45</code>: The nominal operating cell temperature for the PV module. It represents the temperature of the PV cells during operation under specified conditions.
# <code>self.Ta_noct = 20</code>: The ambient temperature used for determining the nominal operating cell temperature. It is typically lower than the cell temperature due to the module's heat dissipation.
# <code>self.G_noct = 800</code>: The solar irradiance at the nominal operating cell temperature. It represents the solar radiation level used to calculate the NOCT.
# <code>self.gama = 0.9</code>: A parameter related to the conversion efficiency of the PV module.
# <code>self.n_PV = 0.2182</code>: The efficiency of the PV module. This value likely represents the efficiency of converting incident solar energy into electrical energy.
# <code>self.Gref = 1000</code>: The reference solar irradiance level, typically 1000 watts per square meter (W/m^2), used for normalizing PV module performance data.
# <code>self.L_PV = 25</code>: The lifetime of the PV module in years. This parameter defines the expected operational lifespan of the PV module in your simulation.

==== <nowiki>#</nowiki> WT technical parameters ====

# <code>self.h_hub = 17</code>: This parameter represents the hub height of the wind turbine in meters. It specifies the height at which the wind turbine is mounted, and it is an important factor affecting wind energy capture.
# <code>self.h0 = 43.6</code>: The anemometer height in meters. Anemometer height is the height at which wind speed measurements are taken and is typically used to calculate wind shear.
# <code>self.nw = 1</code>: The electrical efficiency of the wind turbine, expressed as a decimal. It indicates the fraction of the wind's kinetic energy that is converted into electrical energy.
# <code>self.v_cut_out = 25</code>: The cut-out speed in meters per second (m/s). When the wind speed exceeds this value, the wind turbine is typically shut down or "cut out" to prevent damage.
# <code>self.v_cut_in = 2.5</code>: The cut-in speed in meters per second (m/s). It is the wind speed at which the wind turbine starts operating and generating electricity.
# <code>self.v_rated = 9.5</code>: The rated speed of the wind turbine in meters per second (m/s). This is the wind speed at which the wind turbine generates its maximum rated power.
# <code>self.alfa_wind_turbine = 0.14</code>: The coefficient of friction. This parameter is used to model the effects of friction on the wind turbine's performance. The value may vary depending on wind conditions, with lower values for extreme wind conditions and higher values for normal wind conditions.
# <code>self.L_WT = 20</code>: The lifetime of the wind turbine in years. This parameter defines the expected operational lifespan of the wind turbine in your simulation.

==== <nowiki>#</nowiki> DG technical parameters ====

# <code>self.LR_DG = 0.25</code>: This parameter represents the minimum load ratio for the DG system, expressed as a percentage (%). It specifies the minimum load that the DG can operate at efficiently.
# Diesel Generator Fuel Curve:
#* <code>self.a = 0.2730</code>: The coefficient 'a' in liters per hour per kilowatt (L/hr/kW) of DG output. It is used to model the DG's fuel consumption rate as a function of its output power.
#* <code>self.b = 0.0330</code>: The coefficient 'b' in liters per hour per kilowatt (L/hr/kW) of the DG's rated power. It is used in the fuel consumption model.
# <code>self.TL_DG = 24000</code>: The lifetime of the diesel generator in hours. This parameter defines the expected operational lifespan of the DG in your simulation.
# Emissions produced in gr by DG for liter of fuel consumed

* <code>self.CO2</code>: The emission level of carbon dioxide (CO2) in grams per liter (g/L) of fuel. CO2 is a greenhouse gas and a major contributor to global warming.
* <code>self.CO</code>: The emission level of carbon monoxide (CO) in grams per liter (g/L) of fuel. Carbon monoxide is a harmful air pollutant that can have adverse effects on air quality and human health.
* <code>self.NOx</code>: The emission level of nitrogen oxides (NOx) in grams per liter (g/L) of fuel. NOx includes nitrogen dioxide (NO2) and nitric oxide (NO), which are harmful air pollutants and contribute to smog and acid rain.
* <code>self.SO2</code>: The emission level of sulfur dioxide (SO2) in grams per liter (g/L) of fuel. SO2 is a harmful air pollutant that can lead to respiratory problems and contribute to acid rain.

==== <nowiki>#</nowiki> Battery technical parameters ====

# <code>self.SOC_min = 0.2</code>: The minimum state of charge (SOC) of the battery. SOC represents the fraction of the battery's capacity that is currently used, and this parameter sets the minimum allowed SOC.
# <code>self.SOC_max = 1</code>: The maximum SOC of the battery, representing the fully charged state. It is typically set to 1 for full capacity.
# <code>self.SOC_initial = 0.5</code>: The initial SOC of the battery when the simulation starts.
# <code>self.Q_lifetime = 8000</code>: The lifetime capacity of the battery, expressed in kilowatt-hours (kWh). This value represents the total energy that the battery is capable of storing over its lifetime.
# <code>self.self_discharge_rate = 0</code>: The hourly self-discharge rate of the battery, which is a measure of how much energy is lost over time due to self-discharge. A rate of 0 indicates no self-discharge.
# <code>self.alfa_battery = 1</code>: The storage's maximum charge rate, given as a ratio of charge current to the battery's capacity (A/Ah). This parameter is related to the battery's charge and discharge characteristics.
# <code>self.c = 0.403</code>: The storage capacity ratio, which is a unitless parameter related to the battery's capacity and performance.
# <code>self.k = 0.827</code>: The storage rate constant, given in units of per hour (h⁻¹). This parameter influences the rate at which the battery can charge or discharge.
# <code>self.Imax = 16.7</code>: The battery's maximum charge current, expressed in amperes (A).
# <code>self.Vnom = 12</code>: The battery's nominal voltage, specified in volts (V).
# <code>self.ef_bat = 0.8</code>: The round-trip efficiency of the battery. This parameter represents the efficiency of charging and discharging the battery.
# <code>self.L_B = 7.5</code>: The lifetime of the battery in years. This parameter defines the expected operational lifespan of the battery in your simulation.

==== <nowiki>#</nowiki> Inverter ====

# <code>self.n_I</code>: This parameter represents the efficiency of the inverter. It is expressed as a decimal and indicates the fraction of electrical power that is converted from direct current (DC) to alternating current (AC) by the inverter.
# <code>self.L_I</code>: The lifetime of the inverter in years. This parameter defines the expected operational lifespan of the inverter in your simulation.
# <code>self.DC_AC_ratio</code>: The maximum acceptable DC to AC ratio. This parameter specifies the maximum ratio of DC power (input) to AC power (output) that the inverter can handle efficiently.

==== <nowiki>#</nowiki> Charger ====
The parameter <code>self.L_CH</code> is related to the charge controller used in your simulation and represents the lifetime of the charger in years.

==== <nowiki>#</nowiki> Economic inputs ====

# <code>self.n_ir_rate</code>: The nominal discount rate, expressed as a percentage. It represents the rate at which future cash flows are discounted to determine their present value.
# <code>self.e_ir_rate</code>: The expected inflation rate, expressed as a percentage. It accounts for the expected rate of price inflation over time..
# <code>self.Budget</code>: The budget or limit on the total capital cost for the project, expressed in dollars. This parameter sets a constraint on the total capital expenditure.
# <code>self.Tax_rate</code>: The equipment sales tax rate, expressed as a percentage. It represents the percentage of tax applied to the purchase of equipment.
# <code>self.RE_incentives_rate</code>: The federal tax credit rate for renewable energy incentives, expressed as a percentage. This parameter represents the percentage of federal tax credit that can be applied to the project.

==== <nowiki>#</nowiki> Top down pricing inputs ====

* <code>self.Pricing_method</code>: This parameter is used to determine the pricing method. If it is set to "1", it refers to the '''top-down pricing''' method and "2" refers to '''bottom up pricing''' method. In the '''top-down pricing''' method, the PV system costs are broke down based on NREL PV cost benchmarks. In '''bottom up pricing''' method, users need to define each equipment cost in detail (Capital, replacement and maintenance).

For top-down pricing method:

* <code>Total_PV_price = 2950</code>: The total price for PV system (PV+inverter+engineering costs) in $ per kW. This is the initial cost of the PV system.
* Rather than PV and inverter, users need to define costs in $ per kW for other system components and $ per kWh for battery, such as wind turbines (WT), diesel generators (DG), batteries (B), and chargers (CH), including their capital costs, replacement costs, and operation and maintenance (O&M) costs. These costs are based on the capital costs and replacement costs in dollars.
* Some components, like the diesel generator (DG) fuel cost, also consider yearly escalation or reduction rates in fuel cost.

'''top-down pricing''' allows you to model the initial and ongoing costs of the various components of your energy system. The top-down pricing method starts with the total cost and allocates it to individual components based on predefined relationships and cost factors.

==== <nowiki>#</nowiki> Bottom up pricing inputs ====
This approach specifies the costs associated with individual components of the energy system. Here's a breakdown of the pricing information for each component:

* Engineering Costs (Per/kW):
** <code>self.Installation_cost = 160</code>: The cost of installation per kilowatt (kW) of installed capacity.
** <code>self.Overhead = 260</code>: Overhead costs per kW.
** <code>self.Sales_and_marketing = 400</code>: Sales and marketing costs per kW.
** <code>self.Permiting_and_Inspection = 210</code>: Permitting and inspection costs per kW.
** <code>self.Electrical_BoS = 370</code>: Electrical balance of system (BoS) costs per kW.
** <code>self.Structural_BoS = 160</code>: Structural BoS costs per kW.
** <code>self.Supply_Chain_costs = 0</code>: Supply chain costs per kW.
** <code>self.Profit_costs = 340</code>: Profit costs per kW.
** <code>self.Sales_tax = 80</code>: Sales tax per kW.
** <code>self.Engineering_Costs</code>: The total engineering costs per kW, calculated as the sum of all the individual cost components.
* PV (Photovoltaic) System:
** <code>self.C_PV = 2510</code>: The capital cost of the PV system per kW.
** <code>self.R_PV = 2510</code>: The replacement cost of PV modules per kW.
** <code>self.MO_PV = 28.12</code>: The annual O&M cost per kW.
* Inverter:
** <code>self.C_I = 440</code>: The capital cost of the inverter per kW.
** <code>self.R_I = 440</code>: The replacement cost of the inverter per kW.
** <code>self.MO_I = 3</code>: The annual O&M cost per kW.
* Wind Turbine (WT) System:
** <code>self.C_WT = 1200</code>: The capital cost of the wind turbine system per kW.
** <code>self.R_WT = 1200</code>: The replacement cost of wind turbines per kW.
** <code>self.MO_WT = 40</code>: The annual O&M cost per kW.
* Diesel Generator (DG) System:
** <code>self.C_DG = 240.45</code>: The capital cost of the diesel generator system per kW.
** <code>self.R_DG = 240.45</code>: The replacement cost of the diesel generator per kW.
** <code>self.MO_DG = 0.064</code>: The annual O&M cost per operating hour.
** <code>self.C_fuel = 1.39</code>: The fuel cost per liter (L) for the DG system.
** <code>self.C_fuel_adj_rate = 2</code>: The yearly escalation or reduction rate of DG fuel costs.
** <code>self.C_fuel_adj = self.C_fuel_adj_rate / 100</code>: The rate converted to a decimal form.
* Battery System:
** <code>self.C_B = 458.06</code>: The capital cost of the battery system per kWh.
** <code>self.R_B = 458.06</code>: The replacement cost of the battery per kWh.
** <code>self.MO_B = 10</code>: The annual maintenance cost per kWh.
* Charger:
** <code>self.C_CH = 149.99 * (1 + self.r_Sales_tax)</code>: The capital cost of the charger. The sales tax is applied to the cost.
** <code>self.R_CH = 149.99 * (1 + self.r_Sales_tax)</code>: The replacement cost of the charger. The sales tax is applied to the cost.
** <code>self.MO_CH = 0 * (1 + self.r_Sales_tax)</code>: The annual O&M cost for the charger. The sales tax is applied to the cost.

==== <nowiki>#</nowiki> Defining prices for electric utilities ====

* <code>self.rateStructure</code>: This parameter specifies the hourly rate structure for electricity prices. The values below for this parameter show the corresponding rate structure. Users can choose whichever fits them best.

 1 = flat rate

 2 = seasonal rate

 3 = monthly rate

 4 = tiered rate

 5 = seasonal tiered rate

 6 = monthly tiered rate

 7 = time of use rate

# <code>self.Annual_expenses</code>: This parameter represents any annual expenses in dollars associated with the grid.
# <code>self.Grid_sale_tax_rate</code>: This parameter represents the sales tax percentage applied to grid electricity prices.
# <code>self.Grid_Tax_amount</code>: This parameter represents a grid tax applied in kilowatt-hours (kWh).
# <code>self.Grid_escalation_rate</code>: This parameter defines the yearly escalation rate for grid electricity prices, expressed as a percentage.
# <code>self.Grid_credit</code>: This parameter represents any credits offered by the grid to users in dollars.
# <code>self.NEM_fee</code>: This parameter represents any one-time setup fee for net metering.

==== # Monthly service charge (buying prices) ====
<code>self.Monthly_fixed_charge_system</code>: This parameter specifies the type of monthly fixed charge structure. If It is set to "1" indicating a flat monthly rate over the year and if it is "2", indicating a tiered structure for monthly charges. The <code>self.SC_flat</code>is the monthly flat charge in structure 1.

Structure 2 includes tier-specific service charge values and limits for each tier:

<code>self.SC_1 = 2.30</code>: The service charge for tier 1 in $.

<code>self.Limit_SC_1 = 350</code>: The limit for tier 1 in kWh.

<code>self.SC_2 = 7.9</code>: The service charge for tier 2 in $.

<code>self.Limit_SC_2 = 1050</code>: The limit for tier 2 in kWh.

<code>self.SC_3 = 22.70</code>: The service charge for tier 3 in $.

<code>self.Limit_SC_3 = 1501</code>: The limit for tier 3 in kWh.

<code>self.SC_4 = 22.70</code>: The service charge for tier 4 in $.

<nowiki>#</nowiki> Utility hourly charges (buying prices)

How to define hourly charges for grid:

# '''Set Rate Structure:'''
#* Determine the rate structure you want to simulate. The rate structure is specified by the <code>self.rateStructure</code> variable.
# '''Configure Rate Parameters:'''
#* Depending on the chosen rate structure, configure the rate parameters accordingly:
#** For flat rate, set the <code>self.flatPrice</code>.
#** For seasonal rate, specify seasonal prices in <code>self.seasonalPrices</code> and define the season in <code>self.season</code>.
#** For monthly rate, provide monthly prices in <code>self.monthlyPrices</code>.
#** For tiered rate, set tiered prices in <code>self.tieredPrices</code> and tier maximums in <code>self.tierMax</code>.
#** For seasonal tiered rate, provide seasonal tiered prices and maximums in <code>self.seasonalTieredPrices</code> and <code>self.seasonalTierMax</code>.
#** For monthly tiered rate, configure monthly tiered prices and maximums in <code>self.monthlyTieredPrices</code> and <code>self.monthlyTierLimits</code>.
#** For time-of-use rate, specify on-peak, mid-peak, and off-peak prices, special hours for holidays, and the season in <code>self.onPrice</code>, <code>self.midPrice</code>, <code>self.offPrice</code>, <code>self.holidays</code>, <code>self.season</code>, and the time-of-use hours in <code>self.onHours</code> and <code>self.midHours</code>.

==== # Sell back prices to the grid ====
How to define hourly sell back prices to the grid:

# '''Set Sell Structure:'''
#* Determine the structure for selling electricity to the grid by setting the <code>self.sellStructure</code> variable. You can choose from three options:
#** <code>1</code>: Flat rate for selling electricity back to the grid.
#** <code>2</code>: Monthly rate for selling electricity back to the grid.
#** <code>3</code>: Selling electricity back to the grid at the same rate you buy it.
# '''Configure Sell Rates:'''
#* Depending on the chosen sell structure, configure the sell rates accordingly:
#** For flat rate (sellStructure = 1), set the desired flat sell rate in the <code>self.Csell</code> variable.
#** For monthly rate (sellStructure = 2), provide an array of monthly sell prices in <code>self.monthlysellprices</code>. The array should contain 12 values, one for each month.
#** For selling at the same rate as you buy (sellStructure = 3), you can set <code>self.Csell</code> to <code>self.Cbuy</code>. This means you will sell electricity back to the grid at the same rate you buy it.

==== # Grid emission information ====

* <code>self.E_CO2</code>: The emission level of carbon dioxide (CO2) in kg per kWh of electricity bought from grid.
* <code>self.E_NOx</code>: The emission level of nitrogen oxides (NOx) in kg per kWh of electricity bought from grid.
* <code>self.E_SO2</code>: The emission level of sulfur dioxide (SO2) in kg per kWh of electricity bought from grid.

==== # Constraints for buying/selling from/to grid ====
These lines of code set constraints for buying and selling electricity from/to the grid:

* <code>self.Pbuy_max</code>: This represents the maximum amount of electricity that can be bought from the grid in each hour in kW ('''Maximum buying capacity''').
* <code>self.Psell_max</code>: This represents the maximum amount of electricity that can be sold to the grid in each hour in kW ('''Maximum selling capacity''').

=== swarm.py: In this file, the optimization algorithm which particle swarm optimizer (PSO) code is written. ===

=== Fitness.py: The file including cost calculations and fitness function for optimizer. ===

=== EMS.py: Energy management strategy has been implemented inside this file. ===

=== Battery_Model.py: Chemical battery models are defined inside this file. ===

=== calcFlatRate.py, calcMonthlyRate.py, calcMonthlyTieredRate.py, calcSeasonalRate.py, calcSeasonalTieredRate.py, calcTieredRate.py, and calcTouRate.py: Electric Utility billing schemes are defined in the files above. ===