2394 support char logical in psydata #2509

hiker · 2024-02-22T01:04:32Z

No description provided.

…ogical_in_psydata

codecov · 2024-02-22T01:17:51Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.88%. Comparing base (4b3662e) to head (96d917d).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2509   +/-   ##
=======================================
  Coverage   99.88%   99.88%           
=======================================
  Files         359      359           
  Lines       50264    50264           
=======================================
  Hits        50208    50208           
  Misses         56       56

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

…ogical_in_psydata

arporter

Nice, small PR :-)
Would it be possible to extend one of the examples to make use of/exercise this new functionality? Otherwise it's completely untested :-(
Also, I have a concern about the 'number of bits' being specified for logical and character variables. I can't remember how you use this information?

lib/read_only/Makefile

lib/value_range_check/Makefile

lib/value_range_check/value_range_check_base.jinja

… that executes the newly supported data types.

…ogical_in_psydata

hiker · 2025-01-09T14:05:15Z

Nice, small PR :-) Would it be possible to extend one of the examples to make use of/exercise this new functionality? Otherwise it's completely untested :-(

That was a bit of a headache, since neither gocean nor lfric support character strings. So I've added a new generic read-only verification library, and added an example as nemo/eg6. I couldn't add an examples that will actually throw an error (since PSyclone processes the file and does not support loc or sizeof, which was the trick I used in gocean). There is documentation how you can manually modify the psy file to trigger an error (but admittedly that's kind of stupid). Suggestions welcome.

Also, I have a concern about the 'number of bits' being specified for logical and character variables. I can't remember how you use this information?

I have also refactored all of that, so no more bits specified. Unfortunately, all of that that made this PR somewhat bigger :)

…ogical_in_psydata

arporter · 2025-01-10T09:20:06Z

doc/user_guide/psy_data.rst

+
+This will create a library called ``lib_read_only.a``.
+An executable example for using the generic read-only-verification
+library is included in ``examples/gocean/eg6/``.


nemo/eg6 rather than gocean?

arporter · 2025-01-10T09:25:03Z

examples/nemo/eg6/Makefile

+# Author: A. R. Porter, STFC Daresbury Lab
+# Modified J. Henrichs, Bureau of Meteorology
+
+# Makefile for the 5th NEMO example. Uses PSyclone (which must


First sentence is wrong (and could just be removed).

arporter · 2025-01-10T09:28:58Z

examples/nemo/eg6/README.md

@@ -0,0 +1,98 @@
+# PSyclone NEMO Example 6 - Read-only Verification


Please add a brief section to examples/nemo/README.md to mention this new example.

arporter · 2025-01-10T09:33:09Z

doc/user_guide/tutorials_and_examples.rst

@@ -783,6 +783,14 @@ compilation instructions are in the ``README.md`` file, including how
 to switch from using the stand-alone extraction library to the NetCDF-based
 one (see :ref:`extraction_libraries` for details).

+Example 6: Read-only Verification


