Refine nametuple tutorial #1071
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Parth-Vachhani
commented
May 30, 2024
Parth-Vachhani
commented
- Describe your pull request as transparent as possible
- What functionality does it implement?
- Where is it located?
- How does the API look?
- ...
- Related issues?
- Share your knowledge: Insights/Remarks
- Other comments and questions
- For new features: Remember the documentation!
This is not really "basic" and can lead to errors. I still left it in and put some additional explanation so that beginners learn about the concept but do not have it in their code without thinking about it.
Set oemof.network requirement to stable release
We require the experimental feature warning.
I think it will increase maintainability if we do not have to care for compatibility with Pandas 1.x. (I used new features for a solph tutorial and people had unexpected problems because of unsupported features in their Pandas installation.)
…anced readability.
Explicitly pass `custom_properties` to `network.Node` class
Although it is just an example, having hard-coded unreachable code can be considered bad style.
Co-authored-by: Patrik Schönfeldt <[email protected]>
Co-authored-by: Patrik Schönfeldt <[email protected]>
… British 'Optimise'-Spelling-version
Improved variable naming and formatting in 'basic_example.py' for enh…
Deactivate dump/restore in basic example
…etConverter Multiple Outputs for OffsetConverter
I did not touch the multi-period-model as I think the constraint for this (experimental) mode needs refactoring anyway.
The auto-stretch feature of the _Sequence contained hidden magic, as it tracked the last "entry" that has been accessed and pretended to have a length based on this. So, outcomes depend on something that is assumed to be a read access. Also, self.data was erived from UserList but never really supported all of the expected functionality in a consistent way. The new _FakeSequence is a lot simpler. In particular it has an explicit (fake) length that needs to be set before casting to (stretched) lists. The default length is still set, because there is an entry, and to allow to directly iterate over a _FakeSequence, e.g. in sum().
To allow this, some checks need to more explicit, now. As solph.sequence will return a _FakeSequence or a numpy.array, other members of _FakeSequence mimic the API of numpy.array. In particular, this allows min/max/sum operations in constant time.
We can test for the _FakeSequence class to see that something really is a scalar.
…uence Replace _Sequence by _FakeSequence
…ral_limit Allow lower limit for generic_integral_limit
Formulate full_load_time docstring specific for energy
…l-level Fix/storage costs for initial level
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.