TUFLOW Version Backward Compatibility - Revision history

Emilie Nielsen: /* Backward Compatibility Change Register */

2026-04-09T23:57:18Z

Backward Compatibility Change Register

← Older revision		Revision as of 09:57, 10 April 2026
Line 4:		Line 4:
	For a list of new features and changes for each TUFLOW release, refer to the <u>[https://docs.tuflow.com/classic-hpc/changelog/ TUFLOW Classic/HPC Changelog]</u> (for versions since 2023-03-AF). For versions 2023-03-AF and prior, see the relevant release notes in the <u>[https://www.tuflow.com/downloads/tuflow-classichpc-archive/ TUFLOW Downloads Archive]</u>.		For a list of new features and changes for each TUFLOW release, refer to the <u>[https://docs.tuflow.com/classic-hpc/changelog/ TUFLOW Classic/HPC Changelog]</u> (for versions since 2023-03-AF). For versions 2023-03-AF and prior, see the relevant release notes in the <u>[https://www.tuflow.com/downloads/tuflow-classichpc-archive/ TUFLOW Downloads Archive]</u>.

	For backward compatibility and default changes, please see Chapter 18 (Default Changes) of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual] </u>		For backward compatibility and default changes, please see Chapter 18 (Default Changes) of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual]</u>.

	=Frequently Asked Questions (FAQ)=		=Frequently Asked Questions (FAQ)=

Emilie Nielsen: /* Backward Compatibility Change Register */

2026-04-09T23:57:09Z

Backward Compatibility Change Register

← Older revision		Revision as of 09:57, 10 April 2026
Line 2:		Line 2:
	=Backward Compatibility Change Register=		=Backward Compatibility Change Register=

			For a list of new features and changes for each TUFLOW release, refer to the <u>[https://docs.tuflow.com/classic-hpc/changelog/ TUFLOW Classic/HPC Changelog]</u> (for versions since 2023-03-AF). For versions 2023-03-AF and prior, see the relevant release notes in the <u>[https://www.tuflow.com/downloads/tuflow-classichpc-archive/ TUFLOW Downloads Archive]</u>.
⚫	For backward compatibility and ~~release~~ ~~notes~~, please see Chapter 18 (Default Changes) of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual] </u>

		⚫	For backward compatibility and default changes, please see Chapter 18 (Default Changes) of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual] </u>

	=Frequently Asked Questions (FAQ)=		=Frequently Asked Questions (FAQ)=

Emilie Nielsen: /* Backward Compatibility Change Register */

2026-04-09T23:52:17Z

Backward Compatibility Change Register

← Older revision		Revision as of 09:52, 10 April 2026
Line 2:		Line 2:
	=Backward Compatibility Change Register=		=Backward Compatibility Change Register=

	For backward compatibility and release notes, please see Chapter 18 of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual] </u>		For backward compatibility and release notes, please see Chapter 18 (Default Changes) of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual] </u>

	=Frequently Asked Questions (FAQ)=		=Frequently Asked Questions (FAQ)=

Pavlina Monhartova: /* How can differences in model results between TUFLOW builds be investigated? */

2026-03-31T02:23:35Z

How can differences in model results between TUFLOW builds be investigated?

← Older revision		Revision as of 12:23, 31 March 2026
Line 38:		Line 38:
	* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.		* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.
	<li> Run the original model with the newer build, and without the <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.		<li> Run the original model with the newer build, and without the <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.
	* This more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.		* This is more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.
	<li> Iteratively run the original model with the newer build, stepping through the different release version options for <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.		<li> Iteratively run the original model with the newer build, stepping through the different release version options for <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.
	* This will allow the modeller to investigate and isolate what changes to TUFLOW builds may be affecting results, and when changes appear.		* This will allow the modeller to investigate and isolate what changes to TUFLOW builds may be affecting results, and when changes appear.
	* Then, individually reverting settings that make up a Default group (see Chapter 18 of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>).		* Then, individually reverting settings that make up a Default group (see Chapter 18 of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>).
	* This can help isolate the primary drivers for any differences in results.		* This can help isolate the primary drivers for any differences in results.
	* The <u>[https://docs.tuflow.com/classic-hpc/changelog// TUFLOW Classic/HPC Changelog]</u> ~~that~~ accompanying build releases are also a key reference.		* The <u>[https://docs.tuflow.com/classic-hpc/changelog// TUFLOW Classic/HPC Changelog]</u> accompanying build releases are also a key reference.
	<li> Develop new improved or updated model version, with the newer build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).		<li> Develop new improved or updated model version, with the newer build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).
	*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later build, a good quality assurance check that changes are behaving as expected.		*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later build, a good quality assurance check that changes are behaving as expected.

Anne.Kolega: /* Backward Compatibility Change Register */

2026-03-31T02:20:21Z

Backward Compatibility Change Register