I realise we have duplication between this text and the markdown README files. If you're feeling keen, we could experiment with removing this section and replacing it with an include of the appropriate README. Sphinx's include directive supports a 'parser' option which apparently allows this (https://docutils.sourceforge.io/docs/ref/rst/directives.html#include-options). However, now that I write all that, I think perhaps that would be a separate issue.

arporter · 2025-01-10T09:38:10Z

examples/nemo/eg6/README.md

+If you copy the lines 32 and 33 from ``dummy.f90`` into ``psy.f90``,
+the code will modify ``logical_var`` (by using out-of-bound array accesses.
+Or you could just manually set ``logical_var = .true.``). If you then
+compile again, an error will be produced.


This worked for me. Good stuff. Only wrinkle is that doing make compile again ran PSyclone and over-wrote my modified psy.f90 file. I had to cut-n-paste the compile and link lines to build with the modified psy.f90 file. Not a biggie. Either mention it here or perhaps it's just a small tweak to the Makefile?

arporter · 2025-01-10T09:41:53Z

examples/nemo/eg6/dummy.f90

@@ -0,0 +1,35 @@
+program dummy


Please add the ususal license and a brief comment summarising the purpose of this file.

You could take the opportunity to say this is really just about exercising aspects of the read-only verification library.

arporter · 2025-01-10T09:48:02Z

lib/read_only/generic/Makefile

+# -----------------------------------------------------------------------------
+# Author: J. Henrichs, Australian Bureau of Meteorology
+
+


Please add a comment saying that this Makefile is for the read-only checking lib for generic Fortran code.

arporter · 2025-01-10T09:48:53Z

lib/read_only/generic/README.md

+# Read-only Verification Library for Generic Fortran Code
+
+This library implements the [PSyData API](
+https://psyclone.readthedocs.io/en/latest/psy_data.html#read-only-verification-library-for-gocean)


This link is for gocean. Is that deliberate?

arporter · 2025-01-10T09:51:35Z

lib/read_only/generic/README.md

+The compilation process will create the wrapper library ``lib_read_only.a``.
+
+Similar to compilation of the [examples](
+https://psyclone.readthedocs.io/en/latest/examples.html#compilation), the


Should be tutorials_and_examples.html I think.

lib/value_range_check/value_range_check_base.jinja

arporter

Thanks very much Joerg. Just a few minor things now.
In testing the compilation of the examples I discovered that the xdsl Makefile was broken (spaces instead of tabs) so I've taken the liberty of fixing that and pushed it on your branch.

hiker added 2 commits November 10, 2023 10:45

#2394 Support logical and character for nan and readonly.

8b8d9b6

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

1c54119

…ogical_in_psydata

hiker added 4 commits May 14, 2024 12:35

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

b61f169

…ogical_in_psydata

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

76f2a28

…ogical_in_psydata

#2394 Fixed character handling.

92388d6

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

a2f86f7

…ogical_in_psydata

hiker added 2 commits December 18, 2024 17:35

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

1d13b02

…ogical_in_psydata

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

ecb0571

…ogical_in_psydata

arporter added under review and removed ready for review labels Jan 6, 2025

arporter requested changes Jan 6, 2025

View reviewed changes

arporter added reviewed with actions and removed under review labels Jan 6, 2025

hiker added 4 commits January 7, 2025 16:18

#2394 Removed the bits field from ALL_TYPES.

8debe33

#2394 Fixed bug (int arrays not checked for value range).

69b9938

#2394 Added generic read-only verification library, and added example…

ae62916

… that executes the newly supported data types.

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

42259f5

…ogical_in_psydata

#2394 Fixed coding style.

b3f9904

hiker added ready for review and removed reviewed with actions labels Jan 9, 2025

Merge remote-tracking branch 'origin/master' into 2394_support_char_l…

fa19a9b

…ogical_in_psydata

arporter added under review and removed ready for review labels Jan 10, 2025

arporter reviewed Jan 10, 2025

View reviewed changes

#2394 fix whitespace errors in xdsl makefile

96d917d

arporter requested changes Jan 10, 2025

View reviewed changes

arporter added reviewed with actions and removed under review labels Jan 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2394 support char logical in psydata #2509

2394 support char logical in psydata #2509

hiker commented Feb 22, 2024

codecov bot commented Feb 22, 2024 •

edited

Loading

arporter left a comment

hiker commented Jan 9, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter Jan 10, 2025

arporter left a comment

		@@ -0,0 +1,98 @@
		# PSyclone NEMO Example 6 - Read-only Verification

		# -----------------------------------------------------------------------------
		# Author: J. Henrichs, Australian Bureau of Meteorology

2394 support char logical in psydata #2509

Are you sure you want to change the base?

2394 support char logical in psydata #2509

Conversation

hiker commented Feb 22, 2024

codecov bot commented Feb 22, 2024 • edited Loading

Codecov Report

arporter left a comment

Choose a reason for hiding this comment

hiker commented Jan 9, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arporter left a comment

Choose a reason for hiding this comment

codecov bot commented Feb 22, 2024 •

edited

Loading