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/rli datasets #1138

Merged
merged 79 commits into from
Aug 31, 2023
Merged

Documentation/rli datasets #1138

merged 79 commits into from
Aug 31, 2023

Commits on Jul 19, 2023

  1. Document VG250 dataset

    birgits committed Jul 19, 2023
    Configuration menu
    Copy the full SHA
    b89177c View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    72594b6 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    786e09f View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    b39d8da View commit details
    Browse the repository at this point in the history

Commits on Jul 24, 2023

  1. Configuration menu
    Copy the full SHA
    3aecc2e View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    043a3af View commit details
    Browse the repository at this point in the history

Commits on Jul 25, 2023

  1. Configuration menu
    Copy the full SHA
    9034ab5 View commit details
    Browse the repository at this point in the history

Commits on Jul 27, 2023

  1. Configuration menu
    Copy the full SHA
    8d92e19 View commit details
    Browse the repository at this point in the history

Commits on Jul 28, 2023

  1. Configuration menu
    Copy the full SHA
    8bb6d3c View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    616c1b0 View commit details
    Browse the repository at this point in the history

Commits on Aug 3, 2023

  1. Add dataset documentation

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    e6e9cf9 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    0adaa2d View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    fd9c20c View commit details
    Browse the repository at this point in the history
  4. Add dataset documentation for CHP

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    17cf1e0 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    661f35d View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    29fea37 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    91ee41a View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    c10c668 View commit details
    Browse the repository at this point in the history
  9. Black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    d936f78 View commit details
    Browse the repository at this point in the history
  10. Add dataset documentation

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    a49218d View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    75a783a View commit details
    Browse the repository at this point in the history
  12. Remove unused lines

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    c7617f4 View commit details
    Browse the repository at this point in the history
  13. Fix typo in link to Vg250 dataset

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    1971b38 View commit details
    Browse the repository at this point in the history
  14. Link to database setup function

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    dc3da12 View commit details
    Browse the repository at this point in the history
  15. Split long line strings

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    d1af462 View commit details
    Browse the repository at this point in the history
  16. Minor fixes

    birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    b4299f1 View commit details
    Browse the repository at this point in the history
  17. Configuration menu
    Copy the full SHA
    9bba524 View commit details
    Browse the repository at this point in the history
  18. Apply black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    6874073 View commit details
    Browse the repository at this point in the history
  19. Configuration menu
    Copy the full SHA
    a60f450 View commit details
    Browse the repository at this point in the history
  20. Configuration menu
    Copy the full SHA
    5de2d89 View commit details
    Browse the repository at this point in the history
  21. Apply black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    adac700 View commit details
    Browse the repository at this point in the history
  22. Add dataset description for TYNDP

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    ab3ea87 View commit details
    Browse the repository at this point in the history
  23. Apply black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    c08cba9 View commit details
    Browse the repository at this point in the history
  24. Configuration menu
    Copy the full SHA
    e6298d0 View commit details
    Browse the repository at this point in the history
  25. Apply black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    f47c33d View commit details
    Browse the repository at this point in the history
  26. Configuration menu
    Copy the full SHA
    e0c566c View commit details
    Browse the repository at this point in the history
  27. Apply black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    b2d9eab View commit details
    Browse the repository at this point in the history
  28. Configuration menu
    Copy the full SHA
    cc9143b View commit details
    Browse the repository at this point in the history
  29. Apply black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    522f416 View commit details
    Browse the repository at this point in the history
  30. Fix typo

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    108698f View commit details
    Browse the repository at this point in the history
  31. Configuration menu
    Copy the full SHA
    2bd723b View commit details
    Browse the repository at this point in the history
  32. Apply black

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    7c752d7 View commit details
    Browse the repository at this point in the history
  33. Extend list of resulting tables

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    d7526fe View commit details
    Browse the repository at this point in the history
  34. Fix name of Tyndp dataset

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    e0cdd60 View commit details
    Browse the repository at this point in the history
  35. Fix links to dependencies

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    f40f5b1 View commit details
    Browse the repository at this point in the history
  36. Fix typo

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    5b74ce0 View commit details
    Browse the repository at this point in the history
  37. Fix links to dependencies

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    96ba824 View commit details
    Browse the repository at this point in the history
  38. Fix link to database.setup

    ClaraBuettner authored and birgits committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    f685cff View commit details
    Browse the repository at this point in the history
  39. Configuration menu
    Copy the full SHA
    521c661 View commit details
    Browse the repository at this point in the history

