TUFLOW Version Backward Compatibility: Difference between revisions

Content deleted Content added
Default changes pre 2017-09 Build: deleted this section as in Manual
 
(7 intermediate revisions by 3 users not shown)
Line 2:
=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 Section 18 of the <u>TUFLOW Manual [https://docs.tuflow.com/classic-hpc/manual/2026.0/contents.html]</u>
 
For backward compatibility and releasedefault noteschanges, please see SectionChapter 18 (Default Changes) of the <u>TUFLOW Manual [https://docs.tuflow.com/classic-hpc/manual/2026.0/contents.htmllatest TUFLOW Manual]</u>.
 
=Frequently Asked Questions (FAQ)=
Line 28 ⟶ 30:
 
== How can differences in model results between TUFLOW builds be investigated? ==
Running TUFLOW on a later Buildbuild 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 Buildbuild, checking for consistency to original results each time.
<ol>
<li> Confirm you are able to run the original model with the original Buildbuild 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.
* Confirm if reproduced results are consistent with supplied results.
<li> Run the original model with the newer Buildbuild, 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 Buildbuild 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.
<li> Run the original model with the newer Buildbuild, and without the <font color="blue"><tt>Defaults</tt></font> <font color="red"><tt>== </tt></font> command.
* 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 Buildbuild, 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 Buildsbuilds 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>).
* 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 Buildbuild releases are also a key reference.
<li> Develop new improved or updated model version, with the newer Buildbuild (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 Buildbuild, a good quality assurance check that changes are behaving as expected.
</ol>
<br>