Difference between revisions of "New User Installation Guide"

From Tuflow
Jump to navigation Jump to search
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
=Introduction=
 
=Introduction=
−
Welcome to TUFLOW. This is a page for new users outlining the steps required run TUFLOW for the first time. The standard TUFLOW setup steps are listed below.
+
Welcome to TUFLOW. This is a page for new users outlining the steps required to install and run TUFLOW for the first time. TUFLOW simulations can be executed using a variety of licence hosting approaches. Instructions are provided below for all available methods:
−
 
+
* '''Licence Free Mode''': A licence free mode has been built into TUFLOW. For information outlining the limits associated with the licence free mode, see <u>[[New_User_Guide_Free_Demo_Version | TUFLOW Free DEMO Version Guide]]</u>
−
= Free DEMO Version of TUFLOW =
+
* '''Education Licence Options''': a variety of options are available for education institutions depending on the intended licence use: <u>[[Education_Licence_New_User_Guide|Education Licence Options]]</u>
−
This section is relevant for people who are trialing  TUFLOW without a licence. Please skip to the next section if you have a licence.
+
* '''Local Licence''': In this form TUFLOW simulations can only be run on the computer hosting the licence lock. For installation guidance see:
 
<ol>
 
<ol>
−
<li> Download the latest TUFLOW executable from the TUFLOW website: <u>[http://www.tuflow.com/Tuflow%20Latest%20Release.aspx Tuflow Release Download]</u>. TUFLOW is a standalone console application. As such, it doesn't require installation to run.
+
* <u>[[New_User_Guide_Local_Hardware_Licences | Local Licence USB Hardware Lock (USB) Installation Guide]]</u><br>
−
<li> Download the TUFLOW Tutorial Dataset: <u>[http://www.tuflow.com/Tuflow%20Tutorial%20Models.aspx Tutorial Model Download]</u>
+
* <u>[[New_User_Guide_Local_Software_Licences | Local Licence USB Software Lock (Digital) Installation Guide]]</u><br>
−
<li> User documentation is available from the <u>[[Tutorial_Model | Tutorial Model]]</u> section of the Wiki. Learn how to use TUFLOW by following the user documentation.
+
</ol>
−
<li> Run TUFLOW using any of the options listed in the <u>[[Running_TUFLOW | Running TUFLOW ]]</u> section of the Wiki.
+
* '''Network Licence''': In this form the licence lock can be hosted on any computer or server. Other computers 'check out' licences from the host computer via a company’s network. For installation guidance see:
−
<li> After gaining an understanding of TUFLOW through the tutorial model dataset you may be interested in developing some of your own models for testing. A free Demo option is included within the standard TUFLOW executable. The free Demo version is fully enabled, though has the following limits:
 
−
:*100,000 total cells and 30,000 active (potentially flooded) cells
 
−
:*100 1D channels
 
−
:*There can on be is only one 2D domain (multiple 2D domains are not supported)
 
−
:*A simulation time of 10 minutes. 
 
−
The free Demo mode is called using the TUFLOW Control File (TCF) command: <font color="blue"><tt>Demo Model </tt></font> <font color="red"><tt>== </tt></font><tt>ON</tt><br>
 
−
<li> Over 60 example models demonstrating the most commonly used TUFLOW features are available from the <u>[[Example_Models_Home_page | Example Models]]</u> section of the Wiki. These models call the Demo mode mentioned above, and as such don't require a licence to run. Use these models to learn how to implement features not included in the TUFLOW Tutorials. Refer to the <u>[https://www.tuflow.com/Tuflow%20Documentation.aspx TUFLOW Manual]</u> for further supporting information.
 
−
<li> Other useful information is contained in the Wiki. In particular new users often find the <u>[[Main_Page | Tips and Tricks]]</u> section on the right-hand side of the home page and the <u>[[TUFLOW_Modelling_Guidance | Modelling Guidance]]</u> sections particularly useful.
 
−
<li> If you're interested in becoming a part of the TUFLOW User Community please join the <u>[https://www.tuflow.com/forum/index.php  TUFLOW Forum]</u> and <u>[http://www.linkedin.com/groups/1908583  LinkedIn User Group]</u>.
 
−
<li> Please email <font color="blue"><u>support@tuflow.com</u></font> if you have any technical questions or <font color="blue"><u>sales@tuflow.com</u></font> if you would like to purchase a licence. Price information is available from the <u>[https://www.tuflow.com/Prices.aspx TUFLOW Website]</u>
 
−
</ol><br>
 
−
 
 
−
= Licenced Version of TUFLOW =
 
 
<ol>
 
<ol>
−
<li> Download the latest TUFLOW executable from the TUFLOW website: <u>[http://www.tuflow.com/Tuflow%20Latest%20Release.aspx Tuflow Release Download]</u>. TUFLOW is a standalone console application. As such, it doesn't require installation to run. <br>
+
* <u>[[New_User_Guide_Network_Hardware_Licences | Network Licence Hardware Lock (USB) Installation Guide]]</u>.<br>
−
'''<u>Local Licence</u>'''
+
* <u>[[New_User_Guide_Network_Software_Licences | Network Licence Software Lock (Digital) Installation Guide]]</u>.<br>
−
* Plug your new Local licence dongle into your computer.
+
</ol>
−
* Download and install the Licencing Dongle Drivers (CodeMeter RunTime Kit): <u>[[Wibu_Dongles|Installing Licensing Software]]</u>
+
* '''Network Cloud Licence''': In this form, the licence lock is hosted on a WIBU cloud server. For installation guidance see:
−
* Follow the steps listed in the <u>[[WIBU_Licence_Update_Request | Licence Update Request]]</u> section of the Wiki. You will need to email the licence file to <font color="blue"><u>sales@tuflow.com</u></font>. The sales team with email you an updated licence file containing your specific licence configuration.
+
<ol>  
−
* Import the updated licence file to accept the licence update (<u>[[WIBU_Licence_Update_Import| Licence Import]]</u>
+
* <u>[[New_User_Guide_Cloud_Direct_Licences | Cloud Direct Licence Installation Guide]]</u>: All modelling computers link directly to the WIBU server over an internet connection.<br>
−
* After activating your licence, insert your Local licence dongle in your computer (if it isn't already). Double click the TUFLOW Executable (for example TUFLOW_iSP_w64.exe). A DOS window should open. Review the licence information listed. Check the licence types and numbers.
+
* <u>[[New_User_Guide_Cloud_Server_Licences |Cloud Server Licence Installation Guide]]</u>: A company server acts as the licence host, linked to the WIBU server over an internet connection. Modelling computers are connected to the company server via the company’s network.<br>
−
:[[File:TUFLOW_DOS_Test1.JPG|600px]] <br>
+
</ol>
−
:Press enter to close the DOS window.
 
−
:''Note: Local TUFLOW licences are associated with the USB dongle. All computers running TUFLOW must have Licencing Dongle Drivers (CodeMeter RunTime Kit) installed and the USB dongle plugged in for a simulation to initialise. The Licence Update Request should only be required once annually to update the USB dongle licence and provide access to new updated versions of TUFLOW.''
 
−
* You are now ready to start TUFLOW modelling. Continue to bullet point 3.
 
−
 
 
−
'''<u>Network Licence</u>'''
 
−
* Download and install the Licencing Dongle Drivers (CodeMeter RunTime Kit) on the Network Host computer: <u>[[Wibu_Dongles|Installing Licensing Software]]</u>.
 
−
:''Note: The Network Host does not need to be a server. It can be a standard computer connected to Local Area Network of your company. If this is the case, make sure the Host computer remains on at all times and the computer is assigned a static IP address.  
 
−
* Follow the steps listed in the <u>[[WIBU_Licence_Update_Request | Licence Update Request]]</u> section of the Wiki if you have been sent a new Network licence dongle. You will need to email the licence file to <font color="blue"><u>sales@tuflow.com</u></font>. The sales team with email you an updated licence file containing your specific licence configuration.
 
−
* Import the updated licence file to accept the licence update (<u>[[WIBU_Licence_Update_Import| Licence Import]]</u>
 
−
* After activating your licence insert your Network licence dongle in the Network Host computer (if it isn't already). Double click the TUFLOW Executable (for example TUFLOW_iSP_w64.exe) from the Network Host computer. A DOS window should open. Review the licence information listed. Check the licence types and numbers.
 
−
:[[File:TUFLOW_DOS_Test1.JPG|600px]] <br>
 
−
* Install <u>[[Wibu_Dongles| Licencing Dongle Drivers (CodeMeter RunTime Kit)]]</u> on all client computers wishing to access licences from the Network Host.
 
−
* <u>[[WIBU_Configure_Network_Client | Configure Access]]</u> to the Network licences on all client computers.
 
−
* Double click the TUFLOW Executable (for example TUFLOW_iSP_w64.exe) from the client computer. A DOS window should open. Review the licence information listed (example shown above). Check the licence types and numbers.
 
−
* You are now ready to start TUFLOW modelling. Continue to bullet point 2.
 
−
 
 
−
 
 
−
 
 
−
 
 
−
 
 
−
 
 
−
 
 
−
 
 
−
 
 
−
 
 
−
<li> Download the TUFLOW Tutorial Dataset: <u>[http://www.tuflow.com/Tuflow%20Tutorial%20Models.aspx Tutorial Model Download]</u>
 
−
<li> User documentation is available from the <u>[[Tutorial_Model | Tutorial Model]]</u> section of the Wiki. Learn how to use TUFLOW by following the user documentation.
 
−
<li> Run TUFLOW using any of the options listed in the <u>[[Running_TUFLOW | Running TUFLOW ]]</u> section of the Wiki.
 
−
<li> Over 60 example models demonstrating the most commonly used TUFLOW features are available from the <u>[[Example_Models_Home_page | Example Models]]</u> section of the Wiki. These models call the Demo mode mentioned above, and as such don't require a licence to run. Use these models to learn how to implement features not included in the TUFLOW Tutorials. Refer to the <u>[https://www.tuflow.com/Tuflow%20Documentation.aspx TUFLOW Manual]</u> for further supporting information.
 
−
<li> Other useful information is contained in the Wiki. In particular new users often find the <u>[[Main_Page | Tips and Tricks]]</u> section on the right-hand side of the home page and the <u>[[TUFLOW_Modelling_Guidance | Modelling Guidance]]</u> sections particularly useful.
 
−
<li> If you're interested in becoming a part of the TUFLOW User Community please join the <u>[https://www.tuflow.com/forum/index.php  TUFLOW Forum]</u> and <u>[http://www.linkedin.com/groups/1908583  LinkedIn User Group]</u>.
 
−
<li> Please email <font color="blue"><u>support@tuflow.com</u></font> if you have any technical questions or <font color="blue"><u>sales@tuflow.com</u></font> if you would like to purchase additional licences or add-on modules. Price information is available from the <u>[https://www.tuflow.com/Prices.aspx TUFLOW Website]</u>
 
−
</ol><br>
 

Latest revision as of 20:57, 20 November 2024

Introduction

Welcome to TUFLOW. This is a page for new users outlining the steps required to install and run TUFLOW for the first time. TUFLOW simulations can be executed using a variety of licence hosting approaches. Instructions are provided below for all available methods:

  • Licence Free Mode: A licence free mode has been built into TUFLOW. For information outlining the limits associated with the licence free mode, see TUFLOW Free DEMO Version Guide
  • Education Licence Options: a variety of options are available for education institutions depending on the intended licence use: Education Licence Options
  • Local Licence: In this form TUFLOW simulations can only be run on the computer hosting the licence lock. For installation guidance see:
  • Network Licence: In this form the licence lock can be hosted on any computer or server. Other computers 'check out' licences from the host computer via a company’s network. For installation guidance see:
  • Network Cloud Licence: In this form, the licence lock is hosted on a WIBU cloud server. For installation guidance see:
Retrieved from "https://wiki.tuflow.com/w/index.php?title=New_User_Installation_Guide&oldid=41406"