On this page, you will find general instructions on how to install a typical Occam server and web portal. There will be links throughout to help guide you through any additional installation that may be required and finally some links to extensions that you might find useful for your own installation.
Note: Windows is an experimental and often feature-lacking environment. Your mileage may vary.
Install Ruby from here, Python from here and Git from here and install them in that order. You can keep all install options as their defaults.
You should get the most up-to-date versions above, but you can also use these links directly to the downloads here:
Note: If installing ruby >=2.4.0 make sure you install MSYS2 and MINGW development toolchain when prompted
Once you have all three installed, open a Command Prompt and then you'll be able to follow along.
Depending on your distribution, you may have to alter the following instructions. You'll need to install git, ruby, and python3 along with docker, sqlite3, and unzip.
pacman -Sy git ruby python3 docker unzip sqlite3
Then follow along for the rest of this guide.
The Occam daemon is the main code that is used to store and execute objects. This tool is strictly a command-line tool and a daemon that can be used in conjunction with front-ends or web-servers to provide a more capable system.
For our typical system, we will place a daemon and then later a web-server on the same machine. We are assuming a Linux machine at the moment. We will need some other tools on the system before we can begin. Using your operating system's package manager, install git, python, and Docker.
After this, type occam and see if the usage appears. If you get a command not found or similar error, recheck the above steps and make sure you are in the occam directory. If the usage appears, continue to the next step.
Initializing a Base System
Run the following to build the initial database:
occam system initialize
This creates a SQLite3 database and the initial configuration within the .occam directory in your home folder (/home//.occam or C:\Users<username>.occam depending on your system)
After this is done, you can create the initial account replacing <username> with your desired username below:
occam accounts new <username>
You now have a base system installed. We can move on to the web-server so we can avoid the command line and see some things in action.
The web client is a web-server capable of interacting with Occam, create new objects, view interactive objects, and deploy computations.
Now we will install the dependencies of the web server. First, we need Bundler which is a package management tool for ruby:
gem install bundler
From then on, we can use bundler to manage our dependencies. Right now, we will install only the dependencies we need to run.
Note: We won't install the test related dependencies because they don't work on all systems at the moment. If you are developing Occam, you should remove the --without test if you are on a Linux or OS X machine.
bundle install --without test
Once this is done, you can start a webserver easily by typing:
And in a different terminal, start an occam daemon (remember that you may need to navigate to your occam/bin directory or put occam in your path):