Skip to content

Logger: Documentation - #1608

Merged
nitbharambe merged 14 commits into
mainfrom
pgm/feature/logger-documentation
Oct 6, 2026
Merged

Logger: Documentation#1608
nitbharambe merged 14 commits into
mainfrom
pgm/feature/logger-documentation

Conversation

@nitbharambe

@nitbharambe nitbharambe commented Sep 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Member
  • Short description of logger added
  • Added logging example in C API
  • Added logging example notebook for python

@nitbharambe nitbharambe added the documentation Improvements or additions to documentation label Sep 28, 2026
@nitbharambe
nitbharambe force-pushed the pgm/feature/logger-documentation branch from e6e603d to e1cd63d Compare September 28, 2026 13:15
@nitbharambe
nitbharambe added this pull request to stack #1592 September 28, 2026 15:55
@nitbharambe
nitbharambe force-pushed the pgm/feature/logger-documentation branch from 30075aa to 459534c Compare September 28, 2026 15:57
mgovers
mgovers reviewed Sep 29, 2026
View reviewed changes
Comment thread docs/advanced_documentation/c-api.md Outdated
@nitbharambe
nitbharambe marked this pull request as ready for review September 29, 2026 09:09
@nitbharambe
nitbharambe force-pushed the pgm/feature/logger-documentation branch from 459534c to 0edffb2 Compare September 29, 2026 09:09
@nitbharambe

nitbharambe commented Sep 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Member Author
  • Check if example is up to date with other PRs in stack.
  • Run notebook
  • Add benchmark enum

@mgovers
mgovers force-pushed the pgm/feature/logger-documentation branch from 0edffb2 to e7d74e9 Compare September 29, 2026 13:06
Jerry-Jinfeng-Guo
Jerry-Jinfeng-Guo reviewed Sep 29, 2026
View reviewed changes
Comment thread docs/advanced_documentation/c-api.md Outdated
@nitbharambe
nitbharambe force-pushed the pgm/feature/logger-documentation branch from e7d74e9 to a858c0d Compare September 29, 2026 15:27
@mgovers mgovers mentioned this pull request Sep 30, 2026
Merged
mgovers
mgovers reviewed Sep 30, 2026
View reviewed changes
Comment thread docs/advanced_documentation/c-api.md
mgovers
mgovers reviewed Sep 30, 2026
View reviewed changes
Comment thread docs/examples/Logging Example.ipynb
@nitbharambe
nitbharambe force-pushed the pgm/feature/logger-documentation branch 2 times, most recently from 9f99cba to c3c2007 Compare September 30, 2026 14:03
Jerry-Jinfeng-Guo
Jerry-Jinfeng-Guo reviewed Oct 2, 2026
View reviewed changes
Comment thread docs/advanced_documentation/c-api.md Outdated
Comment thread power_grid_model_c_example/logging.c
Comment thread docs/examples/Logging Example.ipynb
Comment thread docs/examples/Logging Example.ipynb Outdated
Comment thread docs/examples/Logging Example.ipynb Outdated
Comment thread docs/examples/Logging Example.ipynb Outdated
Comment thread docs/examples/Logging Example.ipynb Outdated
figueroa1395
figueroa1395 reviewed Oct 5, 2026
View reviewed changes

@figueroa1395 figueroa1395 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, only minor comments.

One additional thing though. Logging documentation, besides the well documented examples, is small (not saying this is a bad thing), but I imagine we could try to mention the logger more (elsewhere in the documentation?) such that users can more easily find it exists. Just a thought though.

Comment thread power_grid_model_c_example/logging.c
Comment thread power_grid_model_c_example/logging.c
Comment thread docs/examples/Logging Example.ipynb
Comment thread docs/examples/Logging Example.ipynb Outdated
Base automatically changed from pgm/feature/logger-python-api-implementation to main October 5, 2026 12:25
@figueroa1395
figueroa1395 force-pushed the pgm/feature/logger-documentation branch from 41a841e to aacd6a3 Compare October 5, 2026 12:25
@nitbharambe

nitbharambe commented Oct 6, 2026

Copy link
Copy Markdown
Member Author

Looks good, only minor comments.

One additional thing though. Logging documentation, besides the well documented examples, is small (not saying this is a bad thing), but I imagine we could try to mention the logger more (elsewhere in the documentation?) such that users can more easily find it exists. Just a thought though.

What do you have in mind? We can add a section under User Manual but i feel there is not much at user side to document for apart from things covered in the example. When we formalize our benchmark or have more logs through the code, or log matrices, then we have something to show.

@nitbharambe
add example
1405f6c 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
add doc
4a620c7 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
add c example
d325238 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
rename of clear_content
d82083c 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
format logging example
65bc10d 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
add to index
32b0f2b 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
update examples
4308f52 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
nitbharambe and others added 7 commits October 6, 2026 15:55
@nitbharambe
format example
a71369c 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
add logging disclaimer for output
a11c8de 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe @Jerry-Jinfeng-Guo
Apply batched suggestions from code review
78748e1 
Co-authored-by: Jerry Guo <6221579+Jerry-Jinfeng-Guo@users.noreply.github.com>
Signed-off-by: Nitish Bharambe <78108900+nitbharambe@users.noreply.github.com>
@nitbharambe
rerun notebook change to warning
b21e767 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
update example
04dfaaa 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
address comment
38ac656 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
address comment
f96b92f 
Signed-off-by: Nitish Bharambe <nitish.bharambe@alliander.com>
@nitbharambe
nitbharambe force-pushed the pgm/feature/logger-documentation branch from d3dc10f to f96b92f Compare October 6, 2026 13:55
@sonarqubecloud

sonarqubecloud Bot commented Oct 6, 2026

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@nitbharambe
nitbharambe added this pull request to the merge queue Oct 6, 2026
Merged via the queue into main with commit a3a361a Oct 6, 2026
34 checks passed
@nitbharambe
nitbharambe deleted the pgm/feature/logger-documentation branch October 6, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Jerry-Jinfeng-Guo Jerry-Jinfeng-Guo Jerry-Jinfeng-Guo left review comments
@mgovers mgovers mgovers left review comments
@figueroa1395 figueroa1395 figueroa1395 approved these changes

Assignees

@nitbharambe nitbharambe

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@nitbharambe @Jerry-Jinfeng-Guo @mgovers @figueroa1395