Skip to content

Commit

Permalink
Added option to select inverter+add custom inputs (#147)
Browse files Browse the repository at this point in the history 
* provides option for no_inverter and inverter

* user inputs
  • Loading branch information
@aryanbhosale
aryanbhosale authored Jul 16, 2024
1 parent 1840f3a commit bd385d5
Showing 1 changed file with 161 additions and 56 deletions.
217 changes: 161 additions & 56 deletions examples/streamlit_app/app.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,15 @@
logo_path = os.path.join(script_dir, "logo.png")
im = Image.open(logo_path)

st.set_page_config(page_title="Open Source Quartz Solar Forecast | Open Climate Fix", layout="wide", page_icon=im)

st.set_page_config(
page_title="Open Source Quartz Solar Forecast | Open Climate Fix",
layout="wide",
page_icon=im,
)
st.title("☀️ Open Source Quartz Solar Forecast")

def get_enphase_auth_url():
client_id = os.getenv('ENPHASE_CLIENT_ID')
client_id = os.getenv("ENPHASE_CLIENT_ID")
redirect_uri = "https://api.enphaseenergy.com/oauth/redirect_uri"
params = {
"response_type": "code",
Expand All @@ -52,17 +55,15 @@ def get_enphase_auth_url():
return auth_url

def get_enphase_access_token(auth_code):
client_id = os.getenv('ENPHASE_CLIENT_ID')
client_secret = os.getenv('ENPHASE_CLIENT_SECRET')
client_id = os.getenv("ENPHASE_CLIENT_ID")
client_secret = os.getenv("ENPHASE_CLIENT_SECRET")

credentials = f"{client_id}:{client_secret}"
credentials_bytes = credentials.encode("utf-8")
encoded_credentials = base64.b64encode(credentials_bytes).decode("utf-8")
conn = http.client.HTTPSConnection("api.enphaseenergy.com")
payload = ""
headers = {
"Authorization": f"Basic {encoded_credentials}"
}
headers = {"Authorization": f"Basic {encoded_credentials}"}
conn.request(
"POST",
f"/oauth/token?grant_type=authorization_code&redirect_uri=https://api.enphaseenergy.com/oauth/redirect_uri&code={auth_code}",
Expand All @@ -77,26 +78,25 @@ def get_enphase_access_token(auth_code):

# Convert the decoded data into JSON format
data_json = json.loads(decoded_data)

if 'error' in data_json:
raise ValueError(f"Error in getting access token: {data_json['error_description']}")

if 'access_token' not in data_json:

if "error" in data_json:
raise ValueError(
f"Error in getting access token: {data_json['error_description']}"
)

if "access_token" not in data_json:
raise KeyError(f"Access token not found in response. Response: {data_json}")

access_token = data_json["access_token"]
return access_token

def get_enphase_data(enphase_system_id: str, access_token: str) -> pd.DataFrame:
api_key = os.getenv('ENPHASE_API_KEY')
api_key = os.getenv("ENPHASE_API_KEY")
start_at = int((datetime.now() - timedelta(weeks=1)).timestamp())
granularity = "week"

conn = http.client.HTTPSConnection("api.enphaseenergy.com")
headers = {
"Authorization": f"Bearer {str(access_token)}",
"key": str(api_key)
}
headers = {"Authorization": f"Bearer {str(access_token)}", "key": str(api_key)}

url = f"/api/v4/systems/{enphase_system_id}/telemetry/production_micro?start_at={start_at}&granularity={granularity}"
conn.request("GET", url, headers=headers)
Expand All @@ -108,96 +108,176 @@ def get_enphase_data(enphase_system_id: str, access_token: str) -> pd.DataFrame:
return process_enphase_data(data_json, start_at)

def enphase_authorization():
if 'access_token' not in st.session_state:
if "access_token" not in st.session_state:
auth_url = get_enphase_auth_url()
st.write("Please visit the following URL to authorize the application:")
st.markdown(f"[Enphase Authorization URL]({auth_url})")
st.write("After authorization, you will be redirected to a URL. Please copy the entire URL and paste it below:")
st.write(
"After authorization, you will be redirected to a URL. Please copy the entire URL and paste it below:"
)

redirect_url = st.text_input("Enter the redirect URL:")

if redirect_url:
if "?code=" not in redirect_url:
st.error("Invalid redirect URL. Please make sure you copied the entire URL.")
st.error(
"Invalid redirect URL. Please make sure you copied the entire URL."
)
return None, None

auth_code = redirect_url.split("?code=")[1]

try:
access_token = get_enphase_access_token(auth_code)
st.session_state['access_token'] = access_token
return access_token, os.getenv('ENPHASE_SYSTEM_ID')
st.session_state["access_token"] = access_token
return access_token, os.getenv("ENPHASE_SYSTEM_ID")
except Exception as e:
st.error(f"Error getting access token: {str(e)}")
return None, None
else:
return st.session_state['access_token'], os.getenv('ENPHASE_SYSTEM_ID')
return st.session_state["access_token"], os.getenv("ENPHASE_SYSTEM_ID")

return None, None

def make_pv_data(site: PVSite, ts: pd.Timestamp, access_token: str = None, enphase_system_id: str = None) -> xr.Dataset:
def make_pv_data(
site: PVSite,
ts: pd.Timestamp,
access_token: str = None,
enphase_system_id: str = None,
) -> xr.Dataset:
live_generation_kw = None

if site.inverter_type == 'enphase' and access_token and enphase_system_id:
if site.inverter_type == "enphase" and access_token and enphase_system_id:
live_generation_kw = get_enphase_data(enphase_system_id, access_token)

da = process_pv_data(live_generation_kw, ts, site)
return da

def predict_ocf(site: PVSite, model=None, ts: datetime | str = None, nwp_source: str = "icon", access_token: str = None, enphase_system_id: str = None):
def predict_ocf(
site: PVSite,
model=None,
ts: datetime | str = None,
nwp_source: str = "icon",
access_token: str = None,
enphase_system_id: str = None,
):
if ts is None:
ts = pd.Timestamp.now().round("15min")
if isinstance(ts, str):
ts = datetime.fromisoformat(ts)

nwp_xr = get_nwp(site=site, ts=ts, nwp_source=nwp_source)
pv_xr = make_pv_data(site=site, ts=ts, access_token=access_token, enphase_system_id=enphase_system_id)
pv_xr = make_pv_data(
site=site, ts=ts, access_token=access_token, enphase_system_id=enphase_system_id
)

pred_df = forecast_v1_tilt_orientation(nwp_source, nwp_xr, pv_xr, ts, model=model)
return pred_df

def run_forecast(site: PVSite, model: str = "gb", ts: datetime | str = None, nwp_source: str = "icon", access_token: str = None, enphase_system_id: str = None) -> pd.DataFrame:
def run_forecast(
site: PVSite,
model: str = "gb",
ts: datetime | str = None,
nwp_source: str = "icon",
access_token: str = None,
enphase_system_id: str = None,
) -> pd.DataFrame:
if model == "gb":
return predict_ocf(site, None, ts, nwp_source, access_token, enphase_system_id)
elif model == "xgb":
return predict_tryolabs(site, ts)
else:
else:
raise ValueError(f"Unsupported model: {model}. Choose between 'xgb' and 'gb'")

def fetch_data_and_run_forecast(access_token: str = None, enphase_system_id: str = None):
def fetch_data_and_run_forecast(
site: PVSite,
access_token: str = None,
enphase_system_id: str = None
):
with st.spinner("Running forecast..."):
try:
timestamp = datetime.now().timestamp()
timestamp_str = datetime.fromtimestamp(timestamp, tz=timezone.utc).strftime('%Y-%m-%d %H:%M:%S')
timestamp_str = datetime.fromtimestamp(timestamp, tz=timezone.utc).strftime(
"%Y-%m-%d %H:%M:%S"
)
ts = pd.to_datetime(timestamp_str)

# TO-DO: user inputs for latitude, longitude, and capacity_kwp
site_live = PVSite(latitude=51.75, longitude=-1.25, capacity_kwp=1.25, inverter_type="enphase")
site_no_live = PVSite(latitude=51.75, longitude=-1.25, capacity_kwp=1.25)
# Run forecast with the given site
predictions_with_inverter = run_forecast(
site=site,
ts=ts,
access_token=access_token,
enphase_system_id=enphase_system_id,
)

predictions_with_recent_pv_df = run_forecast(site=site_live, ts=ts, access_token=access_token, enphase_system_id=enphase_system_id)
predictions_df = run_forecast(site=site_no_live, ts=ts)
# Create a site without inverter for comparison
site_without_inverter = PVSite(
latitude=site.latitude,
longitude=site.longitude,
capacity_kwp=site.capacity_kwp
)
predictions_without_inverter = run_forecast(site=site_without_inverter, ts=ts)

predictions_with_recent_pv_df["power_kw_no_live_pv"] = predictions_df["power_kw"]
# Combine the results
predictions_df = predictions_with_inverter.copy()
predictions_df["power_kw_no_live_pv"] = predictions_without_inverter["power_kw"]

return predictions_with_recent_pv_df, ts
return predictions_df, ts

except Exception as e:
logger.error(f"An error occurred: {str(e)}")
st.error(f"An error occurred: {str(e)}")
return None, None

# Main app logic
if 'access_token' not in st.session_state:
access_token, enphase_system_id = enphase_authorization()
st.sidebar.header("PV Site Configuration")

use_defaults = st.sidebar.checkbox("Use Default Values", value=True)

if use_defaults:
latitude = 51.75
longitude = -1.25
capacity_kwp = 1.25
st.sidebar.text(f"Default Latitude: {latitude}")
st.sidebar.text(f"Default Longitude: {longitude}")
st.sidebar.text(f"Default Capacity (kWp): {capacity_kwp}")
else:
access_token, enphase_system_id = st.session_state['access_token'], os.getenv('ENPHASE_SYSTEM_ID')
latitude = st.sidebar.number_input("Latitude", min_value=-90.0, max_value=90.0, value=51.75, step=0.01)
longitude = st.sidebar.number_input("Longitude", min_value=-180.0, max_value=180.0, value=-1.25, step=0.01)
capacity_kwp = st.sidebar.number_input("Capacity (kWp)", min_value=0.1, value=1.25, step=0.01)

if st.button("Run Forecast"):
if access_token:
predictions_with_recent_pv_df, ts = fetch_data_and_run_forecast(access_token, enphase_system_id)
inverter_type = st.sidebar.selectbox("Select Inverter", ["No Inverter", "Enphase"])

if predictions_with_recent_pv_df is not None:
access_token = None
enphase_system_id = None

if inverter_type == "Enphase":
if "access_token" not in st.session_state:
access_token, enphase_system_id = enphase_authorization()
else:
access_token, enphase_system_id = st.session_state["access_token"], os.getenv(
"ENPHASE_SYSTEM_ID"
)

if st.sidebar.button("Run Forecast"):
if inverter_type == "Enphase" and (access_token is None or enphase_system_id is None):
st.error(
"Enphase authorization is required. Please complete the authorization process."
)
else:
# Create PVSite object with user-input or default values
site = PVSite(
latitude=latitude,
longitude=longitude,
capacity_kwp=capacity_kwp,
inverter_type="enphase" if inverter_type == "Enphase" else "none" # Changed this line
)

predictions_df, ts = fetch_data_and_run_forecast(
site, access_token, enphase_system_id
)

if predictions_df is not None:
st.success("Forecast completed successfully!")

# Display current timestamp
Expand All @@ -207,26 +287,51 @@ def fetch_data_and_run_forecast(access_token: str = None, enphase_system_id: str
col1, col2, col3 = st.columns(3)

with col1:
st.metric("Current Power", f"{predictions_with_recent_pv_df['power_kw'].iloc[-1]:.2f} kW")
st.metric(
"Current Power", f"{predictions_df['power_kw'].iloc[-1]:.2f} kW"
)

with col2:
total_energy = predictions_with_recent_pv_df['power_kw'].sum() * 0.25 # Assuming 15-minute intervals
total_energy = (
predictions_df["power_kw"].sum() * 0.25
) # Assuming 15-minute intervals
st.metric("Total Forecasted Energy", f"{total_energy:.2f} kWh")

with col3:
peak_power = predictions_with_recent_pv_df['power_kw'].max()
peak_power = predictions_df["power_kw"].max()
st.metric("Peak Forecasted Power", f"{peak_power:.2f} kW")

# Create a line chart of power generation
fig = px.line(predictions_with_recent_pv_df.reset_index(),
x='index', y=['power_kw', 'power_kw_no_live_pv'],
title='Forecasted Power Generation Comparison')
fig.update_layout(xaxis_title="Time", yaxis_title="Power (kW)")
fig = px.line(
predictions_df.reset_index(),
x="index",
y=["power_kw", "power_kw_no_live_pv"],
title="Forecasted Power Generation Comparison",
labels={
"power_kw": "Forecast with selected inverter type",
"power_kw_no_live_pv": "Forecast without recent PV data"
}
)

fig.update_layout(
xaxis_title="Time",
yaxis_title="Power (kW)",
legend_title="Forecast Type",
legend=dict(
yanchor="top",
y=0.99,
xanchor="left",
x=0.01
)
)

st.plotly_chart(fig, use_container_width=True)

# Display raw data
st.subheader("Raw Forecast Data")
st.dataframe(predictions_with_recent_pv_df.reset_index())
predictions_df_display = predictions_df.reset_index().rename(columns={'index': 'Date'})
predictions_df_display = predictions_df_display.set_index('Date')
st.dataframe(predictions_df_display, use_container_width=True)

# Some information about the app

Expand All @@ -243,4 +348,4 @@ def fetch_data_and_run_forecast(access_token: str = None, enphase_system_id: str

# Footer
st.markdown("---")
st.markdown(f"Created with ❤️ by [Open Climate Fix](https://openclimatefix.org/)")
st.markdown(f"Created with ❤️ by [Open Climate Fix](https://openclimatefix.org/)")

0 comments on commit bd385d5

Please sign in to comment.