Introduction

The setup script only installs the python client as there is no standard place to install jar files.

Installation of python client using the setup script

You must be logged in with write access to the Python site packages - which normally means as root.

Compatibility

This will work with an IDS version of 1.0.0 or greater.

Prerequisites

  • The ids client distribution: ids.client-1.0.1-distro.zip
  • A deployed ids server. This is not necessary for deployment but it will be required subsequently to use the client.
  • Python (version 2.4 to 2.7) installed on the server.

Summary of steps

  1. Please follow the generic installation instructions
  2. Check that it works.

Check that it works

The following should produce no output:

echo 'import ids;ids.IdsClient("https://<hostname>:8181").ping()' | python

In case of problems look in the server.log and the ids.log in the logs directory of your ids server.

Manual Installation of Java client

There are two files that should be made available to those wishing to use the IDS client:

ids.client-1.0.1.jar
the client library which the user should add to the classpath.
ids.client-1.0.1-sources.jar
the source of the client library to which which the user may wish to refer.

Using the Java client from maven

It is expected that most people will express their dependency upon the icat.client by means of a maven pom file. To do this the user needs to define the repository and express the dependency as indicated in the snippet below:

<repositories>
   <repository>
      <id>ICAT Repo</id>
      <url>http://www.icatproject.org/mvn/repo</url>
   </repository>
   ...
</repositories>

<dependencies>
   <dependency>
      <groupId>org.icatproject</groupId>
      <artifactId>ids.client</artifactId>
      <version>1.0.1</version>
   </dependency>
   ...
</dependencies>