OxCal > Installation

Installation



Introduction

This version of OxCal can be used in a number of different ways depending on how frequent and intensive your use of the program is likely to be:

The program has three main components:

If you are accessing a server all you will need to deal with is the input and output modules which are integrated, the analysis module runs on the server once you have defined the inputs for the program.


Accessing the site

To access the server, you need a username and password. To get this you click on [New user] and enter your initials, surname and Email address.

A password will then be emailed to you which you can use to enter the site. It is a good idea as you log on to click on [Change password/email] and enter a password that you can remember. You will also have to re-enter your initials, name and email address.

Once you are logged on you have access to your own working area on the server for storing your OxCal data. This data can also be saved locally which is a good idea as the data on the server will not be kept indefinitely.

See Input of data for the next stage once you are sure that your web browser is suitable.


Browser requirements for remote access

The input and output modules perform a lot of operations themselves and so require an up-to-date browser that is set to allow cookies, javascript and pop-up windows. In addition the graphical output is generated within the OxCalPlot module and so if you want graphs you will need to use a browser capable of displaying SVG output. As this is a fairly new standard this limits the choice of browsers.

SVG capabilities are currently provided by all the major browsers Safari, Google Chrome, Opera, Firefox and Internet Explorer (OxCal works with v11 or later).

The choice of browser will depend on your operating system.

Windows

The following setups work very satisfactorily under windows:

Mac OS X

Here the choice is similar except that Internet Explorer is not available in a usable version. The recommended setups are:

Others

You may also have success with other operating systems. This is likely to depend on whether you can get Firefox or Opera to work properly on your system.


Use on your own computer

The program can also be run directly on your own computer using the nodejs package.

Download the distribution package from the OxCal website and unzip the package.

Install the correct version of NodeJs

The latest version for your computer can be found at:

https://nodejs.org/

You may get some warnings which tell you that your firewall will only allow local access which is fine because that is all that is required.

Installation on a PC

Copy the OxCal directory from the package to a suitable directory such as:

C:\Program Files\

Note: you will need write permission to this directory - see below.

Installation on a Mac

Copy the OxCal directory from the package to the directory:

Note: you will need write permission to this directory - see below.

/Applications/

Installation on Linux

This is essentially the same as for Mac but uses a different executable which has been compiled under Ubuntu.

Running the program using NodeJs

Use a command line terminal and change to the oxcal directory. From there run the node software using the NodeServer script by typing:

node NodeServer.js

on the command line. If you prefer you can set this up in a startup batch file or script. This will start the server on which OxCal will now run.

Note: NodeJs will need to be able to access both the program and the user files so you should either run NodeJs using administrator priviledges or install the program in your own user area.

In your browser you then need to enter the url:

http://localhost:8080/

Normally this will take you straight to OxCal but the first time you do this you will be taken to a page which allows you to set up the directory area for files and also the location of the oxcal web files. You can also change the port on which the server runs. As a default it will run on a localhost port not accessible to other computers.

If you ever wish to reset these values you can either navigate to:

http://localhost:8080/setup.html

or press [File > Reset] from within OxCal.


Summary of browser capabilities

BrowserCapabilities
Server versionLocal installation
TextGraphicsSave SVGSave as PDF/PNG TextGraphicsSave SVGSave as PDF/PNG
Camino
Firefox
Google Chrome
Internet Explorer 11 or later
Opera
SeaMonkey
Safari

Installation on a server

If you wish you could set this up on a group server rather than your own computer this would give the group all access to the same user area. In this case you may with to use port 80 but make sure your firewall prevents access from outside your institution. Alternatively you should be able to set it up on different computers as above and share a drive for your files - this will enable you to use more different computers for processing.

Directory structure

OxCal uses three different directories: