{"id":208,"date":"2017-06-23T16:35:34","date_gmt":"2017-06-23T15:35:34","guid":{"rendered":"http:\/\/documentation.particleflocker.com\/?post_type=docs&#038;p=208"},"modified":"2017-12-22T18:25:21","modified_gmt":"2017-12-22T18:25:21","slug":"installation-guide","status":"publish","type":"docs","link":"http:\/\/documentation.particleflocker.com\/?docs=particle-flocker-user-guide\/getting-started\/installation\/installation-guide","title":{"rendered":"Installation Guide"},"content":{"rendered":"<p>Installing Particle Flocker is very easy. Once you have purchased a license you will be sent an email with your Particle Flocker account credentials. If you have purchased a license and have not received your account credentials please <a href=\"http:\/\/particleflocker.com\/index.php\/home\/contact\">contact support<\/a> or use the <a href=\"http:\/\/particleflocker.com\/index.php\/login\/PasswordReset\">Reset Password page<\/a> to reset your account password.<\/p>\n<p>This guide is split into the following sections:<\/p>\n<ul>\n<li><a href=\"#access_installer\">Accessing the Installer and License<\/a><\/li>\n<li><a href=\"#windows\">Windows Installation<\/a><\/li>\n<li><a href=\"#linux\">Linux Installation<\/a><\/li>\n<li><a href=\"#launch\">Launching Particle Flocker<\/a><\/li>\n<li><a href=\"#providing_node_locked\">Providing a Node-Locked License<\/a><\/li>\n<li><a href=\"#activate_trial\">Activating the 14 Day Trial<\/a><\/li>\n<\/ul>\n<h2 id=\"access_installer\">Accessing the Installer and License<\/h2>\n<p>Installers and license information can be downloaded from your Particle Flocker account page.<\/p>\n<p><a href=\"http:\/\/account.particleflocker.com\">http:\/\/account.particleflocker.com<\/a><\/p>\n<p>You can see the locations of the license and also the download links for the installers depending on your license type.<\/p>\n<p><img loading=\"lazy\" class=\"alignnone wp-image-112 size-large\" src=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/PFAccountPage-1024x774.jpg?_t=1498144583\" alt=\"\" width=\"835\" height=\"631\" srcset=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/PFAccountPage-1024x774.jpg 1024w, http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/PFAccountPage-300x227.jpg 300w, http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/PFAccountPage-768x580.jpg 768w, http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/PFAccountPage.jpg 1280w\" sizes=\"(max-width: 835px) 100vw, 835px\" \/><\/p>\n<p>Once you have downloaded your installer you simply need to follow the installation instructions for your particular OS.<\/p>\n<h2 id=\"windows\">Windows Installation<\/h2>\n<h3>Wizard Installation<\/h3>\n<p>To install on windows using the installer wizard:<\/p>\n<ol>\n<li>Double click on the Particle Flocker installer executable file<\/li>\n<li>Click through the various prompts as required<\/li>\n<li>If installing a floating license, copy your license from your Particle Flocker account page (see above) and paste it into the box when prompted. (If you are installing a non-floating license version, you will be prompted to enter a license or begin your trial period at a<a href=\"#providing_node_locked\"> later stage<\/a>.)<br \/>\n<img loading=\"lazy\" class=\"alignnone wp-image-165 \" style=\"margin: 5px;\" src=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/LicenseBox.jpg?_t=1498216865\" alt=\"\" width=\"458\" height=\"355\" srcset=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/LicenseBox.jpg 513w, http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/LicenseBox-300x233.jpg 300w\" sizes=\"(max-width: 458px) 100vw, 458px\" \/><\/li>\n<li>Click finish to complete the installation<\/li>\n<\/ol>\n<h3>Command Line Installation<\/h3>\n<p>You can also install Particle Flocker using the command line. Typically this method will be used by systems administrators who need to install the software onto multiple computers.<\/p>\n<ol>\n<li>You can view all installer options by using \/? option\n<pre>ParticleFlocker_win64.exe \/?<\/pre>\n<\/li>\n<li>If installing a floating license use the \/LICENSE option (This is an additional option not shown in the standard options). You can specify the actual license following an equals sign:\n<pre>ParticleFlocker_win64.exe \/LICENSE=12345<\/pre>\n<\/li>\n<\/ol>\n<h2 id=\"linux\">Linux Installation<\/h2>\n<p>To install on a Linux computer:<\/p>\n<ol>\n<li>Extract the .bsx file to a directory on your computer<\/li>\n<li>Open a terminal and navigate to the extracted file<\/li>\n<li>Execute the file by using the sh command, for example:\n<pre>sh ParticleFlocker_linux.bsx<\/pre>\n<\/li>\n<li>You can also view all command line options with the [-h] flag\n<pre>sh ParticleFlocker_linux.bsx -h<\/pre>\n<\/li>\n<li>If installing a floating license use the [-l] flag followed by your license key:\n<pre>sh ParticleFlocker_linux.bsx -l 12345<\/pre>\n<\/li>\n<\/ol>\n<h2 id=\"launch\">Launching Particle Flocker<\/h2>\n<p>Once Particle Flocker has been successfully installed you can immediately begin to use it by loading any <a href=\"http:\/\/documentation.particleflocker.com\/?docs=particle-flocker-user-guide\/getting-started\/installation\/supported-maya-versions\">supported version of Maya<\/a>.<\/p>\n<p>In Maya you should see a new <strong>TechToast<\/strong> Menu at the top of the window (unless you are using the <a href=\"http:\/\/documentation.particleflocker.com\/?docs=particle-flocker-user-guide\/getting-started\/installation\/releases\">Render-Only release<\/a> which has no user interface tools). You can launch the <a href=\"http:\/\/documentation.particleflocker.com\/?docs=particle-flocker-user-guide\/particle-flocker-ui\">Particle Flocker Window<\/a> by clicking on the <strong>Particle Flocker Window&#8230;<\/strong> menu item.<\/p>\n<p><img loading=\"lazy\" class=\"alignnone size-full wp-image-261\" src=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/TechToast.jpg\" alt=\"\" width=\"386\" height=\"213\" srcset=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/TechToast.jpg 386w, http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/TechToast-300x166.jpg 300w\" sizes=\"(max-width: 386px) 100vw, 386px\" \/><\/p>\n<h2 id=\"providing_node_locked\">Providing a Node-Locked License<\/h2>\n<p>If you are installing a non-floating license version you will be asked to input a license the first time you try to open the Particle Flocker window.<\/p>\n<p><img loading=\"lazy\" class=\"alignnone size-full wp-image-631\" src=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/EnterLicensePrompt.jpg\" alt=\"\" width=\"329\" height=\"132\" srcset=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/EnterLicensePrompt.jpg 329w, http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/EnterLicensePrompt-300x120.jpg 300w\" sizes=\"(max-width: 329px) 100vw, 329px\" \/><\/p>\n<p>Simply copy and paste your license from your Particle Flocker account page into this box. The license you enter will be saved in your preferences and once successfully licensed, you will not be asked to provide a license again.<\/p>\n<h2 id=\"activate_trial\">Activating the 14 Day Trial<\/h2>\n<p>If you are installing the trial version of Particle Flocker you will need to press the<strong> I don&#8217;t have a license<\/strong> button shown above. This will bring up a new dialog prompt asking if you want to start the trial. Simply press the <strong>Start Trial<\/strong> button shown below:<\/p>\n<p><img loading=\"lazy\" class=\"alignnone size-full wp-image-632\" src=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/StartTrial.jpg\" alt=\"\" width=\"292\" height=\"112\" \/><\/p>\n<p>Once activated the Particle Flocker Window will open. You will notice that your remain trial period will be shown at the top of the window:<\/p>\n<p><img loading=\"lazy\" class=\"alignnone size-full wp-image-633\" src=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/TrialVersion.jpg\" alt=\"\" width=\"336\" height=\"82\" srcset=\"http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/TrialVersion.jpg 336w, http:\/\/documentation.particleflocker.com\/wp-content\/uploads\/TrialVersion-300x73.jpg 300w\" sizes=\"(max-width: 336px) 100vw, 336px\" \/><\/p>\n<p>&nbsp;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":110,"menu_order":4,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"doc_tag":[],"_links":{"self":[{"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/docs\/208"}],"collection":[{"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=208"}],"version-history":[{"count":14,"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/docs\/208\/revisions"}],"predecessor-version":[{"id":830,"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/docs\/208\/revisions\/830"}],"up":[{"embeddable":true,"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/docs\/110"}],"next":[{"title":"Troubleshooting","link":"http:\/\/documentation.particleflocker.com\/?docs=particle-flocker-user-guide\/getting-started\/installation\/troubleshooting","href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/docs\/657"}],"prev":[{"title":"Supported Operating Systems","link":"http:\/\/documentation.particleflocker.com\/?docs=particle-flocker-user-guide\/getting-started\/installation\/supported-operating-systems","href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=\/wp\/v2\/docs\/130"}],"wp:attachment":[{"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=208"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"http:\/\/documentation.particleflocker.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=208"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}