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: Logging Updates #501

Merged
merged 260 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from 146 commits
Commits
Show all changes
260 commits
Select commit Hold shift + click to select a range
a7d021b
add begin-end step logging IDA
gardner48 Jun 8, 2024
2223101
add begin-end step logging IDAS
gardner48 Jun 8, 2024
15bc36d
make logging levels more consistent
gardner48 Jun 8, 2024
59bf5a0
add begin-end step logging ARKODE
gardner48 Jun 8, 2024
2c0c488
get mri history and add example
gardner48 Jun 8, 2024
7d558eb
clean up
gardner48 Jun 8, 2024
c77782f
formatting
gardner48 Jun 8, 2024
52f4e5c
guard against non-existant keys
gardner48 Jun 8, 2024
9e49090
plot multiple files
gardner48 Jun 8, 2024
847e562
update help docs in examples
gardner48 Jun 8, 2024
863b51f
remove end-step log entry
gardner48 Jun 8, 2024
23d1b82
update arkstep stage logging
gardner48 Jun 9, 2024
dcd1b35
formatting
gardner48 Jun 9, 2024
a8a68dc
update erkstep stage logging
gardner48 Jun 9, 2024
9940dc2
add logging macros
gardner48 Jun 14, 2024
525c511
update some ARKODE logging
gardner48 Jun 14, 2024
d62b72f
more ARKODE logging updates
gardner48 Jun 14, 2024
5fe43c2
log vector array macro
gardner48 Jun 14, 2024
f602a12
more ARKODE logging updates
gardner48 Jun 14, 2024
a60bdcf
formatting
gardner48 Jun 14, 2024
a91d314
update ARKODE LS logging
gardner48 Jun 14, 2024
6fed1e6
update CVODE logging
gardner48 Jun 14, 2024
8c750f0
update CVODES logging
gardner48 Jun 14, 2024
64e58e1
formatting
gardner48 Jun 14, 2024
3ec669d
update IDA logging
gardner48 Jun 15, 2024
9412694
update some IDAS logging
gardner48 Jun 15, 2024
8d4857a
more IDAS logging updates
gardner48 Jun 15, 2024
4be8aaa
update KINSOL logging
gardner48 Jun 15, 2024
e4918cd
update LS and NLS logging
gardner48 Jun 15, 2024
9647499
logging fixes
gardner48 Jun 15, 2024
8cf4c78
move stage logging to info level
gardner48 Jun 15, 2024
7602b41
parse stage logging output
gardner48 Jun 15, 2024
da8ea20
formatting
gardner48 Jun 15, 2024
9a405ea
skip empty payload
gardner48 Jun 21, 2024
bb39b75
clean up vaiable names, comments
gardner48 Jun 21, 2024
f58ab3f
update print formatting
gardner48 Jun 21, 2024
1d897d0
move Newton logging to info level
gardner48 Jun 21, 2024
aa301ae
initial nonlinear solver parsing
gardner48 Jun 21, 2024
211a7be
use dict for NLS data
gardner48 Jun 21, 2024
bc853b7
update logging output
gardner48 Jun 21, 2024
c5d9fab
initial linear solver parsing
gardner48 Jun 22, 2024
404fa4e
initial linear solver logging updates
gardner48 Jun 22, 2024
3b790f3
formatting
gardner48 Jun 22, 2024
d914757
update nonlinear solver logging
gardner48 Jun 22, 2024
cdccb58
add empty dict when creating a new list
gardner48 Jun 22, 2024
d482e0c
update var names
gardner48 Jun 22, 2024
cfd7c31
logging updates
gardner48 Jun 24, 2024
3358d57
Add class to help with parsing log data
gardner48 Jun 24, 2024
4ccc933
correct comment
gardner48 Jun 24, 2024
9849d08
update comments
gardner48 Jun 24, 2024
246ce45
formatting
gardner48 Jun 24, 2024
5fe0efb
update function to print the log
gardner48 Jun 24, 2024
77ad897
update PCG logging
gardner48 Jun 25, 2024
4d20fe9
update fixed-point logging
gardner48 Jun 25, 2024
2a80714
update spbcgs logging
gardner48 Jun 25, 2024
88db2b2
add retval to failed spgmr log
gardner48 Jun 25, 2024
22f2e55
update spfgmr logging
gardner48 Jun 25, 2024
dd2660e
update sptfqmr logging
gardner48 Jun 25, 2024
f73d83e
formatting
gardner48 Jun 25, 2024
9a8be38
fix typos, apply formatting
gardner48 Jun 25, 2024
cd5e584
move scripts
gardner48 Jun 30, 2024
fa1647c
update imports
gardner48 Jun 30, 2024
7e4601b
ignore pycache
gardner48 Jun 30, 2024
8fe1b3e
clean up comments, remove debugging code
gardner48 Jul 16, 2024
d602231
reorder logging output
gardner48 Aug 6, 2024
e884166
apply formatting
gardner48 Aug 7, 2024
eb5ae98
add labels option to sundials_add_test
gardner48 Aug 23, 2024
a2ff5d0
add shared header for kpr unit tests
gardner48 Aug 23, 2024
d9f2826
add shared header for unit test check functions
gardner48 Aug 23, 2024
9a5cbd5
add logging test
gardner48 Aug 23, 2024
d123b53
fix setting single false command line arg
gardner48 Aug 24, 2024
583b841
apply formatting
gardner48 Aug 24, 2024
078af91
make sure target exists
gardner48 Aug 24, 2024
cec3d80
apply formatting
gardner48 Aug 24, 2024
8606306
add cvodes test
gardner48 Aug 26, 2024
778745c
fix typo
gardner48 Aug 26, 2024
9886369
remove debugging output
gardner48 Aug 26, 2024
2d3a17e
add IDA test
gardner48 Aug 27, 2024
6f35730
add IDAS test
gardner48 Aug 27, 2024
86e74c6
apply formatting
gardner48 Aug 27, 2024
93a218d
Run logging tests
gardner48 Aug 27, 2024
4820a5e
enable unit tests
gardner48 Aug 27, 2024
4ca7fb3
change logging test type
gardner48 Aug 27, 2024
1fc08b7
update comment
gardner48 Aug 27, 2024
f8e5391
diff logging output
gardner48 Aug 27, 2024
edbb0d2
add erk, ark, and mri tests
gardner48 Sep 4, 2024
3ad9346
apply formatting
gardner48 Sep 4, 2024
0129722
update free function calls
gardner48 Sep 9, 2024
0d72a91
fix memory leak
gardner48 Sep 9, 2024
798b3fd
add arkode logging output
gardner48 Sep 9, 2024
d0ccd69
update test label
gardner48 Sep 9, 2024
b111af5
update ARKODE LS logging
gardner48 Sep 9, 2024
725b8fb
correct FP solve logging
gardner48 Sep 10, 2024
458bbbd
add stage type to first MRI stage
gardner48 Sep 10, 2024
557704e
fix bug in setting IMEX-MRI methods
gardner48 Sep 10, 2024
a383bd3
update outputs after IMEX-MRI bugfix
gardner48 Sep 10, 2024
708f5b4
add example script to print log file
gardner48 Sep 10, 2024
2ccffc5
sync cvodes with cvode
gardner48 Sep 14, 2024
14ae551
update outputs
gardner48 Sep 14, 2024
a48dbba
sync cvodes with cvode
gardner48 Sep 14, 2024
0daa83b
update outputs
gardner48 Sep 14, 2024
f9e36a1
fix IDA(S) logging
gardner48 Sep 14, 2024
78dce06
update outputs
gardner48 Sep 14, 2024
2da4856
fix typo
gardner48 Sep 14, 2024
3a8700a
apply formatting
gardner48 Sep 14, 2024
652e9ff
initialize nli_inc
gardner48 Sep 14, 2024
2585645
update tarscripts
gardner48 Sep 14, 2024
71efb8e
update tn key
gardner48 Sep 14, 2024
93ec8a9
update resnorm key
gardner48 Sep 14, 2024
1cdc582
update tarscript
gardner48 Sep 14, 2024
8aec9af
update tarscript
gardner48 Sep 14, 2024
7524a08
Merge branch 'develop' into feature/logging-updates
gardner48 Sep 14, 2024
815fed1
update output files
gardner48 Sep 14, 2024
cbd8619
update answers submodule
gardner48 Sep 14, 2024
61331c3
fix debugging output
gardner48 Sep 14, 2024
40238e1
update logging output
gardner48 Sep 14, 2024
12f7d65
update answers submodule
gardner48 Sep 14, 2024
a67b1a5
update docs
gardner48 Sep 14, 2024
a3ace40
remove unused options
gardner48 Sep 14, 2024
8e68662
Merge branch 'develop' into feature/logging-updates
gardner48 Sep 16, 2024
e29e066
Merge branch 'develop' into feature/logging-updates
gardner48 Sep 16, 2024
cb43565
update logging example usage in docs
gardner48 Oct 3, 2024
289cc61
Merge branch 'develop' into feature/logging-updates
gardner48 Oct 3, 2024
1497ddc
update macro to add __func__
gardner48 Oct 9, 2024
d2ef6c3
Update src/cvodes/cvodes.c
gardner48 Oct 11, 2024
e613278
Update src/cvodes/cvodes.c
gardner48 Oct 11, 2024
9c1249c
Update tools/log_example.py
gardner48 Oct 11, 2024
0a02921
apply formatting
gardner48 Oct 11, 2024
0bd37fe
Merge branch 'develop' into feature/logging-updates
gardner48 Oct 11, 2024
db964ae
add dev docs for logging macros
gardner48 Oct 13, 2024
deefb37
Remove empty string input to SUNLog macros
gardner48 Oct 14, 2024
2d51119
Merge branch 'develop' into feature/logging-updates
gardner48 Oct 15, 2024
b5f0089
update vec logging macros
gardner48 Oct 15, 2024
834cdb8
Merge branch 'develop' into feature/logging-updates
gardner48 Oct 15, 2024
a23deb6
update dev logging docs
gardner48 Oct 15, 2024
7427b15
remove unused logging macros
gardner48 Oct 15, 2024
2b3d3e4
Apply suggestions from code review
gardner48 Oct 15, 2024
dc48eab
update answers submodule
gardner48 Oct 15, 2024
7a517f3
update answers submodule
gardner48 Oct 15, 2024
0266db8
Merge branch 'develop' into feature/logging-updates
gardner48 Oct 15, 2024
6e58390
fix broken link
gardner48 Oct 16, 2024
d037cb4
Merge branch 'develop' into feature/logging-updates
gardner48 Oct 21, 2024
6e72945
fix typo in comment
gardner48 Oct 22, 2024
0d85b79
add forward reference to logging style section
gardner48 Oct 22, 2024
fe47155
update parameter description
gardner48 Oct 22, 2024
2d8f4a9
make punctuation consistent in param descriptions
gardner48 Oct 22, 2024
f6e888f
update answers submodule
gardner48 Oct 22, 2024
35447a6
Merge branch 'develop' into feature/logging-updates
gardner48 Oct 30, 2024
80d422b
Apply suggestions from code review
gardner48 Nov 8, 2024
b4470d1
Merge branch 'develop' into feature/logging-updates
gardner48 Nov 8, 2024
f096d07
Merge branch 'develop' into feature/logging-updates
gardner48 Nov 18, 2024
893f5e4
missing log statements for early exit in ARKStep
gardner48 Nov 19, 2024
91ed1ed
add missing log statemnts for early exit ERKStep
gardner48 Nov 19, 2024
d4473ac
update RKC logging
gardner48 Nov 19, 2024
f6c019d
apply formatting
gardner48 Nov 19, 2024
52d5f41
add new sections to log parser
gardner48 Nov 19, 2024
e7b31ac
always log the spectral radius
gardner48 Nov 19, 2024
5d4a4f5
add LSRKStep logging test
gardner48 Nov 19, 2024
3e68cfb
update ARKODE logging output files
gardner48 Nov 19, 2024
24c95f0
apply formatting
gardner48 Nov 19, 2024
73a28b5
add logging for RKL, update test outputs
gardner48 Nov 20, 2024
f8a3376
remove white space
gardner48 Nov 20, 2024
37ab7c2
fix failure logging message
gardner48 Nov 20, 2024
ae4fe4c
add logging to SSPs2
gardner48 Nov 20, 2024
885edc1
fix parsing array output
gardner48 Nov 20, 2024
a242a88
update logging sections in parser
gardner48 Nov 20, 2024
fc4b18b
replace compute-solution with stage, add compute-embedding
gardner48 Nov 20, 2024
8446222
add logging to SSPs3
gardner48 Nov 20, 2024
44b4968
fix ProcessStage time
gardner48 Nov 20, 2024
037c75b
update logging output files
gardner48 Nov 20, 2024
555cce6
apply formatting
gardner48 Nov 20, 2024
a7b8523
add logging to SSP43
gardner48 Nov 21, 2024
cdba63a
update logging output files
gardner48 Nov 21, 2024
f95edba
add logging to SSP104
gardner48 Nov 22, 2024
58bcf42
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 4, 2024
5a709c2
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 4, 2024
51714bf
update answers submodule
gardner48 Dec 4, 2024
0b22b93
update answers submodule
gardner48 Dec 4, 2024
a766fd0
update answers submodule
gardner48 Dec 4, 2024
e6e201d
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 4, 2024
f4acf5b
update answers submodule
gardner48 Dec 4, 2024
39c4a5e
fix bad merge
gardner48 Dec 4, 2024
84ca7c2
apply formatting
gardner48 Dec 4, 2024
0430d71
only print zpred when used
gardner48 Dec 5, 2024
7791353
update MRIGARK logging
gardner48 Dec 5, 2024
ff40444
fix bad merge
gardner48 Dec 5, 2024
0da4796
apply formatting
gardner48 Dec 5, 2024
0d9754e
update output files
gardner48 Dec 5, 2024
6d77ac5
update output files
gardner48 Dec 5, 2024
5730492
update answers submodule
gardner48 Dec 5, 2024
f622b16
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 5, 2024
60ee929
update answers submodule
gardner48 Dec 5, 2024
734b3be
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 5, 2024
9c1f4d8
update output files
gardner48 Dec 5, 2024
48f73ec
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 6, 2024
be777dd
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 6, 2024
85898de
add logging to SPRKStep
gardner48 Dec 8, 2024
9323ff2
apply formatting
gardner48 Dec 8, 2024
34fdaaa
clean up kpr problem
gardner48 Dec 9, 2024
2467ba7
add SPRK logging test
gardner48 Dec 9, 2024
0b902d8
apply formatting
gardner48 Dec 9, 2024
e65c37f
Apply documentation suggestions from code review
gardner48 Dec 9, 2024
d33762d
Fix RHS vector passed to logging output
gardner48 Dec 9, 2024
3c70561
Fix typos in comments
gardner48 Dec 9, 2024
afef381
fix embedding logging in LSRKStep
gardner48 Dec 9, 2024
c773075
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 9, 2024
6a103f4
fix compiler warnings
gardner48 Dec 9, 2024
beb729e
fix windows builds
gardner48 Dec 9, 2024
b656003
apply formatting
gardner48 Dec 9, 2024
8ed32cc
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 9, 2024
2326135
add sprk logging test output
gardner48 Dec 9, 2024
b783e54
update outputs
gardner48 Dec 9, 2024
e1c69db
update first stage output
gardner48 Dec 9, 2024
a6cec01
update MRI-SR logging
gardner48 Dec 9, 2024
de08f05
update default logging level outputs
gardner48 Dec 9, 2024
e481f95
fix bug in MERK F0-FullRHS logic
gardner48 Dec 9, 2024
5e68b9f
update MERK logging
gardner48 Dec 9, 2024
69b38b1
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 9, 2024
c2419f1
apply formatting
gardner48 Dec 9, 2024
a125579
apply formatting
gardner48 Dec 9, 2024
f3b9371
add missing nls solve markers in MRIStep
gardner48 Dec 9, 2024
d589ce5
update outputs
gardner48 Dec 9, 2024
bd66248
add level 3 outputs
gardner48 Dec 9, 2024
8e3a928
add level 4 outputs
gardner48 Dec 9, 2024
3b8c840
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 9, 2024
d8be6ee
add level 5 output
gardner48 Dec 9, 2024
6e81196
update answers submodule
gardner48 Dec 9, 2024
aaeff4c
update answer submodule
gardner48 Dec 9, 2024
a30f4e5
update answer submodule
gardner48 Dec 10, 2024
55f03c7
problem clean up
gardner48 Dec 10, 2024
eda0752
adjust indentation in log print
gardner48 Dec 10, 2024
f5f7de9
update logging in ForcingStep
gardner48 Dec 10, 2024
00c9b92
parse partitions
gardner48 Dec 10, 2024
a30ca30
update SplittingStep logging
gardner48 Dec 10, 2024
5c799a8
update parsing for sequential methods
gardner48 Dec 10, 2024
e2ba523
add test file
gardner48 Dec 10, 2024
2c16658
apply formatting
gardner48 Dec 10, 2024
4aae053
free sunsteppers
gardner48 Dec 10, 2024
afef243
apply formatting
gardner48 Dec 10, 2024
13b484d
add level 2 output
gardner48 Dec 10, 2024
c69eb10
add level 3, 4, and 5 output
gardner48 Dec 10, 2024
917f8f5
update answers submodule
gardner48 Dec 10, 2024
74c5c9b
update answers submodule
gardner48 Dec 10, 2024
d47cfb9
update answer submodule
gardner48 Dec 10, 2024
6de5f71
additional debugging output
gardner48 Dec 10, 2024
8b0f47a
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 10, 2024
b1b5be2
update function name
gardner48 Dec 10, 2024
aa67eb4
apply formatting
gardner48 Dec 10, 2024
97daf52
update answers submodule
gardner48 Dec 10, 2024
2c744b9
Merge branch 'develop' into feature/logging-updates
gardner48 Dec 10, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cmake-format.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
'EXTRA_ARGS': '+',
'FLOAT_PRECISION': 1,
'INTEGER_PRECISION': 1,
'LABELS': '+',
'MPI_NPROCS': 1,
'TEST_ARGS': '+'},
'pargs': {'flags': ['NODIFF'], 'nargs': '2+'}},
Expand Down
15 changes: 14 additions & 1 deletion .github/workflows/ubuntu-clang-latest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,25 @@ jobs:
-D CMAKE_CXX_COMPILER=$(which clang++) \
-D SUNDIALS_LOGGING_LEVEL=${{matrix.logging_level}} \
-D ENABLE_ALL_WARNINGS=ON \
-D ENABLE_WARNINGS_AS_ERRORS=ON
-D ENABLE_WARNINGS_AS_ERRORS=ON \
-D SUNDIALS_TEST_DEVTESTS=ON \
-D SUNDIALS_TEST_UNITTESTS=ON \
-D SUNDIALS_TEST_ENABLE_GTEST=OFF \
-D SUNDIALS_TEST_FLOAT_PRECISION=4 \
-D SUNDIALS_TEST_INTEGER_PRECISION=10

