Differences

This shows you the differences between two versions of the page.

--- doc:user:tutorials:installation [2014/10/21 10:55] – joris
+++ doc:user:tutorials:installation [2024/03/01 16:17] (current) – boman
@@ Line 1: / Line 1: @@
-====== Installing Metafor ======
+====== How to install Metafor? ======
 ===== Video =====
-This video shows how to install Metafor. Watch it to avoid reading this page.
+This video shows how to install Metafor on a PC running Windows.
-<html>
+<WRAP centeralign column 100%>
-<iframe width="853" height="480" src="//www.youtube.com/embed/14Wt2mst3B0" frameborder="0" allowfullscreen></iframe>
+{{url>https://www.youtube.com/embed/14Wt2mst3B0 noborder allowfullscreen}}
-</html>
+</WRAP>
-===== Installing python =====
-Metafor works with Python ([[http://www.python.org/|official website]]), which is provided automatically when installing Metafor.
+===== Download the installer =====
-===== Installing Metafor =====
-On Windows, just use the setup.
+Installers are available for Windows, Linux and macOS on this website: [[teaching:private:start|]]
-{{ doc:user:install_metafor.jpg |}}
-Towards the end, it is possible to install Visual C++ 2005 Microsoft runtimes (do so if you do not know what I am talking about).
+{{ :doc:user:tutorials:padlock.jpg?nolink&200|}}
+===== Step-by-step Procedure =====
-On Linux/Unix, just decompress a tarball.
+  * Run the installer and follow the instructions.
+  * Install the Visual 2015 C++ runtime libraries if they are not present on your system.
+  * Run Metafor (desktop link).
+  * Click on the padlock in order to import the license file (''metafor.lic'').
+  * Restart Metafor.
+===== Where is Metafor? =====
+By default, all the files are located in ''C:\Program Files\Metafor''
+{{ :doc:user:tutorials:what_is_installed.jpg?nolink&200|}}
-===== License =====
+===== What is installed? =====
-Metafor requires a license (''metafor.lic'' file, to put in the user directory - ''C:\Users\UserName'' on Vista, ''C:\Documents and Settings\UserName'' on XP, directory ''~'' on Linux). If no license exists, the installation program will copy a "demo" license of maximum 500 nodes.
+Have a quick look at the files installed in ''C:\Program Files\Metafor''.
-To request a license, the MAC addresses of the computer that will run Metafor must be known. The easiest way to get them is to delete the file ''metafor.lic'' and run the GUI (Graphical User Interface).
+  * ''Metafor'': Binary files (*.exe, *.dll, etc.).
+  * ''.../apps'': Lots of examples (input files).
+  * ''.../metafor.ltas.ulg.ac.be'': Offline documentation (html files).
+  * ''.../python'': Local installation of python.
+  * ''.../toolbox'': Python toolbox of Metafor.
+  * ''.../wrap'': Python/C++ interface.
-{{ doc:user:getmac.png |}}
-As can be seen above, the MAC addresses are printed out by Metafor. Now, email them to the LTAS-MN²L to get an appropriate license. Once you have it, use the "Import" function that you can see on the picture above to import the new license file.
-Finally, restart Metafor, so the program can read the new license file.
-===== A DLL went missing when installing Metafor =====
-Metafor needs Python to run. Install the appropriate python version (it should be the one used to compile the Metafor version you are currently installing. The name of the missing DLL might help you find the right version).
-===== Metafor Files =====
-When installing Metafor on a computer, several directories are created :
-{{ doc:user:fichiersinstall.png |doc:user:fichiersinstall.png }}
-    * **doc** : a snapshot of the online documentation, corresponding to your version of Metafor. These pages are offline and will not be modified
-    * **oo_meta** : this directory contains Metafor and its files, described below
-    * **redist** : the setup of VC++ 2005 runtimes, if you did not install them earlier
-The executable file of Metafor (''Metafor.exe'') and its [[doc:user:general:glossaire#DLL|DLLs]] are located in ''oo_meta''. There, you can find three folders, corresponding to some Python "[[doc:user:general:glossaire#module|modules]]" (a module is a Python concept similar to packages in Java, or simply to libraries) :
-    * **oo_meta/apps** : contains a  [[doc:user:general:glossaire#batterie|series of test cases]]. It is a set of Python files, sorted in a tree structure. To each file corresponds a [[doc:user:general:glossaire#test case]] (so each test case is a Python [[doc:user:general:glossaire#module]]).
-    * **oo_meta/toolbox** : contains Python modules which defines useful functions that will be used to create test cases. For instance, one will create a cube, another will define a material, a load, ... This directory ''toolbox'' contains a module named ''utilities'', which includes all the main functions used to call Metafor (function ''meta'' (to start a simulation), ''vizu'' (to view a mesh), ''restart'' (to restart a simulation) ...).
-    * **oo_meta/wrap** : contains modules from the "wrapper". Those modules define the classes used by Metafor ("shadow classes") with Python. They link together Python and the [[doc:user:general:glossaire#C++]] code compiled within Metafor. The user should not bother himself with those files.
-\\
-\\
-Now that Metafor has been installed, we must check that everything is working well.
-⇒ [[doc:user:tutorials:premiertest|Graphical Interface]]
-\\