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

2444 use dash instead of colon #2445

Merged
merged 34 commits into from
Jul 3, 2024
Merged

Conversation

hiker
Copy link
Collaborator

@hiker hiker commented Dec 19, 2023

A simple change that affects a lot of files. Fixes #2444.

Copy link

codecov bot commented Dec 19, 2023

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (afed0a9) 99.85% compared to head (4980605) 99.85%.

Files Patch % Lines
...clone/domain/lfric/lfric_extract_driver_creator.py 98.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2445      +/-   ##
==========================================
- Coverage   99.85%   99.85%   -0.01%     
==========================================
  Files         353      354       +1     
  Lines       47459    47856     +397     
==========================================
+ Hits        47390    47786     +396     
- Misses         69       70       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@arporter
Copy link
Member

This appears to have the CallTreeTools change in it too. Is it meant to?

@hiker
Copy link
Collaborator Author

hiker commented Dec 23, 2023

Yes, I have 4 or so PRs lined up in a specific order. This issue eg. changes the driver names etc, so it's easier if it is done after #2296 and #1990 (and that's why I didn't label it as ready for review, but I added 'in progress' now to make this more obvious).

oakleybrunt added a commit that referenced this pull request Jan 8, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.86%. Comparing base (05955d1) to head (7acac9b).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2445   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files         352      352           
  Lines       48463    48463           
=======================================
  Hits        48398    48398           
  Misses         65       65           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hiker
Copy link
Collaborator Author

hiker commented Jul 2, 2024

I hope my greps worked all correct and I found all old : references. Note that this patch only affects the : in region names, NOT any colon added by e.g. psydata libraries when using the module- and region-name for creating region names (which are fine, since they are not creating files). I think it is consistent that we will leave it to the various psydata apps how to name things (and using : actually makes it possible to see what is region and what module ... before we had sometimes three :, meaning it was hard to see what was module and region (though de-facto it should be obvious). Now we have : between region and module, and - between the parts inside a region.

I did find a strange bug in examples/gocean/eg5:
The README states that the message ... module 'psy_test' region 'invoke_0:r0' is printed, but the message is actually module 'invoke_0' region 'r0'. I have no idea what happened (I doubt that would have make it through code review??). I tried to restore various old states of PSyclone, but had problems getting that example to run(??) - and decided it's nothing for this PR anyway. But it feels like a bug somewhere, the module name should indeed be psy_test, and region name invoke0-r0. I suggest we open a separate ticket for that?

@hiker
Copy link
Collaborator Author

hiker commented Jul 2, 2024

I've also started the CI.

@arporter
Copy link
Member

arporter commented Jul 2, 2024

I did find a strange bug in examples/gocean/eg5:
The README states that the message ... module 'psy_test' region 'invoke_0:r0' is printed, but the message is actually module 'invoke_0' region 'r0'. I have no idea what happened (I doubt that would have make it through code review??). I tried to restore various old states of PSyclone, but had problems getting that example to run(??) - and decided it's nothing for this PR anyway. But it feels like a bug somewhere, the module name should indeed be psy_test, and region name invoke0-r0. I suggest we open a separate ticket for that?

Yes please.

Copy link
Member

@arporter arporter left a comment

Choose a reason for hiding this comment

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

Thanks for those updates Joerg.
Just a few small things to tidy up.
I see that the integration tests were all green.
Despite it being my suggestion to change them to colons (I think), I have to admit that I think the profiling region names looked better with colons but if you don't agree and/or it's a lot of work to change it back then I'm happy to leave this.

doc/user_guide/profiling.rst Show resolved Hide resolved
doc/user_guide/profiling.rst Outdated Show resolved Hide resolved
doc/user_guide/profiling.rst Outdated Show resolved Hide resolved
doc/user_guide/profiling.rst Outdated Show resolved Hide resolved
examples/gocean/eg5/profile/README.md Show resolved Hide resolved
examples/lfric/eg14/README.md Show resolved Hide resolved
doc/user_guide/profiling.rst Show resolved Hide resolved
@arporter
Copy link
Member

arporter commented Jul 2, 2024

BTW, I'm loving the documentation with the code highlighting :-)

@hiker
Copy link
Collaborator Author

hiker commented Jul 2, 2024

BTW, I'm loving the documentation with the code highlighting :-)

Me, too! The moment I saw this, I knew I had to introduce this to PSyclone :)

@hiker
Copy link
Collaborator Author

hiker commented Jul 2, 2024

I hope I explained it a bit better where the : come from and that they are still there. I got confused when I picked this PR up as well, I had additional commits that removed all : in all profiling libraries, updated examples, tutorial, ... before I realised that I am doing stupid things :P

Given the costs of the CI, I won't trigger it again, since I only changed the user's guide.

Copy link
Member

@arporter arporter left a comment

Choose a reason for hiding this comment

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

All good now.
Thanks for clarifying.
Will proceed to merge once CI has run.

@arporter arporter merged commit ae4bc50 into master Jul 3, 2024
12 checks passed
@arporter arporter deleted the 2444_use_dash_instead_of_colon branch July 3, 2024 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[PSyData] Driver is using ":" in filename
3 participants