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

[FEATURE] use data_types in python core #525

Open
5 tasks
mgovers opened this issue Mar 13, 2024 · 0 comments
Open
5 tasks

[FEATURE] use data_types in python core #525

mgovers opened this issue Mar 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation feature New feature or request good first issue Indicates a good issue for first-time contributors

Comments

@mgovers
Copy link
Member

mgovers commented Mar 13, 2024

This will help users provide the correct data types to the power grid model

Context

The data types are now declared in the user-level module, but would also be really useful in the core. In addition, there are a couple other things that are useful both in the core and for users, namely (this is already done):

  • src/power_grid_model/data_types.py
  • the functionality included from _utils into utils.py

TODO

  • above topics should be moved to power_grid_model.core or otherwise made private to the module by prefixing with _ and then imported in the public interface and then included in the API reference.
  • Ensure they are still present in the API reference under the same name as the public functionality
    • Sphinx autodoc only works on the module level (with the imported_members option enabled); or
    • otherwise __all__ should be filled with everything discoverable in the API to enable listing them in the API reference
  • make sure that the python core uses the data types declared in data_types.py

Relates to #749 and #695

@mgovers mgovers added feature New feature or request documentation Improvements or additions to documentation good first issue Indicates a good issue for first-time contributors labels Mar 13, 2024
@mgovers mgovers changed the title [FEATURE] python functionality available both in core and in user [FEATURE] use data_types in python core Mar 13, 2024
@TonyXiang8787 TonyXiang8787 moved this to Q2 2024 in Power Grid Model Mar 14, 2024
@mgovers mgovers moved this from Q2 2024 to Q3 2024 in Power Grid Model Jul 3, 2024
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 feature New feature or request good first issue Indicates a good issue for first-time contributors
Projects
Status: No status
Development

No branches or pull requests

1 participant