Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Update ModelChain.run_model documentation #1116

Copy link
Copy link
@Peque

Description

@Peque
Issue body actions

Related to this thread in Google Groups about difficulties when trying to go from object-oriented to procedural API.

So basically .run_model() does a great job at simplifying the required code in order to run a simulation, but it does a lot of "magic" behind the scenes and it is not easy to follow all the logic just looking at the source code, so maybe some documentation could be added to improve this. How much or where to add it? (docstring, an example under docs/...) I don't know. 😇 But if you tell me, I'd be happy to contribute a PR.

For this particular case, it was not clear to me that .run_model() was, when calculating the solar position apparent zenith, using the TMY air temperature series and the calculated pressure at the given altitude.

Maybe I could update the example in the documentation to make the results match exactly? At least this way there is an example on how to use both paradigms to get the same results.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.