Difference between revisions of "MTD template"

From FIThydrowiki
Jump to navigation Jump to search
Line 1: Line 1:
−
<h1>Descriptions of new methods, tools, and devices</h1>
+
<h1>[insert name of MTD]</h1>
−
<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>Developed by: [insert institution, partner, persons]</p>
−
<p>Therefore, we would like to receive descriptions of such new MTDs according to the template below.</p>
+
<p>Date:</p>
−
<p>The definitions used for MTDs in FIThydro WP4 are the following:</p>
+
<p>Type: [choose method, tool (model), device or combination of these]</p>
−
<ul>
+
<p>Suitable for which mitigation measure (see list) and phase (planning, implementation, maintenance): [insert one or several options]</p>
−
<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><u>Tools</u> - these are methods embedded in for instance a computer program / a model. Example: HEC-RAS.</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>
 
−
<h2>Template:</h2>
 
−
<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>
 
−
<p>Length: The description should be in the range of 1-3 pages, including pictures.</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>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>Introduction:&nbsp;</h2>
 
<h2>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><em>Describe the background and what the MTD is doing or can be used for. How does it work? Why was it made the way it was? Include something about the theory behind, the scientific foundation, engineering etc. Include a picture or illustration suitable for giving the first impression of the MTD. &frac12; - 1 page</em></p>
 
<h2>Application:</h2>
 
<h2>Application:</h2>
−
<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><em>How can the MTD be applied? If it is a method, we suggest including a flowchart of the process. If it as computer model, some pictures of for example model outputs can be included, as well as information about input data. If it is a device, include a picture of the actual device. If the application is very complex, make a simplified description here and include a reference to a more detailed description if it exists. Include examples of where the MTD 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. 1-2 pages</em></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>
+
<p><strong>Other information:</strong></p>
−
<h2>Other:</h2>
+
<p><em>Include other relevant information. Costs of purchase, use, license etc can be added here.</em></p>
−
<p>Type: (Method/tool/device)</p>
+
<p><strong>References:</strong></p>
−
<p>Can be applied in*: (List of measures, including the stage)</p>
+
<p><em>Include all relevant references</em></p>
−
<p>*This will have to be double-checked when the complete lists of measures it compiled.</p>
+
<p><strong>Contact information:</strong></p>
 +
<p><em>Include website, email or other ways of contacting the owner or developer of the MTD</em></p>

Revision as of 10:13, 17 January 2019

[insert name of MTD]

Developed by: [insert institution, partner, persons]

Date:

Type: [choose method, tool (model), device or combination of these]

Suitable for which mitigation measure (see list) and phase (planning, implementation, maintenance): [insert one or several options]

Introduction: 

Describe the background and what the MTD is doing or can be used for. How does it work? Why was it made the way it was? Include something about the theory behind, the scientific foundation, engineering etc. Include a picture or illustration suitable for giving the first impression of the MTD. ½ - 1 page

Application:

How can the MTD be applied? If it is a method, we suggest including a flowchart of the process. If it as computer model, some pictures of for example model outputs can be included, as well as information about input data. If it is a device, include a picture of the actual device. If the application is very complex, make a simplified description here and include a reference to a more detailed description if it exists. Include examples of where the MTD 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. 1-2 pages

Other information:

Include other relevant information. Costs of purchase, use, license etc can be added here.

References:

Include all relevant references

Contact information:

Include website, email or other ways of contacting the owner or developer of the MTD

Retrieved from "https://www.fithydro.wiki/index.php?title=MTD_template&oldid=564"