<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Frepple / Environment variables</title> <link rel='stylesheet' href='../styles.css' type='text/css' /> <!--PageHeaderFmt--> </head> <body> <div id="container"> <div id="menubar"> <div id="logo" align="center"> <br/><img src='../frepple.bmp' alt="frepple" /><br/> <a href='http://www.frepple.com/'> <strong>a Free<br/>Production Planning<br/>Library</strong> </a></div> <div id="menu"> <br/> <h3><a href='../Main/HomePage.html'>Main</a></h3> <h3><a href='../UI/Main.html'>User Manual</a></h3> <h3><a href='../Tutorial/Main.html'>Tutorial</a></h3> <h3><a href='Main.html'>Reference Manual</a></h3> <h3><a href='../Main/FAQ.html'>FAQ</a></h3> <h3><a href='../reference/index.html'>C++ API</a></h3> <br/><div> </div> </div> </div> <div id="content"> <br/> <!--PageText--> <div id='wikitext'> <p><a class='wikilink' href='../Main/HomePage.html'>Main</a> > <span class='wikitrail'><a class='wikilink' href='Main.html'>Reference Manual</a> > <a class='wikilink' href='Modeling.html'>Modeling</a> > <a class='selflink' href='ModelingEnvVariables.html'>Environment variables</a></span> </p> <p class='vspace'>A number of environment variables influence frePPLe. </p> <div class='vspace'></div> <table border='1' ><tr><td width='33%' valign='top'><strong>Variable</strong> </td><td width='67%' valign='top'><strong>Description</strong> </td></tr><tr><td valign='top'>FREPPLE_HOME </td><td valign='top'> <p>FrePPLe uses the following configuration files during the execution of the program: </p><ul><li>The file <em>frepple.xsd</em> points to the xsd schema for the frePPLe XML files.<br /> This xsd file typically references additional xsd files located in the same directory. </li><li>If present, the XML data in the file <em>init.xml</em> are processed automatically when frePPLe is started.<br /> This is the recommended place to load any standard data entities your application may need. </li><li>If present, the Python code in the file <em>init.py</em> is executed automatically when frePPLe is started.<br /> This is the recommended place to define any Python functions or classes your application may need. FrePPLe extension modules are also typcially loaded in this file. </li><li>Plugin <em>module libraries</em>. </li></ul><p>FrePPLe searches the following directories in sequence to locate these files. </p><ul><li>The current directory. </li><li>The directory pointed to by the FREPPLE_HOME environment variable. </li><li>The data directory where the default configuration files are installed.<br /> This applies only for Linux and Unix platforms. </li><li>The library directory where the default module libraries are installed.<br /> This applies only for Linux and Unix platforms. </li><li>For the loading module libraries frePPLe also searches the standard path for location shared libraries.<br /> Configuring this is platform dependent. </li></ul><p>By setting the FREPPLE_HOME environment variable you can control the directories where the application looks for your application files. </p></td></tr><tr><td valign='top'>LC_ALL </td><td valign='top'> <p>FrePPLe stores string data internally using the encoding associated with your locale.<br />This setting is important when dealing with non-ascii characters in your data. Your locale needs to support all characters being used, just as your database will also need to support them.<br /><strong>Most modern Linux distributions have a default locale that supports utf-8, which allows every possible unicode character to be represented.<br />On Windows, this environment variable isn't used and FrePPLe can only represent characters present in the default windows locale. Use the "regional and language settings" screen from the control panel to change that default locale.</strong> </p></td></tr><tr><td valign='top'>TZ </td><td valign='top'> <p>FrePPLe uses the C-library functions for date and time manipulations. These functions are respecting timezones and daylight saving time, which can give sometimes give unexpected results: <strong>twice a year you'll find a day with 25 or 23 hours</strong>.<br />To disable any effects of daylight saving time, change the TZ variable to a timezone without daylight saving time, e.g. 'EST'. </p></td></tr><tr><td valign='top'>NUMBER_OF_PROCESSORS </td><td valign='top'>Controls the maximum number of parallel threads that can be used for a frePPLe command.<br />On windows platforms, this variable is automatically set to the number of cpu's and cores of your machine. On other platforms it'll need to be set explicitly.<br />When left unspecified, a default value of 1 is used: i.e. sequential, single-threaded execution. </td></tr></table> </div> <!--PageFooterFmt--> <!--HTMLFooter--> </div></div> </body> </html>
