Much nicer, more up-to-date docs

INSTALL.md

-
-In order to install the minimal analytics-experiments repository:
-
-First, decide on your directories:
-* VIRTUALENV_DIR = directory where you create your python virtualenv.
-* BASE_DIR = directory you start in before cloning the analytics repo. (so something like /home/bob)
-* ANALYTICS_DIR = directory where the analytics-experiments repo is cloned. (so something like /home/bob/analytics-experiments/)
-
-Then, start to install:
-* cd BASE_DIR
-* git clone git@github.com:MITx/analytics-experiments.git
-* cd analytics-experiments (this is the ANALYTICS_DIR)
-* sudo xargs -a apt-packages.txt apt-get install
-* sudo aptitude remove python-virtualenv python-pip
-* sudo easy_install pip virtualenv
-* pip install virtualenv
-* mkdir VIRTUALENV_DIR
-* virtualenv VIRTUALENV_DIR
-* source VIRTUALENV_DIR/bin/activate
-* cd ANALYTICS_DIR
-* pip install -r requirements.txt
-* mkdir BASE_DIR/db
-* cd ANALYTICS_DIR/anserv
-* Ensure that IMPORT_MITX_MODULES in settings.py is False .
-* python manage.py syncdb --database=default --settings=settings (this may fail, but that is fine)
-* python manage.py syncdb --database=local --settings=settings
-* mkdir ANALYTICS_DIR/staticfiles
-* python manage.py collectstatic --settings=settings --noinput -c --pythonpath=.
-
-Then, run the server:
-* python manage.py runserver 127.0.0.1:9022 --settings=settings --pythonpath=. --nostatic
-* Navigate to 127.0.0.1:9022 in your browser, and you should see a login screen.
-
-Then, create a user:
-* cd ANALYTICS_DIR/anserv
-* python manage.py shell --settings=settings
-* from django.contrib.auth.models import User (run in the shell)
-* user = User.objects.create_user("test","test@test.com","test") (run in the shell)
-
-If you are using the aws settings (ie deploying):
-
-* MITX_DIR = directory where you clone MITX
-
-* cd ANALYTICS_DIR/anserv
-* source VIRTUALENV_DIR/bin/activate
-* python manage.py createcachetable django_cache --database=local
-* cd BASE_DIR
-* git clone git@github.com:MITx/mitx.git
-* cd MITX_DIR
-* sudo xargs -a apt-packages.txt apt-get install
-* pip install -r pre-requirements.txt
-
-
-
+Note: These instructions may be obsolete. 
+
+To install a development setup: 
+
+    apt-get install python-pip python-matplotlib python-scipy emacs mongodb apache2-utils python-mysqldb subversion ipython nginx git redis-server
+    git clone https://github.com/MITx/djanalytics
+    cd djanalytics
+    pip install -r requirements.txt    
+    cd src/djanalytics/
+    python manage.py syncdb
+    python manage.py migrate
+    python manage.py runserver localhost:9022
+
+To install a setup to build from: 
+
+    apt-get install python-pip python-matplotlib python-scipy emacs mongodb apache2-utils python-mysqldb subversion ipython nginx git redis-server
+    git clone https://github.com/MITx/djanalytics
+    cd djanalytics
+    pip install -r requirements.txt    
+    sudo python setup.py install

docs/system_structure.ps

 %!PS-Adobe-3.0 EPSF-3.0
-%%Title: system_structure.png
-%%Creator: XCircuit v3.6 rev135
-%%CreationDate: Fri Mar  8 12:53:33 2013
+%%Title: system_structure.ps
+%%Creator: XCircuit v3.7 rev26
+%%CreationDate: Fri Apr 12 08:49:37 2013
 %%Pages: 1
-%%BoundingBox: 68 68 632 432
+%%BoundingBox: 68 68 632 460
 %%DocumentNeededResources: font Helvetica Times-Roman 
 %%EndComments
 %%BeginProlog
 %
 %  PostScript prolog for output from xcircuit
-%  Version: 3.3
+%  Version: 3.7
 %
 %  Electrical circuit (and otherwise general) drawing program
 %
-%  Written by Tim Edwards 8/5/93--7/13/05  (tim.edwards@multigig.com)
+%  Written by Tim Edwards 8/5/93--11/1/10  (tim.edwards@multigig.com)
 %  The Johns Hopkins University (1993-2004)
 %  MultiGiG, Inc. (2004-present)
 %
-%%BeginResource: procset XCIRCproc 3.3 0
+%%BeginResource: procset XCIRCproc 3.7 2
 %
 % supporting definitions --- these are the primary xcircuit types.
 
@@ -85,25 +85,28 @@
 	translate /showflag 1 def /Bline 0 def /Tabs 0 array def /fscale
 	1.0 def /kY 0 def {dup type /stringtype eq {mshow} {dup type
 	/arraytype eq {exec} {12 string cvs mshow} ifelse} ifelse} repeat
-	grestore } def
+	grestore endclip} def
 /pinlabel { 4 index 32 and 0 ne hlevel 0 eq or { /pspc 10 def label
 	/pspc 0 def } { pop pop pop pop pop {pop} repeat } ifelse } def
 /pinglobal { pinlabel } def
 /infolabel { pinlabel } def