- name: Build
# Build your program with the given configuration
run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}

- name: Test
# Run logging tests
run: |
ctest \
--test-dir ${{github.workspace}}/build \
--label-regex logging \
--verbose

build_cycle_profiling:
runs-on: ubuntu-latest

Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,6 @@ uberenv_libs

# swig
/swig/swig

# tools
/tools/suntools/__pycache__
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ backends with Trilinos. As such, Trilinos 14 or newer is required and the

Example programs using *hypre* have been updated to support v2.20 and newer.

The information level logging output in ARKODE, CVODE(S), and IDA(S) has been
updated to be more uniform across the packages and a new `tools` directory
has been added with a Python module, `suntools`, containing utilities for
parsing logging output. The Python utilities for parsing CSV output have been
relocated from the `scripts` directory to the Python module.

The build system has been updated to utilize the CMake LAPACK imported target
which should ease building SUNDIALS with LAPACK libraries that require setting
specific linker flags e.g., MKL.
Expand Down
18 changes: 16 additions & 2 deletions cmake/macros/SundialsAddTest.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
# [ANSWER_DIR path]
# [ANSWER_FIEL file]
# [EXAMPLE_TYPE type]
# [TEST_ARGS arg1 arg2 ...])
# [TEST_ARGS arg1 arg2 ...]
# [LABELS label1 label2 ...])
# ~~~
#
# CMake macro to add a SUNDIALS regression test. Keyword input arguments can be
Expand All @@ -46,6 +47,11 @@
#
# The option EXAMPLE_TYPE set the example type i.e., release or develop examples
#
# The option TEST_ARGS are command line arguments to pass to the executable
#
# The options LABELS are labels added to the test properties to easily run (or
# exclude) groups of test with ctest -L <label> (or ctest -LE <label>)
#
# When SUNDIALS_TEST_DEVTESTS is OFF (default) the executable is run and success
# or failure is determined by the executable return value (zero or non-zero
# respectively).
Expand Down Expand Up @@ -83,7 +89,7 @@ macro(SUNDIALS_ADD_TEST NAME EXECUTABLE)
set(options "NODIFF")
set(oneValueArgs "MPI_NPROCS" "FLOAT_PRECISION" "INTEGER_PRECISION"
"ANSWER_DIR" "ANSWER_FILE" "EXAMPLE_TYPE")
set(multiValueArgs "TEST_ARGS" "EXTRA_ARGS")
set(multiValueArgs "LABELS" "TEST_ARGS" "EXTRA_ARGS")