Commits on Aug 7, 2023

  1. Configuration menu
    Copy the full SHA
    35f88eb View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    b736cef View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    9b9c3b4 View commit details
    Browse the repository at this point in the history

Commits on Aug 8, 2023

  1. Configuration menu
    Copy the full SHA
    14f0a58 View commit details
    Browse the repository at this point in the history

Commits on Aug 9, 2023

  1. 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
    gnn committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    6c87ee9 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a1423b9 View commit details
    Browse the repository at this point in the history
  3. 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.
    gnn committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    3aae1d4 View commit details
    Browse the repository at this point in the history
  4. Reformat with black

    gnn committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    e0a702b View commit details
    Browse the repository at this point in the history
  5. Add a Tasks type alias to the datasets module

    This 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.
    gnn committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    4562882 View commit details
    Browse the repository at this point in the history
  6. Replace partials of Dataset with subclasses

    Make 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.
    gnn committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    ecf2a63 View commit details
    Browse the repository at this point in the history

Commits on Aug 10, 2023

  1. Merge pull request #1145 from openego/documentation/rli-datasets/repl…

    …ace-partial-with-class
    
    Replace `partial` applications of `Dataset` with `Dataset` subclasses
    birgits committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    ddadce1 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    5d27af3 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    405695b View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    dc144f3 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    5bda166 View commit details
    Browse the repository at this point in the history

Commits on Aug 11, 2023

  1. 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
    gnn committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    6198a1a View commit details
    Browse the repository at this point in the history
  2. Uppercase SQL built-ins in SQL code block

    At least all those, which Sphinx highlights in boldface.
    gnn committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    64af889 View commit details
    Browse the repository at this point in the history
  3. 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.
    gnn committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    c570601 View commit details
    Browse the repository at this point in the history
  4. Make SQL code block in documentation more compact

    By removing an unnecessary level of indentation.
    gnn committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    f03282a View commit details
    Browse the repository at this point in the history
  5. Wrap docstrings at 76 characters

    gnn committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    046ce40 View commit details
    Browse the repository at this point in the history
  6. Add some blank lines

    Courtesy of `black`.
    gnn committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    cae7e59 View commit details
    Browse the repository at this point in the history
  7. Manually specify Dataset subclass constructors

    Instead 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.
    gnn committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    4ea3809 View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    af31b60 View commit details
    Browse the repository at this point in the history
  9. Merge branch 'documentation/rli_datasets' into documentation/rli-data…

    …sets/alternative-partial-replacements
    birgits committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    32b93b5 View commit details
    Browse the repository at this point in the history
  10. Merge branch for alternative replacement for datasets previously crea…

    …ted with partial
    
    Propose alternative replacements for partial.
    birgits committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    e10ab8b View commit details
    Browse the repository at this point in the history
  11. Merge branch 'dev' into documentation/rli_datasets

    src/egon/data/datasets/emobility/heavy_duty_transport/h2_demand_distribution.py
    birgits committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    ad87ecf View commit details
    Browse the repository at this point in the history
  12. Configuration menu
    Copy the full SHA
    7272c90 View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2023

  1. PEP changes

    birgits committed Aug 31, 2023
    Configuration menu
    Copy the full SHA
    578054d View commit details
    Browse the repository at this point in the history
  2. Add references

    birgits committed Aug 31, 2023
    Configuration menu
    Copy the full SHA
    919c0e4 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    4047b97 View commit details
    Browse the repository at this point in the history