Difference between revisions of "MTD template"

From FIThydrowiki
Jump to navigation Jump to search
Line 1: Line 1:
<h1 style="margin-left: 0in;">Descriptions of new methods, tools, and devices</h1>
+
<h1>Descriptions of new methods, tools, and devices</h1>
<p style="padding-bottom: 0in; border-bottom: 0in none black;">When describing the methods tools and devices for the three stages <em>planning</em>, <em>construction/implementation</em>, and <em>operation/maintenance</em> there will be mentions of specific MTDs that can be used. Often, these will be well-known with substantial documentation, such as HEC-RAS, OpenFoam, trap samplers, and excavators. In these cases, references can be made to existing sources such as papers or manuals. However, new MTDs have also been developed as part of FIThydro, and these cases should have additional documentation on a wiki/website. If other MTDs developed outside of FIThydro are new and/or poorly documented/known, it could be beneficial to write a description of those as well.</p>
+
<p>When describing the methods tools and devices for the three stages <em>planning</em>, <em>construction/implementation</em>, and <em>operation/maintenance</em> there will be mentions of specific MTDs that can be used. Often, these will be well-known with substantial documentation, such as HEC-RAS, OpenFoam, trap samplers, and excavators. In these cases, references can be made to existing sources such as papers or manuals. However, new MTDs have also been developed as part of FIThydro, and these cases should have additional documentation on a wiki/website. If other MTDs developed outside of FIThydro are new and/or poorly documented/known, it could be beneficial to write a description of those as well.</p>
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">Therefore, we would like to receive descriptions of such new MTDs according to the template below.</p>
+
<p>Therefore, we would like to receive descriptions of such new MTDs according to the template below.</p>
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">&nbsp;</p>
+
<p>The definitions used for MTDs in FIThydro WP4 are the following:</p>
<p style="line-height: 150%; padding-top: 0in;">The definitions used for MTDs in FIThydro WP4 are the following:</p>
 
 
<ul>
 
<ul>
<li style="margin-left: .25in; text-indent: -.25in; padding-bottom: 0in; border-bottom: 0in none black;"><u>Methods</u> &ndash; these are typically descriptions in how to develop and implement mitigating measures (solutions). Example: the building block method for environmental flow.</li>
+
<li><u>Methods</u> &ndash; these are typically descriptions in how to develop and implement mitigating measures (solutions). Example: the building block method for environmental flow.</li>
<li style="margin-left: .25in; text-indent: -.25in; padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;"><u>Tools</u> - these are methods embedded in for instance a computer program / a model. Example: HEC-RAS.</li>
+
<li><u>Tools</u> - these are methods embedded in for instance a computer program / a model. Example: HEC-RAS.</li>
<li style="margin-left: .25in; text-indent: -.25in; padding-top: 0in;"><u>Devices</u> &ndash; these are typically physical instruments or equipment used to measure and/or control, something related to the measure. Example: flow velocity meter, excavator.</li>
+
<li><u>Devices</u> &ndash; these are typically physical instruments or equipment used to measure and/or control, something related to the measure. Example: flow velocity meter, excavator.</li>
 
</ul>
 
</ul>
<p><span style="font-size: 11.0pt; font-family: 'Arial',sans-serif;">&nbsp;</span></p>
+
<h2>Template:</h2>
<p><strong><span style="font-size: 12.0pt;">&nbsp;</span></strong></p>
+
<p><strong>Note:</strong> As the method/tool/device might be applied to different measures and/or at different stages, the descriptions should be kept<strong> generic</strong>, as opposed to very specific for one measure at one stage.</p>
<h2 style="margin-left: 0in;">Template:</h2>
+
<p>Length: The description should be in the range of 1-3 pages, including pictures.</p>
<p style="padding-bottom: 0in; border-bottom: 0in none black;"><strong>Note:</strong> As the method/tool/device might be applied to different measures and/or at different stages, the descriptions should be kept<strong> generic</strong>, as opposed to very specific for one measure at one stage.</p>
+
<p>Pictures: The more pictures and illustrations, the better. Not only do they help understanding significantly, but they will make a future wiki/website much more pleasing to look at and interact with.</p>
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">&nbsp;</p>
+
<p>References: Please include references according to normal practice. Especially important with references to user manuals and/or papers about the M/T/D.</p>
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">Length: The description should be in the range of 1-3 pages, including pictures.</p>
+
<h2>Introduction:&nbsp;</h2>
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">&nbsp;</p>
 
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">Pictures: The more pictures and illustrations, the better. Not only do they help understanding significantly, but they will make a future wiki/website much more pleasing to look at and interact with.</p>
 
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">&nbsp;</p>
 
<p style="padding-top: 0in;">References: Please include references according to normal practice. Especially important with references to user manuals and/or papers about the M/T/D.</p>
 
