Installing Charge Czar

Extracting the zipped tarball

You will have downloaded a file that has a name something like "charge-czar.1.1.1.tar.gz". Unzip and de-tar the distribution file as follows:

gunzip -c charge-czar.1.1.1.tar.gz | tar xvf - 

or

tar -zxf charge-czar.1.1.1.tar.gz 

Building from source

Generic instructions are found in the README file that comes with the source distribution. The key steps are reiterated here.

First unpack the distribution, e.g. "charge-czar-1.1.1.tar.gz", as above. Then, to install in a local directory (in this case, the directory pointed to by the variable $ROOT) type:

cd charge-czar-1.1.1 
python setup.py install --root $ROOT

This will usually install the executable in $ROOT/usr/bin and the python packages in $ROOT/usr/lib/$PYTHONVERSION/site-packages/ where $PYTHONVERSION is your version of python.

To install in the standard place (the usual default is /usr/bin for the executable and /usr/lib/$PYTHONVERSION/site-packages/ for the python modules, where $PYTHONVERSION is your version of python), you can type simply:

cd charge-czar-1.1.1 
python setup.py install 

To run ChargeCzar, you will need to ensure that your PATH variable points to the location of 'charge_czar.py' (default location /usr/bin, or $ROOT/usr/bin, if you used the --root option) and that your PYTHONPATH points to the location of the 'czar' python packages directory (default location /usr/lib/pythonversion/site-packages/ or $ROOT/usr/lib/$PYTHONVERSION/site-packages, again if you used the --root option).

Binary distributions

Unpack the downloaded file as above (it should be named something like "charge-czar-1.1.1.$ARCH.tar.gz", where $ARCH is the architecture of the build platform). Unpacking will create a standard directory structure for your platform. Currently, the only built distributions available are for Linux and Cygwin. On both these platforms, if you unpack into the root directory, no additional actions will be necessary; you should now be able to run "charge_czar.py" on the command line and see a Usage statement. If you unpack into a local directory, you will need to make sure that your PATH environment variable points to the directory containing "charge_czar.py" and that your PYTHONPATH environment variable points to the directory that contains the "czar/" Python package directory. For example, if you unpacked into the directory "/home/yourusername", then to set up these variables, if you are using bash shell, place the following in your .bashrc:

export PATH=/home/yourusername/usr/bin:$PATH
export PYTHONPATH=/home/yourusername/usr/lib/$PYTHONVERSION/site-packages/:$PYTHONPATH

or if you are using c-shell, place the following in your .cshrc:

setenv PATH /home/yourusername/usr/bin:$PATH
setenv PYTHONPATH /home/yourusername/usr/lib/$PYTHONVERSION/site-packages/:$PYTHONPATH

where in both cases $PYTHONVERSION is your version of PYTHON.

Testing the installation

If you want to test ChargeCzar after installation, set up the PATH and PYTHONPATH as described above, and then type within the extracted charge-czar-1.1.1 directory.

cd test 
./test.sh

No output indicates all tests are passed.