====================================== README.piana_installation ====================================== This file describes the steps to follow in order to install PIANA on your computer. PIANA is not a 'click the install button' program, but it should be easy to install for any system administrator. If even your system administrator doesn't manage to install PIANA, try sending us an email: boliva at imim.es ---------------------------------------------------------------------- ------------- 0. get piana ------------- -> place yourself in the directory where you want the PIANA directory to be created (eg. your /home/username directory) then: -> download file piana_vX.tar.gz from http://sbi.imim.es/piana then uncompress it: $your_directory> tar -xzf piana_vX.tar.gz or -> from CVS: cvs checkout -P piana (needs cvs rights on cvs server) --> -P is used to avoid checking out empty directories You should now have a directory called 'piana' in which there are, among others, subdirectories 'code', 'data' and 'docs' That's all: since everything is written in python, no compilation or building is needed. However, you must check that all PIANA requirements are respected (next step) ----------------------------------------- 1. PIANA requirements ----------------------------------------- Read file README.piana_requirements for software you must install before running PIANA. PIANA requires software and python modules that are not installed in standard Linux distributions. There are as well some pre-run commands to execute before being able to use PIANA Depending on the type of user you are, you'll need more or less external external software to run PIANA. Unless you are going to develop code or use functions not documented in the README files, you'll be a 'simple_user'. To learn more about the different types of users that PIANA admits, read section "PIANA types of users" in file README.piana_tutorial ---------------------- 2. Check Installation ---------------------- make sure piana is working by executing: $user> cd piana/code/execs/ $execs> python piana.py ---> if piana asks to enter a database name, the installation has been successful ---> if errors appear, make sure you followed all steps described in README.piana_requirements ---> if you don't manage to make it work, send an email to ramon.aragues at upf.edu including all error messages, operating System used and your environment variable PYTHONPATH ($> echo $PYTHONPATH) ---> If you encounter problems during the installation, you should read section INSTALLATION on README.troubleshooting Now, all you need to start working with PIANA is a piana database. Read next section... ------------------------------------------ 3. Create and populate your Piana database ------------------------------------------ If you need to create or populate your own database (ie. you don't have access to a PIANA database installed by somebody else), you have to follow instructions on piana/README.populate_piana_db Another possibility is to use the database we offer in our website: pianaDB_limited To learn more about this database read piana/README.pianaDB_limited To read more about the advantages/disadvantages of creating your database from scratch of using the one provided in our website, read piana/README.populate_piana_db This database will become your central repository of data: you'll need to specify it each time you use piana ------------ 4. Use piana ------------ If you have succesfully installed piana and you have a database to work with, you can start using piana. Read piana/README.piana_tutorial for more information on how to use piana. Read piana/README.piana_examples for some detailed examples on how PIANA can be used.