<h2 style="margin-left: 0in;">Introduction:&nbsp;</h2>
 
 
<p>"[Insert name of M/T/D] is a [method/tool/device] used for [determining, applying, implementing, etc.] &hellip; It was developed at [&hellip;] as a part of [FIThydro/etc.]". How does it work? Why was it made the way it was? [Write something about the theory/foundation/engineering/etc. aspects of the M/T/D, if applicable].</p>
 
<p>"[Insert name of M/T/D] is a [method/tool/device] used for [determining, applying, implementing, etc.] &hellip; It was developed at [&hellip;] as a part of [FIThydro/etc.]". How does it work? Why was it made the way it was? [Write something about the theory/foundation/engineering/etc. aspects of the M/T/D, if applicable].</p>
<h2 style="margin-left: 0in;">Application:</h2>
+
<h2>Application:</h2>
<p style="padding-bottom: 0in; border-bottom: 0in none black;">How can the M/T/D be applied? Include illustrations: If method, it can be good to include a flowchart of the process; if tool, some pictures of for example model outputs can be included; and if device, include a picture of the actual device. If application is very complex, make a simplified version here and include a reference to a more detailed description if it exists.</p>
+
<p>How can the M/T/D be applied? Include illustrations: If method, it can be good to include a flowchart of the process; if tool, some pictures of for example model outputs can be included; and if device, include a picture of the actual device. If application is very complex, make a simplified version here and include a reference to a more detailed description if it exists.</p>
<p style="padding-top: 0in;">Include examples of where the M/T/D has been applied, if possible (real life cases, laboratory cases, papers, etc.). Explain how it was used in this case and how well it worked.</p>
+
<p>Include examples of where the M/T/D has been applied, if possible (real life cases, laboratory cases, papers, etc.). Explain how it was used in this case and how well it worked.</p>
<h2 style="margin-left: 0in;">Other:</h2>
+
<h2>Other:</h2>
<p style="padding-bottom: 0in; border-bottom: 0in none black;">Type: (Method/tool/device)</p>
+
<p>Type: (Method/tool/device)</p>
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">Can be applied in*: (List of measures, including the stage)</p>
+
<p>Can be applied in*: (List of measures, including the stage)</p>
<p style="padding-top: 0in; padding-bottom: 0in; border-bottom: 0in none black;">*This will have to be double-checked when the complete lists of measures it compiled.</p>
+
<p>*This will have to be double-checked when the complete lists of measures it compiled.</p>

Revision as of 10:10, 17 January 2019

Descriptions of new methods, tools, and devices

When describing the methods tools and devices for the three stages planning, construction/implementation, and operation/maintenance there will be mentions of specific MTDs that can be used. Often, these will be well-known with substantial documentation, such as HEC-RAS, OpenFoam, trap samplers, and excavators. In these cases, references can be made to existing sources such as papers or manuals. However, new MTDs have also been developed as part of FIThydro, and these cases should have additional documentation on a wiki/website. If other MTDs developed outside of FIThydro are new and/or poorly documented/known, it could be beneficial to write a description of those as well.

Therefore, we would like to receive descriptions of such new MTDs according to the template below.

The definitions used for MTDs in FIThydro WP4 are the following:

  • Methods – these are typically descriptions in how to develop and implement mitigating measures (solutions). Example: the building block method for environmental flow.
  • Tools - these are methods embedded in for instance a computer program / a model. Example: HEC-RAS.
  • Devices – these are typically physical instruments or equipment used to measure and/or control, something related to the measure. Example: flow velocity meter, excavator.

Template:

Note: As the method/tool/device might be applied to different measures and/or at different stages, the descriptions should be kept generic, as opposed to very specific for one measure at one stage.

Length: The description should be in the range of 1-3 pages, including pictures.

Pictures: The more pictures and illustrations, the better. Not only do they help understanding significantly, but they will make a future wiki/website much more pleasing to look at and interact with.

References: Please include references according to normal practice. Especially important with references to user manuals and/or papers about the M/T/D.

Introduction: 

"[Insert name of M/T/D] is a [method/tool/device] used for [determining, applying, implementing, etc.] … It was developed at […] as a part of [FIThydro/etc.]". How does it work? Why was it made the way it was? [Write something about the theory/foundation/engineering/etc. aspects of the M/T/D, if applicable].

Application:

How can the M/T/D be applied? Include illustrations: If method, it can be good to include a flowchart of the process; if tool, some pictures of for example model outputs can be included; and if device, include a picture of the actual device. If application is very complex, make a simplified version here and include a reference to a more detailed description if it exists.

Include examples of where the M/T/D has been applied, if possible (real life cases, laboratory cases, papers, etc.). Explain how it was used in this case and how well it worked.

Other:

Type: (Method/tool/device)

Can be applied in*: (List of measures, including the stage)

*This will have to be double-checked when the complete lists of measures it compiled.