Refinery

Refinery contains scripts, artifacts, and configuration for WMF's analytics cluster.

Setting up the refinery repository

1. Install git-fat from https://github.com/jedbrown/git-fat on your system.

2. Make sure the docopt and dateutil Python packages are available on your system.

   On Ubuntu systems, you can achiev this by running

   sudo apt-get install python-docopt
   sudo apt-get install python-dateutil
   

3. Clone the repository.

   You can find the commands to clone the repository at WMF's gerrit.

   To clone anonymously, just run

   git clone https://gerrit.wikimedia.org/r/analytics/refinery
   

4. change to the cloned repository by running

   cd refinery
   

5. Initialize git-fat by running

   git fat init
   

6. Pull existing artifacts into the repository by running

   git fat pull
   

   (Depending on you internet connection, this step may take some time.)

7. Add the refinery/python directory to your PYTHONPATH.

   To add it only in the running shell, you can use

   export PYTHONPATH=/path/to/analytics/refinery/python
   

   Please refer to your operating system's documentation on how to do this globally.

8. Done.