-/graphic { gsave 4 index cvx exec /DataSource get resetfile translate
-	0 0 moveto neg rotate dup scale cvx exec image grestore } def
+/graphic { gsave 4 index cvx exec /DataSource get resetfile translate 0 0
+	moveto neg rotate dup scale cvx exec image grestore endclip} def
 
 /scb { setrgbcolor } bind def  /sce { defColor aload pop scb } bind def
 /cRedef {/defColor currentcolor 3 array astore def} def
 /begingate {dup type /dicttype ne {1 dict} if begin	% default params
 	dup type /dicttype ne {1 dict} if begin		% instanced params
-	/hlevel hlevel 1 add def /defColor currentcolor sce 3 array
-	astore def gsave sce translate 0 0 moveto neg rotate dup abs scale
-	} bind def
+	/hlevel hlevel 1 add def /defColor currentcolor sce 3 array astore
+	def gsave sce translate 0 0 moveto neg rotate dup type /nametype
+	eq not { dup abs currentlinewidth exch div setlinewidth } { pop }
+	ifelse dup abs scale clipped 1 and 1 eq {/clipped clipped 1 add def}
+	if} bind def
 /endgate { /hlevel hlevel 1 sub def grestore defColor aload pop cRedef
-	scb end end} bind def
+	scb end end endclip} bind def
 
 /hlevel 0 def
+/endclip {clipped 1 and 1 eq {grestore /clipped clipped 1 sub def} if} def
 /tmpa [1 0 0 1 0 0] def
 /gar {8 8 true tmpa {<c0 c0 00 00 0c 0c 00 00>} imagemask} bind
 {8 8 true tmpa {<30 70 60 02 03 07 06 20>} imagemask} bind
@@ -118,7 +121,8 @@
   { 3 index exch 5 exch put dup -8 3 index { 3 index
   exch 4 exch put 3 index exec } for } for pop pop pop pop grestore } bind def
 /setstyles {
-  currentlinewidth mul setlinewidth /style exch def
+  currentlinewidth mul setlinewidth /style exch def style 2048 and 0 gt
+  clipped 1 and 0 eq and {clip newpath /clipped clipped 1 add def} {
   style 1 and 0 gt not {closepath} if
   style 1024 and 0 gt {2 setlinecap} if
   style 2 and 0 gt {currentlinewidth 4 mul dup 2 array astore 0 setdash} if
@@ -128,8 +132,18 @@
   {3 copy mul add 4 1 roll pop} forall pop pop setrgbcolor eofill}
   {dup 7 lt {gar exch get ppaint} {pop eofill} ifelse} ifelse}
   {style 256 and 0 gt {1 setgray eofill} if} ifelse grestore style 8 and 0 gt 
-  style 512 eq or {newpath} {stroke} ifelse grestore} def     
+  style 512 eq or {newpath} {stroke} ifelse grestore endclip} ifelse} def     
 
+/addtoy {exch dup dup 2 mul 3 add 1 roll -1 1 { 4 1 roll dup 4 1 roll add
+	4 -1 roll 2 mul 1 add index 2 mul 2 add 2 roll} for pop} def
+/addtoy1 {1 exch addtoy pop} def
+/addtoy3 {3 exch addtoy pop} def
+/addtoy4 {4 exch addtoy pop} def
+/addtox {exch dup dup 2 mul 3 add 1 roll -1 1 { 4 1 roll dup 4 1 roll 3 -1 roll
+	add exch 4 -1 roll 2 mul 1 add index 2 mul 2 add 2 roll} for pop} def
+/addtox1 {1 exch addtox pop} def
+/addtox3 {3 exch addtox pop} def
+/addtox4 {4 exch addtox pop} def
 /polygon { gsave /num exch def moveto num 1 sub {lineto} repeat setstyles } def
 /xcarc   { gsave newpath arc setstyles } def
 /elb { matrix currentmatrix 7 -1 roll 7 -1 roll translate 5 1 roll 4 -1 roll
@@ -142,7 +156,8 @@
 /polyc   { {lineto} repeat } bind def
 /beginpath { gsave moveto } bind def
 /endpath { setstyles } bind def
-/bop	 { 1 setlinecap 0 setlinejoin 6 setmiterlimit 0 0 0 scb cRedef } def
+/bop	 { 1 setlinecap 0 setlinejoin 6 setmiterlimit 0 0 0 scb cRedef
+	/clipped 0 def} def
 /psinsertion {/PSobj save def /showpage {} def /setpagedevice {pop} def bop
 	rotate translate dup scale} def
 /end_insert {PSobj restore} def
@@ -189,11 +204,11 @@ endgate
 
 %%EndSetup
 
-%%Page: 1 1
+%%Page: system_structure 1
 %%PageOrientation: Portrait
 /pgsave save def bop
 1.0000 inchscale
-2.6000 setlinewidth 1212 -36 translate
+2.6000 setlinewidth 1212 38 translate
 
 1 1.000 -832 1168 -832 976 2 polygon
 1 1.000 -704 1168 -704 976 2 polygon
@@ -347,6 +362,19 @@ endgate
 0 1.000 144 736 144 672 -144 672 -144 736 4 polygon
 0 1.000 144 832 144 768 -144 768 -144 832 4 polygon
 0 1.000 144 928 144 864 -144 864 -144 928 4 polygon
+1 1.000 -592 528 -640 528 2 polygon
+1 1.000 -592 432 -640 432 2 polygon
+1 1.000 -592 336 -640 336 2 polygon
+1 1.000 -656 528 -560 528 2 polygon
+1 1.000 -656 432 -560 432 2 polygon
+1 1.000 -656 336 -560 336 2 polygon
+1.000 180 -640 192 generic::arrowhead
+(Log files) {/Helvetica cf} 2 16 0 1.000 -704 160 label
+1 1.000 -640 528 -640 208 2 polygon
+1.000 180 -608 192 generic::arrowhead
+1.000 180 -576 192 generic::arrowhead
+1 1.000 -608 208 -608 432 2 polygon
+1 1.000 -576 208 -576 336 2 polygon
 pgsave restore showpage
 
 %%Trailer