-
Notifications
You must be signed in to change notification settings - Fork 4
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/rli datasets #1138
Commits on Jul 19, 2023
-
Configuration menu - View commit details
-
Copy full SHA for b89177c - Browse repository at this point
Copy the full SHA b89177cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 72594b6 - Browse repository at this point
Copy the full SHA 72594b6View commit details -
Configuration menu - View commit details
-
Copy full SHA for 786e09f - Browse repository at this point
Copy the full SHA 786e09fView commit details -
Configuration menu - View commit details
-
Copy full SHA for b39d8da - Browse repository at this point
Copy the full SHA b39d8daView commit details
Commits on Jul 24, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 3aecc2e - Browse repository at this point
Copy the full SHA 3aecc2eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 043a3af - Browse repository at this point
Copy the full SHA 043a3afView commit details
Commits on Jul 25, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 9034ab5 - Browse repository at this point
Copy the full SHA 9034ab5View commit details
Commits on Jul 27, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 8d92e19 - Browse repository at this point
Copy the full SHA 8d92e19View commit details
Commits on Jul 28, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 8bb6d3c - Browse repository at this point
Copy the full SHA 8bb6d3cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 616c1b0 - Browse repository at this point
Copy the full SHA 616c1b0View commit details
Commits on Aug 3, 2023
-
Configuration menu - View commit details
-
Copy full SHA for e6e9cf9 - Browse repository at this point
Copy the full SHA e6e9cf9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0adaa2d - Browse repository at this point
Copy the full SHA 0adaa2dView commit details -
Configuration menu - View commit details
-
Copy full SHA for fd9c20c - Browse repository at this point
Copy the full SHA fd9c20cView commit details -
Configuration menu - View commit details
-
Copy full SHA for 17cf1e0 - Browse repository at this point
Copy the full SHA 17cf1e0View commit details -
Configuration menu - View commit details
-
Copy full SHA for 661f35d - Browse repository at this point
Copy the full SHA 661f35dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 29fea37 - Browse repository at this point
Copy the full SHA 29fea37View commit details -
Configuration menu - View commit details
-
Copy full SHA for 91ee41a - Browse repository at this point
Copy the full SHA 91ee41aView commit details -
Configuration menu - View commit details
-
Copy full SHA for c10c668 - Browse repository at this point
Copy the full SHA c10c668View commit details -
Configuration menu - View commit details
-
Copy full SHA for d936f78 - Browse repository at this point
Copy the full SHA d936f78View commit details -
Configuration menu - View commit details
-
Copy full SHA for a49218d - Browse repository at this point
Copy the full SHA a49218dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 75a783a - Browse repository at this point
Copy the full SHA 75a783aView commit details -
Configuration menu - View commit details
-
Copy full SHA for c7617f4 - Browse repository at this point
Copy the full SHA c7617f4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1971b38 - Browse repository at this point
Copy the full SHA 1971b38View commit details -
Configuration menu - View commit details
-
Copy full SHA for dc3da12 - Browse repository at this point
Copy the full SHA dc3da12View commit details -
Configuration menu - View commit details
-
Copy full SHA for d1af462 - Browse repository at this point
Copy the full SHA d1af462View commit details -
Configuration menu - View commit details
-
Copy full SHA for b4299f1 - Browse repository at this point
Copy the full SHA b4299f1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9bba524 - Browse repository at this point
Copy the full SHA 9bba524View commit details -
Configuration menu - View commit details
-
Copy full SHA for 6874073 - Browse repository at this point
Copy the full SHA 6874073View commit details -
Configuration menu - View commit details
-
Copy full SHA for a60f450 - Browse repository at this point
Copy the full SHA a60f450View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5de2d89 - Browse repository at this point
Copy the full SHA 5de2d89View commit details -
Configuration menu - View commit details
-
Copy full SHA for adac700 - Browse repository at this point
Copy the full SHA adac700View commit details -
Configuration menu - View commit details
-
Copy full SHA for ab3ea87 - Browse repository at this point
Copy the full SHA ab3ea87View commit details -
Configuration menu - View commit details
-
Copy full SHA for c08cba9 - Browse repository at this point
Copy the full SHA c08cba9View commit details -
Configuration menu - View commit details
-
Copy full SHA for e6298d0 - Browse repository at this point
Copy the full SHA e6298d0View commit details -
Configuration menu - View commit details
-
Copy full SHA for f47c33d - Browse repository at this point
Copy the full SHA f47c33dView commit details -
Configuration menu - View commit details
-
Copy full SHA for e0c566c - Browse repository at this point
Copy the full SHA e0c566cView commit details -
Configuration menu - View commit details
-
Copy full SHA for b2d9eab - Browse repository at this point
Copy the full SHA b2d9eabView commit details -
Configuration menu - View commit details
-
Copy full SHA for cc9143b - Browse repository at this point
Copy the full SHA cc9143bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 522f416 - Browse repository at this point
Copy the full SHA 522f416View commit details -
Configuration menu - View commit details
-
Copy full SHA for 108698f - Browse repository at this point
Copy the full SHA 108698fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 2bd723b - Browse repository at this point
Copy the full SHA 2bd723bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 7c752d7 - Browse repository at this point
Copy the full SHA 7c752d7View commit details -
Configuration menu - View commit details
-
Copy full SHA for d7526fe - Browse repository at this point
Copy the full SHA d7526feView commit details -
Configuration menu - View commit details
-
Copy full SHA for e0cdd60 - Browse repository at this point
Copy the full SHA e0cdd60View commit details -
Configuration menu - View commit details
-
Copy full SHA for f40f5b1 - Browse repository at this point
Copy the full SHA f40f5b1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5b74ce0 - Browse repository at this point
Copy the full SHA 5b74ce0View commit details -
Configuration menu - View commit details
-
Copy full SHA for 96ba824 - Browse repository at this point
Copy the full SHA 96ba824View commit details -
Configuration menu - View commit details
-
Copy full SHA for f685cff - Browse repository at this point
Copy the full SHA f685cffView commit details -
Configuration menu - View commit details
-
Copy full SHA for 521c661 - Browse repository at this point
Copy the full SHA 521c661View commit details
Commits on Aug 7, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 35f88eb - Browse repository at this point
Copy the full SHA 35f88ebView commit details -
Configuration menu - View commit details
-
Copy full SHA for b736cef - Browse repository at this point
Copy the full SHA b736cefView commit details -
Configuration menu - View commit details
-
Copy full SHA for 9b9c3b4 - Browse repository at this point
Copy the full SHA 9b9c3b4View commit details
Commits on Aug 8, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 14f0a58 - Browse repository at this point
Copy the full SHA 14f0a58View commit details
Commits on Aug 9, 2023
-
Wrap docstring lines at 72ish characters
[PEP 8][0] actually specifies a maximum line length of 72 characters for "flowing long blocks of text with fewer structural restrictions (docstrings or comments)". I extended that to 76 characters for indented docstrings, because the reason for having 72 characters is so that the eyes don't have to travel horizontally too much. Indentation basically moves the start of the text block to the right, so for text blocks like this, the line length limit can move with the indentation. Some of these lines where even beyond 79 characters, so I had to touch them anyways to make `flake8` happy and while at it, I also changed them to be (mostly) PEP 8 compliant. [0]: https://peps.python.org/pep-0008/#maximum-line-length
Configuration menu - View commit details
-
Copy full SHA for 6c87ee9 - Browse repository at this point
Copy the full SHA 6c87ee9View commit details -
Configuration menu - View commit details
-
Copy full SHA for a1423b9 - Browse repository at this point
Copy the full SHA a1423b9View commit details -
Shorten line to below 79 characters
Moving `OsmBuildingsSynthetic.n_amenities_inside.type` into a variable is done to work around a bug in `black`. Without this, `black` would always reformat the line to be exactly 80 characters, even if a limit of 79 is set, making `flake8` complain.
Configuration menu - View commit details
-
Copy full SHA for 3aae1d4 - Browse repository at this point
Copy the full SHA 3aae1d4View commit details -
Configuration menu - View commit details
-
Copy full SHA for e0a702b - Browse repository at this point
Copy the full SHA e0a702bView commit details -
Add a
Tasks
type alias to thedatasets
moduleThis helps when specifying subclasses of `Dataset`. Since there was already a `Tasks` class inside the module, that class got renamed to `Tasks_` because it could not be used for the purposes of the type.
Configuration menu - View commit details
-
Copy full SHA for 4562882 - Browse repository at this point
Copy the full SHA 4562882View commit details -
Replace
partial
s ofDataset
with subclassesMake these subclasses `@dataclass`es, just like the original `Dataset`, so that default values for the fields are picked up by the constructor. That way we don't have to specify a constructor that calls the superclass constructor, but can rely on the default implementation for `__init__`. The `dependencies=[]` line present in nearly all uses of `partial` has been removed because it was unnecessary. The `dependencies` parameter is usually specified when the datasets are instantiated and even if not, an empty list of dependencies is the default anyways. Actually, an empty tuple is the default, but that doesn't make a difference. The `tasks=(define_mv_grid_districts)` line has been changed to drop the parenthesis because the parenthesis where superfluous in this case. The `tasks=(download_mastr_data,)` line has not been changed, because even though `Dataset`s should handle a callable and a tuple containing exactly one callable identically for the tasks attribute, I didn't want to risk introducing any bugs.
Configuration menu - View commit details
-
Copy full SHA for ecf2a63 - Browse repository at this point
Copy the full SHA ecf2a63View commit details
Commits on Aug 10, 2023
-
Merge pull request #1145 from openego/documentation/rli-datasets/repl…
…ace-partial-with-class Replace `partial` applications of `Dataset` with `Dataset` subclasses
Configuration menu - View commit details
-
Copy full SHA for ddadce1 - Browse repository at this point
Copy the full SHA ddadce1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5d27af3 - Browse repository at this point
Copy the full SHA 5d27af3View commit details -
Configuration menu - View commit details
-
Copy full SHA for 405695b - Browse repository at this point
Copy the full SHA 405695bView commit details -
Configuration menu - View commit details
-
Copy full SHA for dc144f3 - Browse repository at this point
Copy the full SHA dc144f3View commit details -
Configuration menu - View commit details
-
Copy full SHA for 5bda166 - Browse repository at this point
Copy the full SHA 5bda166View commit details
Commits on Aug 11, 2023
-
Tell Sphinx not to expand some type aliases
Namely `egon.data.datasets.Dependencies` and `egon.data.datasets.Tasks`. Hopefully this makes the documentation of dataset subclasses using `@dataclass` less confusing. Solution taken from a helpful [answer] on stackoverflow. [0]: https://stackoverflow.com/a/67483317
Configuration menu - View commit details
-
Copy full SHA for 6198a1a - Browse repository at this point
Copy the full SHA 6198a1aView commit details -
Uppercase SQL built-ins in SQL code block
At least all those, which Sphinx highlights in boldface.
Configuration menu - View commit details
-
Copy full SHA for 64af889 - Browse repository at this point
Copy the full SHA 64af889View commit details -
Add an article to a documentation sentence
IMHO it's more readable this way. Feel free to remove the commit if you don't concur.
Configuration menu - View commit details
-
Copy full SHA for c570601 - Browse repository at this point
Copy the full SHA c570601View commit details -
Make SQL code block in documentation more compact
By removing an unnecessary level of indentation.
Configuration menu - View commit details
-
Copy full SHA for f03282a - Browse repository at this point
Copy the full SHA f03282aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 046ce40 - Browse repository at this point
Copy the full SHA 046ce40View commit details -
Configuration menu - View commit details
-
Copy full SHA for cae7e59 - Browse repository at this point
Copy the full SHA cae7e59View commit details -
Manually specify
Dataset
subclass constructorsInstead of relying on `@dataclass` to provide one. This makes the constructor's signature less confusing. I also allows not specifying types for the class variables, because `@dataclass` no longer needs to pick the up automatically, as we are manually specifying them in the superclass constructor call. This means we have less stuff to import, most notably we no longer need to import `Tasks`. This also allows us to work around the broken display of `mv_grid_districts_setup`'s `tasks`. That was only a single function and for some reason Sphinx did not display that one correctly. Probably because it tried to use `str` instead of `repr` to render the function, because boxing the function in a one-tuple would fix the display. Anyway. Not putting the task on a class attribute but specifying it directly in the constructor means that no class attribute is displayed in the documentation, thus sidestepping the issue.
Configuration menu - View commit details
-
Copy full SHA for 4ea3809 - Browse repository at this point
Copy the full SHA 4ea3809View commit details -
Configuration menu - View commit details
-
Copy full SHA for af31b60 - Browse repository at this point
Copy the full SHA af31b60View commit details -
Merge branch 'documentation/rli_datasets' into documentation/rli-data…
…sets/alternative-partial-replacements
Configuration menu - View commit details
-
Copy full SHA for 32b93b5 - Browse repository at this point
Copy the full SHA 32b93b5View commit details -
Merge branch for alternative replacement for datasets previously crea…
…ted with partial Propose alternative replacements for partial.
Configuration menu - View commit details
-
Copy full SHA for e10ab8b - Browse repository at this point
Copy the full SHA e10ab8bView commit details -
Merge branch 'dev' into documentation/rli_datasets
src/egon/data/datasets/emobility/heavy_duty_transport/h2_demand_distribution.py
Configuration menu - View commit details
-
Copy full SHA for ad87ecf - Browse repository at this point
Copy the full SHA ad87ecfView commit details -
Get rid of duplicated documentation and cross-reference data and data…
…set documentation
Configuration menu - View commit details
-
Copy full SHA for 7272c90 - Browse repository at this point
Copy the full SHA 7272c90View commit details
Commits on Aug 31, 2023
-
Configuration menu - View commit details
-
Copy full SHA for 578054d - Browse repository at this point
Copy the full SHA 578054dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 919c0e4 - Browse repository at this point
Copy the full SHA 919c0e4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4047b97 - Browse repository at this point
Copy the full SHA 4047b97View commit details