# parse inputs and create variables SUNDIALS_ADD_TEST_<keyword>
cmake_parse_arguments(SUNDIALS_ADD_TEST "${options}" "${oneValueArgs}"
Expand Down Expand Up @@ -262,6 +268,14 @@ macro(SUNDIALS_ADD_TEST NAME EXECUTABLE)

endif()

if(SUNDIALS_TEST_DEVTESTS OR NOT SUNDIALS_ADD_TEST_EXAMPLE_TYPE)
# set any labels (must quote SUNDIALS_ADD_TEST_LABELS)
if(SUNDIALS_ADD_TEST_LABELS)
set_tests_properties(${NAME} PROPERTIES LABELS
"${SUNDIALS_ADD_TEST_LABELS}")
endif()
endif()

endif()

endmacro()
6 changes: 3 additions & 3 deletions doc/arkode/guide/source/Usage/ARKStep/User_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3055,9 +3055,9 @@ Main solver optional output functions

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 5.2.0

Expand Down
6 changes: 3 additions & 3 deletions doc/arkode/guide/source/Usage/ERKStep/User_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1640,9 +1640,9 @@ Main solver optional output functions

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 5.2.0

Expand Down
6 changes: 3 additions & 3 deletions doc/arkode/guide/source/Usage/MRIStep/User_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1846,9 +1846,9 @@ Main solver optional output functions

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 5.2.0

Expand Down
6 changes: 3 additions & 3 deletions doc/arkode/guide/source/Usage/SPRKStep/User_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -733,9 +733,9 @@ Main solver optional output functions

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. deprecated:: 6.1.0

Expand Down
6 changes: 3 additions & 3 deletions doc/arkode/guide/source/Usage/User_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3397,9 +3397,9 @@ Retrieve a pointer for user data :c:func:`ARKodeGetUserDat

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 6.1.0

Expand Down
6 changes: 3 additions & 3 deletions doc/cvode/guide/source/Usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2736,9 +2736,9 @@ described next.

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 6.2.0

Expand Down
6 changes: 3 additions & 3 deletions doc/cvodes/guide/source/Usage/SIM.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2736,9 +2736,9 @@ described next.

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 6.2.0

Expand Down
6 changes: 3 additions & 3 deletions doc/ida/guide/source/Usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2602,9 +2602,9 @@ described next.

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 6.2.0

Expand Down
6 changes: 3 additions & 3 deletions doc/idas/guide/source/Usage/SIM.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2631,9 +2631,9 @@ described next.

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 5.2.0

Expand Down
6 changes: 3 additions & 3 deletions doc/kinsol/guide/source/Usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1474,9 +1474,9 @@ functions are described next.

.. note::

The file ``scripts/sundials_csv.py`` provides python utility functions to
read and output the data from a SUNDIALS CSV output file using the key
and value pair format.
The Python module ``tools/suntools`` provides utilities to read and output
the data from a SUNDIALS CSV output file using the key and value pair
format.

.. versionadded:: 6.2.0

Expand Down
6 changes: 6 additions & 0 deletions doc/shared/RecentChanges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ backends with Trilinos. As such, Trilinos 14 or newer is required and the

Example programs using *hypre* have been updated to support v2.20 and newer.

The information level logging output in ARKODE, CVODE(S), and IDA(S) has been
updated to be more uniform across the packages and a new ``tools`` directory
has been added with a Python module, ``suntools``, containing utilities for
parsing logging output. The Python utilities for parsing CSV output have been
relocated from the ``scripts`` directory to the Python module.

The build system has been updated to utilize the CMake LAPACK imported target
which should ease building SUNDIALS with LAPACK libraries that require setting
specific linker flags e.g., MKL.
Expand Down
Loading
Loading