Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation updates #53

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

documentation updates #53

wants to merge 17 commits into from

Conversation

ashoksekar7
Copy link
Collaborator

first iteration of the updates before our discussion Jan 6th 2025.

first iteration of the updates before our discussion Jan 6th 2025.
updates to diffusion_functions_elec, input_data_functions, and financial_functions.
Copy link
Collaborator

@michaelavs michaelavs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start! The comments I added can be merged directly into your pull request without needing to change the code locally and re-pushing changes. After accepting [any of] the changes, make sure you re-sync your local branch with this branch from the main page of the PR and then doing a git pull on your local copy

solar_agents : 'Class'
Instance of Agents class with either user pre-generated or new data
solar_agents : :class: `agents.Agents`
Instance of Agents class with either user pre-generated or user generated agent
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This definition would also be updated to remove the "user generated" reference

ValueError
Raised if region in the pickle file
"Region not present within pre-generated agent file - Edit Inputsheet"
ValueError
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could remove line 442 through 44 by removing the agent_file_statue var

def process_load_growth(load_growth):
"""
Returns the trajectory of the load growth rates over time relative to a base year of 2014
# def process_load_growth(load_growth):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above, can remove this chunk if it is unused/outdated as the code will be tracked through GitHub

@michaelavs michaelavs added the documentation Improvements or additions to documentation label Feb 25, 2025
@michaelavs michaelavs linked an issue Feb 25, 2025 that may be closed by this pull request
ashoksekar7 and others added 14 commits March 10, 2025 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Docstrings
2 participants