QUICK INSTALLATION GUIDE FILE: README.TXT ::Read carefully:: First Instructions for LPL users LPL Version 5.70 ---- 08 Dec 2011 --- www.virtual-optima.com ======================================================================= LPL (Logical Programming Language) is a mathematical modeling language to formulate linear, logical and non-linear mathematical models. ======================================================================= Contents: ********* (1) Installing LPL (2) Unistall LPL (3) Test the LPL installation (4) Register at Virtual-Optima (5) Install a solver (6) If something went wrong (7) The different LPL Software Packages (8) The files in the Packages (9) License and Warrants (A) Acknowledgements (1) Installing LPL *********************************************************************** 1. Download LPL from www.virtual-optima.com. 2. The downloaded file is "install-lpl.exe". 3. Double-click the file install-lpl.exe. Follow the instructions. This will - create a folder (by default c:\LPL) and put all files there. - create a Shortcut on the desktop, called "Modelling". 4. That's it ! 5. Double-Click the Shortcut "Modeling" to start LPL. 6. Click the buttom "Do not register". 7. Choose on the Menubar: <> the quit the program again. -- for more information on installing and registering, read the "Installation Guide".-- (2) Unstalling LPL *********************************************************************** 1. Go to the folder where LPL is installed (default is C:\LPL). 2. Double-Click the file : Uninstall.exe. Follow the instructions. Everything will be removed, even the Shortcut on the desktop. (3) Test the LPL installation *********************************************************************** 1. Double-Click the Shortcut "Modeling" to start LPL. 2. Click the buttom "Do not register". 3. Choose on the Menubar: <> 4. Choose the file "alloy.lpl" in the folder list. 5. Choose on the Menubar: <> (or press key F9). 6. The model runs and the output is something like the following : cost 86400.00 AMOUNT{o} ore1 ore2 ore3 ore4 800.00 1200.00 2000.00 800.00 7. If the output is not what mentioned above, then the solver was not correctly configured. Then see (5) below; "Test the Solver". (4) Register at Virtual-Optima after download LPL *********************************************************************** LPL comes as an "Unregistered Package". You can use it without need to register. If you register, you'll get a license key by email that you install. After installation, the software is a "Free Package" with the right to upgrade to an advanced payable package. After a certain time (typically after 1 month) the software expires and become a "Registered Package". You then can again obtain a key free of charge (or an payable key for an advanced package). Registering is free and gives you the right to upgrade. You only need to enter your name and an email address, where the key will be sent to. 1. Double-Click the Shortcut "Modeling" to start LPL. 2. Click the buttom "Register for free". 3. An Internet browser page opens where you enter the data. 4. You'll then get a confirmation that the registering was successful or not. 5. If successful, you'll get an email with the license key. 6. Within the software LPL, click "Enter License Key" or start LPL and choose Menu: <>. 7. Copy / Paste the license key from the email. 8. Click OK. 9. Restart LPL to activate the key: you now have a "Free Package". (5) Install a Solver *********************************************************************** LPL comes with a integrated LP solver to solve small, simple models. It is pre-installed in the downloaded package. If you need to solve large, discrete or non-linear models then you need a free or commercial solver (lp_solve, cplex, etc.). LPL can well communicate with many free and commercial solvers. There are links to several free and commercial solvers at the download page of www.virtual-optima.com. The simplest is to try the free solver lp_solve or glpk. Proceed as follows (for lp_solve): 1. Download the solver from www.virtual-optima.com (page "Download") 2. Install it, make sure that it is in the same directory as LPL or set a path in lplcfg.lpl to it (using the SetPathes()). 3. Open the file lplcfg.lpl 4. Within the file look for "SetSolver(lp_solve);" 5. Remove the two dashes ("--") at the beginning of the line. 6. Make sure that ALL lines follow that one begin with "--" 7. Save the modified file lplcfg.lpl If you need to execute another commerial solver (for example cplex11): 1. Install the solver (see documentation from the solver provider) 2. Add the instruction (within lplcfg.lpl or in the model): SetPathes('C:/ILOG/CPLEX110/bin/x86_win32;'); --(supposing the solver was install in that folder). 3. Open the file lplcfg.lpl 4. Within the file look for "SetSolver(cplex11LSol);" 5. Remove the two dashes ("--") at the beginning of the line. 6. Make sure that ALL lines follow that one begin with "--" 7. Save the modified file lplcfg.lpl Test the Internet Solver (only for registered packages): 1. Open the file lplcfg.lpl 2. Remove the two dashes at the line "SetSolver(InterSol);" 3. Make sure that ALL lines follow that one begin with "--" 4. Save the file lplcfg.lpl 5. Run the model alloy.lpl (as above) (the model is solved remotely) (6) If something went wrong *********************************************************************** LPL did not find a file: Make sure that everything is in the same folder or edit carefully the instruction "SetPathes('....')" in the file lplcfg.lpl. Please note that '\\' means '\' in a file path or use '/'. Add an environment variable LPLPATH as described in the Ref. Manual. The solver did not work: Be sure that the corresponding solver was correctly installed and you have installed eventually a solver license. Be sure to add the path to the solver at the "SetPathes('...');" within the file lplcfg.lpl. Be sure that the last "SetSolver(...)" in file lplcfg.lpl points to the corresponding solver you want. If the solver is not defined in lplcfg.lpl then you need to define it yourself. This is more involving: read the Reference Manual. (7) The different LPL Software Packages *********************************************************************** The full LPL modeling software comes in one single compressed file: lpl-install.exe The downloaded version does not include a license file, and is called the "Unregistered Package". After registering, you get a license key by email, that you should install, and the software becomes the "Free Package", that expires after 1 month. Then it becomes a "Registered Package". You then can again obtain a key free of charge to generate another "Free Package". The three packages "Unregistered Package", "Registered Package" and "Free Package" contain the same functionalities, with the exception, that the Free Package allow you to upgrade to advanced packages. One can buy an upgrade for a moderate price to get an "Academic Package" "Professional Package" "Enterprise Package" Read the document price.pdf to get a full overview of the functions. (8) The files in the Packages *********************************************************************** files/folders comment --------------------------------------------------------------------- README.TXT this file update.txt the update log for LPL development license-free.txt the licence file for Free Package license.txt the licence file for the other packages lplmsg.txt the LPL compiler error messages file manual.pdf LPL Reference Manual user.pdf LPLW User Manual install.pdf Installation Guide price.pdf Product Description Guide lplw.exe main LPL software for model environment lplc.exe a console compiler of the LPL lpls.exe a console version of the LPL server lpldb.dll needed for database & report connectivity of LPL lplint.dll needed for connecting to the Internet Solver lpl.dll a complete library (dynamic link library) of LPL lplj.dll same as lpl.dll, for Java direct access lpldraw.dll library for drawing in LPL alloy.lpl a test LPL-model lplcfg.lpl a LPL config file (defines pre-installed solvers) lpl.tex a LaTeX macro file for the LaTeX-file generation access.mdb a blank Access2000 database (used to generate DBs) excel.xls a blank Excel (used to generate a new xls-file) gurobi.prm the solver interface file to gurobi cplex.prm the solver interface file to Cplex cplex65.prm the solver interface file to Cplex 6.5 xpress.prm the solver interface file to Xpress lindo.prm the solver interface file to Lindo knitro.prm the solver interface file to Knitro modeldoc.bat Batch job to generate the model docs in PDF javaexam.zip Full java-to-LPL interface example \tutor subfolder with all tutor examples \x64 subfolder with the 64bit executables (9) License and Warrants **************************************************************************** By installing or using any Package of LPL you must agree to the license text written in the license file: license.txt and license-free.txt (A) Acknowledgements **************************************************************************** The first version of LPL was created in 1987 for larger projects at the Department of Informatics (DIUF) at the University of Fribourg, Switzerland. LPL grew over time and was permanently supported using the infrastructure of the mentioned Department and over 4 years (1997-2001) financed by the Swiss National Science Foundation (project no. 12-55989.98). AUTHOR: Tony Huerlimann --end of document