Up: Getting Started Index | Next: Code Generation - the backbone of Qcubed
Installation of QCubed is pretty straightforward. It is way simpler than say, launching a rocket into space but probably harder than staring at the wall. This documentation assumes that you have read and fulfilled the prerequisites of the previous section and that have an extensive knowledge of particle physics.
Okay, maybe that last bit was not true.
Moving on. The first step is to get a copy of the QCubed framework. You can get the latest version of QCubed here:
After you download it, unzip it. Inside the resulting folder, you will see two folders, _devtools_cli and wwwroot. Our only concern here is with the latter. You now have two choices. You can either copy the contents of this folder to your document root or you can copy the folder itself to the document root. Because you may have other projects in your document root, I recommend that your copy the folder, making it sub folder of your document root. In my case, I copied wwwroot into my docs directory. So my path is C:\docs\wwwroot.
It is recommended that you change the default folder name to something more reflective of your project. Bursting with creativity, I am changing wwwroot name to project.
Now, we must do a little configuration. But where would we find such a place to do such a thing? Why in the configuration file of course! You can find this file in the includes folder. The file is called configuration.inc.php. Open it in your favorite editor. Go ahead, don't be afraid.
For this basic installation, there is one area to be concerned with. Scroll down until you see lines similar to this:
define ('__DOCROOT__', '/var/www/QCubed/wwwroot');
define ('__VIRTUAL_DIRECTORY__', '');
define ('__SUBDIRECTORY__', '');
Change the DOCROOT to whatever your document root actually is. Also, change the subdirectory to the whatever you renamed wwwroot. In my case, the result is:
define ('__DOCROOT__', '/docs');
define ('__VIRTUAL_DIRECTORY__', '');
define ('__SUBDIRECTORY__', '/project');
Notice that I used beginning slashes but not trailing ones. I also did not use C:. if it makes you sad to not have it, you can use it. If you copied the contents of wwwroot directly into your document root, just set that and ignore the subdirectory.
And for basic installation, that is it! Now we just need to test it out. Open up your browser and type in the url for your server (probably localhost) followed by a slash and the subdirectory. If you did everything correctly, you should see the QCubed start page.
Congratulations. You now have a working installation of QCubed. Have some cake in celebration. The cake is not a lie.
Up: Getting Started Index | Next: Code Generation - the backbone of Qcubed