← Older revision		Revision as of 12:20, 31 March 2026
Line 2:		Line 2:
	=Backward Compatibility Change Register=		=Backward Compatibility Change Register=

	For backward compatibility and release notes, please see ~~Section~~ 18 of the <u> ~~TUFLOW Manual~~ [https://docs.tuflow.com/classic-hpc/manual/~~2026.0/contents.html~~] </u>		For backward compatibility and release notes, please see Chapter 18 of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest TUFLOW Manual] </u>

	=Frequently Asked Questions (FAQ)=		=Frequently Asked Questions (FAQ)=

Pavlina Monhartova: /* How can differences in model results between TUFLOW builds be investigated? */

2026-03-31T02:19:23Z

How can differences in model results between TUFLOW builds be investigated?

Pavlina Monhartova: /* How can differences in model results between TUFLOW builds be investigated? */

2026-03-31T02:18:45Z

How can differences in model results between TUFLOW builds be investigated?

← Older revision		Revision as of 12:18, 31 March 2026
Line 28:		Line 28:

	== How can differences in model results between TUFLOW builds be investigated? ==		== How can differences in model results between TUFLOW builds be investigated? ==
	Running TUFLOW on a later ~~Build~~ from which it was originally calibrated will not necessarily produce the same results, as discussed in <u>[[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F \| Why are model results developed in an older release different to a newer release?]]</u>.		Running TUFLOW on a later build from which it was originally calibrated will not necessarily produce the same results, as discussed in <u>[[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F \| Why are model results developed in an older release different to a newer release?]]</u>.

	The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable Build, checking for consistency to original results each time.		The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable Build, checking for consistency to original results each time.

Anne.Kolega: /* Backward Compatibility Change Register */

2026-03-31T02:17:24Z

Backward Compatibility Change Register

← Older revision		Revision as of 12:17, 31 March 2026
Line 2:		Line 2:
	=Backward Compatibility Change Register=		=Backward Compatibility Change Register=

	For backward compatibility and release notes, please see Section 18 of the <u>TUFLOW Manual [https://docs.tuflow.com/classic-hpc/manual/2026.0/contents.html]</u>		For backward compatibility and release notes, please see Section 18 of the <u> TUFLOW Manual [https://docs.tuflow.com/classic-hpc/manual/2026.0/contents.html] </u>

	=Frequently Asked Questions (FAQ)=		=Frequently Asked Questions (FAQ)=

Anne.Kolega: /* Default changes pre 2017-09 Build */ deleted this section as in Manual

2026-03-31T02:14:30Z

Default changes pre 2017-09 Build: deleted this section as in Manual

Show changes

Anne.Kolega: /* Backward Compatibility Change Register */

2026-03-31T02:12:58Z

Backward Compatibility Change Register

← Older revision		Revision as of 12:12, 31 March 2026
Line 1:		Line 1:

	=Backward Compatibility Change Register=		=Backward Compatibility Change Register=

			For backward compatibility and release notes, please see Section 18 of the <u>TUFLOW Manual [https://docs.tuflow.com/classic-hpc/manual/2026.0/contents.html]</u>

	==Default changes pre 2017-09 Build==		==Default changes pre 2017-09 Build==

← Older revision		Revision as of 12:19, 31 March 2026
Line 30:		Line 30:
	Running TUFLOW on a later build from which it was originally calibrated will not necessarily produce the same results, as discussed in <u>[[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F \| Why are model results developed in an older release different to a newer release?]]</u>.		Running TUFLOW on a later build from which it was originally calibrated will not necessarily produce the same results, as discussed in <u>[[TUFLOW_Version_Backward_Compatibility#Why_are_model_results_developed_in_an_older_release_different_to_a_newer_release.3F \| Why are model results developed in an older release different to a newer release?]]</u>.

	The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable ~~Build~~, checking for consistency to original results each time.		The following is an example of steps that can be taken when upgrading a TUFLOW model’s executable build, checking for consistency to original results each time.
	<ol>		<ol>
	<li> Confirm you are able to run the original model with the original ~~Build~~ that would have been used to initially produce results.		<li> Confirm you are able to run the original model with the original build that would have been used to initially produce results.
	* This may be particularly relevant when a model has been externally supplied, for example from a government body.		* This may be particularly relevant when a model has been externally supplied, for example from a government body.
	* Confirm if reproduced results are consistent with supplied results.		* Confirm if reproduced results are consistent with supplied results.
	<li> Run the original model with the newer ~~Build~~, along with a relevant <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command (e.g. <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> Pre 2011 when the original ~~Build~~ was 2010-10).		<li> Run the original model with the newer build, along with a relevant <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command (e.g. <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> Pre 2011 when the original build was 2010-10).
	* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.		* Any differences in results compared to the original results may highlight if there are any changes over time where no backward compatibility had been provided for.
	<li> Run the original model with the newer ~~Build~~, and without the <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.		<li> Run the original model with the newer build, and without the <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.
	* This more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.		* This more likely to see changes in results compared to the original results, which may require justification to the client or resolution by investigating, isolating and remedying the causes, especially if recalibration is not intended as a subsequent step.
	<li> Iteratively run the original model with the newer ~~Build~~, stepping through the different release version options for <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.		<li> Iteratively run the original model with the newer build, stepping through the different release version options for <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.
	* This will allow the modeller to investigate and isolate what changes to TUFLOW ~~Builds~~ may be affecting results, and when changes appear.		* This will allow the modeller to investigate and isolate what changes to TUFLOW builds may be affecting results, and when changes appear.
	* Then, individually reverting settings that make up a Default group (see Chapter 18 of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>).		* Then, individually reverting settings that make up a Default group (see Chapter 18 of the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>).
	* This can help isolate the primary drivers for any differences in results.		* This can help isolate the primary drivers for any differences in results.
	* The <u>[https://docs.tuflow.com/classic-hpc/changelog// TUFLOW Classic/HPC Changelog]</u> that accompanying ~~Build~~ releases are also a key reference.		* The <u>[https://docs.tuflow.com/classic-hpc/changelog// TUFLOW Classic/HPC Changelog]</u> that accompanying build releases are also a key reference.
	<li> Develop new improved or updated model version, with the newer ~~Build~~ (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).		<li> Develop new improved or updated model version, with the newer build (and any grouped or individual defaults that are deemed necessary to retain from the iterative testing in the prior step).
	*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later ~~Build~~, a good quality assurance check that changes are behaving as expected.		*Continue to verify results against the original results as you then iteratively add in or update to any newer functionality or formats that may be available in the later build, a good quality assurance check that changes are behaving as expected.
	</ol>		</ol>
	<br>		<br>