Integration of d3js with IPython (v1.0) Notebook. Details and examples are available at: http://nbviewer.ipython.org/urls/raw.github.com/z-m-k/ipyD3/master/ipyD3sample.ipynb
Maintained at: https://github.com/z-m-k/ipyD3 (pull requests are welcome).
Integration of d3js with IPython (v1.0) Notebook. Details and examples are available at: http://nbviewer.ipython.org/urls/raw.github.com/z-m-k/ipyD3/master/ipyD3sample.ipynb
Maintained at: https://github.com/z-m-k/ipyD3 (pull requests are welcome).
from __future__ import division | |
from titlecase import titlecase | |
import numpy | |
from uuid import uuid1 | |
class d3object: | |
def __init__(self, | |
height=100, | |
width=100, | |
topHtml='', | |
bottomHtml='', | |
style=None, | |
publish=False, | |
test=False, | |
precision=4, | |
d3=None, | |
phantomExec='phantomjs', | |
keepTempDir='', | |
**kw): | |
self.id='id-{0}'.format(uuid1()) | |
self.phantomExec = phantomExec | |
self.keepTempDir = keepTempDir | |
self.width=width | |
self.html='<div id="{0}" class="d3Output"></div>'.format(self.id) | |
self.css=[] | |
self.varsToPass={'width':width, | |
'height':height, | |
'd3ObjId':self.id, | |
} | |
self.precision=precision | |
self.js=[''' | |
var None=null; | |
var inf='Inf.'; | |
function utfDecode(x){ | |
try{ | |
var r = /[\\\\]{1,2}u([0-9a-fA-F]{4})/gi; | |
var xnew = x.replace(r, function (match, grp) { | |
return String.fromCharCode(parseInt(grp, 16)); | |
}); | |
xnew = unescape(xnew); | |
return xnew; | |
} | |
catch(err){ | |
return x | |
} | |
} | |
''',''] | |
if style in (None, ''): | |
self.html='{0}\n{1}\n{2}'.format(topHtml, self.html, bottomHtml) | |
elif style=='JFFigure': | |
self.html='\n'.join((self.html, | |
'''<div class="d3Output description figure" style="width: {0}px"> | |
<b>Figure{1}.{2}</b>{3}</div> | |
''' | |
.format(width, | |
' '+str(kw['number']) if 'number' in kw else '', | |
' '+titlecase(str(kw['title']))+'.' if 'title' in kw else '', | |
' '+str(kw['desc']) if 'desc' in kw else '', | |
), | |
)) | |
self.addCss(self.getStandardCss('jfCss')) | |
elif style=='JFTable': | |
self.html='\n'.join(('<div class="d3Output header" style="width: {0}px;">Table{1}</div>' | |
.format(width, ' '+str(kw['number']) if 'number' in kw else ''), | |
'<div class="d3Output title" style="width: {0}px;">{1}</div>' | |
.format(width, ' '+titlecase(str(kw['title'])) if 'title' in kw else ''), | |
'<div class="d3Output description" style="width: {0}px">{1}</div>' | |
.format(width, ' '+str(kw['desc']) if 'desc' in kw else ''), | |
self.html, | |
)) | |
self.addCss(self.getStandardCss('jfCss')) | |
elif style=='JFTableFigure': | |
self.html='\n'.join(('<div class="d3Output header" style="width: {0}px;">Figure{1}</div>' | |
.format(width, ' '+str(kw['number']) if 'number' in kw else ''), | |
'<div class="d3Output title" style="width: {0}px;">{1}</div>' | |
.format(width, ' '+titlecase(str(kw['title'])) if 'title' in kw else ''), | |
'<div class="d3Output description" style="width: {0}px">{1}</div>' | |
.format(width, ' '+str(kw['desc']) if 'desc' in kw else ''), | |
self.html, | |
)) | |
self.addCss(self.getStandardCss('jfCss')) | |
if d3!=None: | |
if d3.__class__.__name__=='d3object': | |
if d3.css[0]!='\n'+self.getStandardCss('jfCss') or len(d3.css)>1: | |
self.css=list(set(self.css) | set(d3.css)) | |
d3.addPageBreak() | |
self.html='\n'.join((d3.render(mode=('only','html')),self.html)) | |
else: | |
raise TypeError | |
self.publish=publish | |
if publish: | |
from IPython.display import HTML | |
html='<style>\n{0}\n</style>\n{1}'.format('\n'.join(self.css), self.html) | |
return HTML(html) | |
self.html='' | |
def removeTestObject(self): | |
from IPython.core.display import publish_javascript | |
publish_javascript('''$('#d3TestOutput').remove();''') | |
def convertVar(self, var): | |
typeVar=type(var) | |
if str(var)=='nan': | |
return None | |
elif typeVar==numpy.ndarray: | |
return self.convertVar(var.tolist()) | |
elif typeVar == float or typeVar == numpy.float64: | |
return round(var, self.precision) | |
elif typeVar == list: | |
return [self.convertVar(i) for i in var] | |
elif typeVar == dict: | |
outTemp={} | |
for k in var: | |
outTemp[k]=self.convertVar(var[k]) | |
return outTemp | |
elif typeVar in (str, int) or var==None: | |
return var | |
elif typeVar==long: | |
return int(var) | |
else: | |
print typeVar | |
raise TypeError | |
def addVar(self, **kw): | |
for k in kw: | |
self.varsToPass[k]=self.convertVar(kw[k]) | |
def getJsInputs(self): | |
jsInputs=[] | |
inputs=self.varsToPass | |
for i in inputs: | |
outTemp=i+'=' | |
typeOut=type(inputs[i]) | |
if typeOut == str: | |
outTemp+='"%s"' % inputs[i] | |
elif typeOut in (list, dict, int, float) or inputs[i]==None: | |
outTemp+=str(inputs[i]) | |
else: | |
print typeOut | |
raise TypeError | |
jsInputs.append(outTemp) | |
jsInputs='\n'.join(['var '+i+';' for i in jsInputs]).replace("u'", "'") | |
self.jsInputs=jsInputs | |
def addJs(self, jsStr): | |
if type(jsStr)!=str: | |
raise TypeError | |
self.js.append(jsStr) | |
def addCss(self, css): | |
if type(css)!=str: | |
raise TypeError | |
if type(css)==list: | |
for c in css: | |
self.addCss(c) | |
else: | |
self.css.append('{0}'.format(css)) | |
def pValsStar(self, dataAdd, index=0): | |
if len(dataAdd)==0: | |
return | |
for i in xrange(len(dataAdd[index])): | |
for j in xrange(len(dataAdd[index][0])): | |
if type(dataAdd[index][i][j])==str: continue | |
x=dataAdd[index][i][j] | |
if x<0: dataAdd[index][i][j]='Error' | |
elif x<=0.01: dataAdd[index][i][j]='★★★' | |
elif x<=0.05: dataAdd[index][i][j]='★★' | |
elif x<=0.1: dataAdd[index][i][j]='★' | |
elif x<=1: dataAdd[index][i][j]='' | |
else: dataAdd[index][i][j]='Error' | |
def addPanel(self, title=''): | |
html=u'''<div class="figtags panel description" style="width: {0}px">{1}</div>'''.format(self.width, title).replace('\n','') | |
self.addJs(''' $("#{0}").append('{html}');'''.format(self.id, html=html)) | |
return '-tag-{0}'.format(uuid1()) | |
def getUUID(self, x): | |
return '-{1}-{0}'.format(uuid1(), x) | |
def addTable(self, | |
data=[], | |
dataAdd=[], | |
pVals=False, | |
fontSizeCells=[12,8], | |
fontSizeCellsLabels=[16,10], | |
sRows=None, | |
sColumns=None, | |
sRowsMargins=[5], | |
sColsMargins=[5], | |
varLabels=['Value', 'p-value'], | |
fontSizeHeaders=12, | |
shrinkHeadersBorders=1.5, | |
heatmapIgnoreText=1, | |
heatmap={ | |
'draw':1, | |
'spacing':2, | |
'fillProportion':5, | |
'addText':1, | |
'addTextRows':1, | |
'addBorders':1, | |
'addOutsideBorders':-1, | |
'rectWidth':45, | |
'rectHeight':45, | |
}, | |
smallHeatmap={ | |
'draw':1, | |
'spacing':0, | |
'fillProportion':4, | |
'addText':0, | |
'addTextRows':0, | |
'addBorders':0, | |
'addOutsideBorders':-1, | |
'rectWidth':4, | |
'rectHeight':4, | |
}, | |
heatmapLegendVert=0, | |
legend= { | |
'draw':1, | |
'width':100, | |
'height':15, | |
'rectWidth':60, | |
'rectHeight':60 | |
}, | |
rightPaneOffset=100, | |
colorDomainMin=False, | |
colorDomainMax=False, | |
colorDomainSymmetric=False, | |
colorDomainAuto=1, | |
colorDomainAutoIgnoreColumns=[], | |
colorDomainAutoIgnoreRows=[], | |
colorDomainIgnoreColumns=[], | |
colorDomainIgnoreRows=[], | |
colorRange=['#B9FB8A', '#9BF293', '#7EE79D', '#65DCA6', '#51CFAD', '#43C3B1', '#3FB5B3', | |
'#43A7B2', '#4C99AD', '#568BA6', '#5F7D9C', '#656F8F', '#696181', '#6A5471', | |
'#684861', '#633D51', '#5B3341', '#522A33', '#472226', '#3B1B1A', '#2E1510'], | |
barSize=0.6 | |
): | |
figTag='-tag-{0}'.format(uuid1()) | |
if type(pVals)!=bool: | |
self.pValsStar(dataAdd, pVals) | |
if sRows==None: | |
sRows = ['' for _ in data[0]] | |
if sColumns==None: | |
sColumns = ['' for _ in data] | |
if colorRange != None: | |
colorDomain=[0,1] | |
if colorDomainAuto>0: | |
colorRangeData=data | |
if len(colorDomainAutoIgnoreColumns)+len(colorDomainAutoIgnoreRows)>0: | |
colorRangeData=[] | |
for i in xrange(len(data)): | |
if i in colorDomainAutoIgnoreRows: continue | |
for j in xrange(len(data[0])): | |
if j in colorDomainAutoIgnoreColumns: continue | |
colorRangeData.append(data[i][j]) | |
if colorDomainAuto==2: | |
avgRes=numpy.average(colorRangeData) | |
stdRes=numpy.std(colorRangeData, dtype=numpy.float64, ddof=1) | |
nObs=len(colorRangeData) | |
colorDomain=[max(numpy.min(colorRangeData),avgRes-stdRes/nObs*1.96), | |
min(numpy.max(colorRangeData),avgRes+stdRes/nObs*1.96)] | |
if colorDomainAuto==1: | |
colorDomain=[numpy.min(colorRangeData),numpy.max(colorRangeData)] | |
if colorDomainSymmetric: | |
colorDomain=max(numpy.fabs(colorDomain)) | |
colorDomain=[-colorDomain, colorDomain] | |
colorRange=list(reversed(colorRange))+colorRange[1:] | |
if colorDomainMin: | |
colorDomain=[colorDomainMin, colorDomain[1]] | |
if colorDomainMax: | |
colorDomain=[colorDomain[0], colorDomainMax] | |
colorRangeLen=len(colorRange) | |
colorDomain=(numpy.array([i/colorRangeLen for i in xrange(colorRangeLen+1)])*(colorDomain[1]-colorDomain[0])+colorDomain[0]).tolist() | |
else: | |
colorDomain=[] | |
colorRange=[] | |
self.addVar( figTag=figTag, | |
colorDomain=colorDomain, | |
colorRange=colorRange, | |
data=data, | |
dataAdd=dataAdd, | |
fontSizeCellsLabels=fontSizeCellsLabels, | |
fontSizeCells=fontSizeCells, | |
varLabels=varLabels, | |
sRows=sRows, | |
sColumns=sColumns, | |
heatmapLegendVert=heatmapLegendVert, | |
heatmap=heatmap, | |
smallHeatmap=smallHeatmap, | |
legend=legend, | |
fontSizeHeaders=fontSizeHeaders, | |
heatmapIgnoreText=heatmapIgnoreText, | |
sRowsMargins=sRowsMargins, | |
sColsMargins=sColsMargins, | |
shrinkHeadersBorders=shrinkHeadersBorders, | |
rightPaneOffset=rightPaneOffset, | |
colorDomainIgnoreColumns=colorDomainIgnoreColumns, | |
colorDomainIgnoreRows=colorDomainIgnoreRows, | |
colorDomainMin=colorDomainMin if colorDomainMin else 'false', | |
colorDomainMax=colorDomainMax if colorDomainMax else 'false', | |
barSize=barSize, | |
) | |
self.addCss(''' | |
.heatmapCell path, .heatmapCell line, .heatmapCell polyline, .d3Output polyline { | |
fill: none; | |
stroke-width: 1px; | |
stroke: black; | |
shape-rendering: crispEdges !important; | |
} | |
.heatmapCell text, .heatmapCell rect, .d3Output rect { | |
font-size: 1em; | |
shape-rendering: crispEdges !important; | |
} | |
''') | |
self.addCss('#'+figTag+'{shape-rendering: crispEdges !important;}') | |
self.addJs(''' | |
Array.prototype.sum = function() { | |
return this.reduce(function(a,b){return a+b;}); | |
} | |
var svg = d3.select("#"+d3ObjId) | |
.append("svg") | |
.attr("width", width) | |
.attr("height", height) | |
.style("border-bottom", "1px solid black") | |
var color = d3.scale.linear() | |
.domain(colorDomain) | |
.range(colorRange); | |
function getColor(data){ | |
if(colorDomainMin!='false') | |
if(colorDomainMin>data) | |
return color(colorDomainMin); | |
if(colorDomainMax!='false') | |
if(colorDomainMax<data) | |
return color(colorDomainMax); | |
return color(data); | |
} | |
//_________________________________________________________________________________ | |
// | |
//Heatmap drawing function | |
//_________________________________________________________________________________ | |
function drawHeatmap(data, | |
x, | |
y, | |
spacing, | |
fillProportion, | |
addText, | |
addTextRows, | |
addBorders, | |
addOutsideBorders, | |
rectWidth, | |
rectHeight, | |
svg, | |
objId){ | |
var heatmap=svg.append("svg") | |
.attr("class", "heatmap") | |
.attr("y", y) | |
.attr("x", x) | |
.attr("id", objId) | |
var addLength = dataAdd.length; | |
if(heatmapIgnoreText==1) | |
var cumulHeight=rectHeight-fontSizeCells.sum()-(addLength+1)*2; | |
else | |
var cumulHeight=rectHeight-fillProportion-fontSizeCells.sum()-(addLength+1)*2; | |
var borderOffset=[0,0]; | |
if(addOutsideBorders>=0&&objId=='smallHeatmap') | |
borderOffset=[addOutsideBorders+1,addOutsideBorders+1]; | |
var bars = { | |
'row': 0, | |
'col': 0 | |
} | |
for(var i=0; i<data[0].length; i++){ | |
if(sColumns[0][i]=='|'){ | |
bars.col++; | |
} | |
bars.row=0; | |
for(var j=0; j<data.length; j++){ | |
if(sRows[0][j]=='|'){ | |
bars.row++; | |
continue | |
} | |
if(sColumns[0][i]=='|'){ | |
continue | |
} | |
if(addLength>0){ | |
if(dataAdd[0][j][i]=='Error'){ continue; } | |
if(addLength>1){ | |
if(dataAdd[1][j][i]=='Error'){ continue; } | |
} | |
} | |
var g=heatmap.append("g") | |
.attr("class", "heatmapCell") | |
.attr("transform", "translate("+ (borderOffset[0]+(i)*(rectWidth+spacing)-bars.col*barSize*rectWidth+addTextRows*(sRowsMargins.sum()+5)) +"," | |
+ (borderOffset[1]+(j)*(rectHeight+spacing)-bars.row*barSize*rectHeight+addTextRows*(sColsMargins.sum()+5)) + ")") | |
if(colorDomainIgnoreRows.indexOf(j)==-1 && colorDomainIgnoreColumns.indexOf(i)==-1) | |
g.append("rect") | |
.attr("y", rectHeight-fillProportion) | |
.attr("fill", getColor(data[j][i])) | |
.attr("id", "heatCell") | |
.attr("width", rectWidth) | |
.attr("height", fillProportion) | |
if(addText||addText==1){ | |
g.append("text") | |
.attr("x", rectWidth-5) | |
.attr("y",cumulHeight) | |
.attr("id", "heatText") | |
.attr("dy", fontSizeCells[0]+"px") | |
.style("font-size", fontSizeCells[0]+"px") | |
.attr("text-anchor", "end") | |
.text(data[j][i]); | |
for(var k=0; k<addLength; k++){ | |
g.append("text") | |
.attr("x", rectWidth-5) | |
.attr("y", cumulHeight+fontSizeCells.slice(0,k+1).sum()+(k+1)*2) | |
.attr("dy", fontSizeCells[k+1]+"px") | |
.attr("id", "heatTextAdd") | |
.style("font-size", fontSizeCells[k+1]+"px") | |
.attr("text-anchor", "end") | |
.text(dataAdd[k][j][i]); | |
} | |
} | |
if(addBorders||addBorders==1){ | |
g.append("polyline") | |
.attr("points", "0,0 "+rectWidth+",0 "+rectWidth+","+rectHeight+" 0,"+rectHeight+" 0,0") | |
} | |
} | |
} | |
if(addOutsideBorders>=0){ | |
var box = heatmap.append("rect") | |
.attr("fill", "none") | |
.attr("stroke", "#000") | |
.attr("stroke-widtx", "1px"); | |
if(objId=='heatmap') | |
box.attr("x", sRowsMargins.sum()+5-addOutsideBorders) | |
.attr("y", sColsMargins.sum()+5-addOutsideBorders) | |
.attr("width", data[0].length*(spacing+rectWidth)-spacing+2*addOutsideBorders) | |
.attr("height", data.length*(spacing+rectHeight)-spacing+2*addOutsideBorders); | |
else{ | |
box.attr("x", 1) | |
.attr("y", 1) | |
.attr("width", data[0].length*(spacing+rectWidth)-spacing+2*addOutsideBorders-1) | |
.attr("height", data.length*(spacing+rectHeight)-spacing+2*addOutsideBorders-1); | |
} | |
} | |
if(addTextRows||addTextRows==1){ | |
//Columns | |
for(var k=0; k<sColumns.length; k++){ | |
var z=0; | |
var bars = 0; | |
for(var i=0; i<data[0].length; i++){ | |
if(sColumns[0][i]=='|') bars++; | |
if(sColumns[k][i]==null){ | |
z++; | |
} | |
else if(sColumns[k][i]==''||sColumns[0][i]=='|'){ | |
z=0; | |
} | |
else{ | |
var g=heatmap.append("g") | |
.attr("class", "heatmapCell") | |
.attr("transform", "translate("+ ((i-z)*(rectWidth+spacing)+(sRowsMargins.sum()+5)-bars*barSize*rectWidth) +",0)"); | |
g.append("text") | |
.attr("x", (rectWidth/2)*(z+1)+z*spacing/2) | |
.attr("y", sColsMargins.sum()-sColsMargins.slice(0,k+1).sum()) | |
.style("font-size", fontSizeHeaders+"px") | |
.attr("text-anchor", "middle") | |
.text(sColumns[k][i]); | |
g.append("polyline") | |
.attr("points", ""+ (0+shrinkHeadersBorders) +","+ (sColsMargins.sum()-sColsMargins.slice(0,k+1).sum()+5) +" "+ (rectWidth*(z+1)+z*spacing-shrinkHeadersBorders) +"," +(sColsMargins.sum()-sColsMargins.slice(0,k+1).sum()+5)+""); | |
z=0; | |
} | |
} | |
} | |
//Rows | |
for(var k=0; k<sRows.length; k++){ | |
var z=0; | |
var bars = 0; | |
for(var j=0; j<data.length; j++){ | |
if(sRows[0][j]=='|') bars++; | |
if(sRows[k][j]==null){ | |
z++; | |
} | |
else if(sRows[k][j]==''||sRows[0][j]=='|'){ | |
z=0; | |
} | |
else{ | |
var g=heatmap.append("g") | |
.attr("class", "heatmapCell") | |
.attr("transform", "translate(0,"+ ((j-z)*(rectHeight+spacing)+(sColsMargins.sum()+5)-bars*barSize*rectHeight)+ ")"); | |
g.append("text") | |
.attr("x", sRowsMargins.sum()-sRowsMargins.slice(0,k+1).sum()) | |
.attr("y", 0.5*(rectHeight*(z+1)+(z)*spacing+fontSizeHeaders)) | |
.style("font-size", fontSizeHeaders+"px") | |
.attr("text-anchor", "end") | |
.text(sRows[k][j]); | |
g.append("polyline") | |
.attr("points", ""+ (sRowsMargins.sum()-sRowsMargins.slice(0,k+1).sum()+5) +","+ (0+shrinkHeadersBorders) + " " + (sRowsMargins.sum()-sRowsMargins.slice(0,k+1).sum()+5) +","+ ((z+1)*rectHeight+z*spacing-shrinkHeadersBorders) +""); | |
z=0; | |
} | |
} | |
} | |
} | |
} | |
//_________________________________________________________________________________ | |
// | |
//Legend for a heatmap | |
//_________________________________________________________________________________ | |
function drawLegend(legendSize, x, y, tickValues, colorDomain, color, svg){ | |
var legendcolorRangecale=d3.scale.linear() | |
.domain([0,legendSize[0]]) | |
.range([colorDomain[0], colorDomain[colorDomain.length-1]]), | |
legendObj=svg.append("svg") | |
//.attr("width", legendSize[0]+legendSize[2]) | |
//.attr("height", legendSize[1]+12) | |
.attr("y", y) | |
.attr("x", x) | |
for(var i=0; i<=legendSize[0]; i=i+legendSize[2]){ | |
legendObj.append("rect") | |
.attr("x", i-1) | |
.attr("fill", color(legendcolorRangecale(i))) | |
.attr("width", legendSize[2]) | |
.attr("height", legendSize[1]) | |
.attr("transform", "translate(5,0)") | |
} | |
var legendScale = d3.scale.linear() | |
.domain([colorDomain[0], colorDomain[colorDomain.length-1]]) | |
.range([0,legendSize[0]]); | |
var legendXAxis = d3.svg.axis() | |
.scale(legendScale) | |
.orient("bottom") | |
.tickSize(0,0,0) | |
.tickValues(tickValues) | |
legendObj.append("g") | |
.attr('class', 'axis') | |
.attr("transform", "translate(5," + legendSize[1] + ")") | |
.call(legendXAxis); | |
} | |
function drawLegendVert(legendSize, x, y, tickValues, colorDomain, color, svg){ | |
var legendcolorRangecale=d3.scale.linear() | |
.domain([0,legendSize[0]]) | |
.range([colorDomain[0], colorDomain[colorDomain.length-1]]), | |
legendObj=svg.append("svg") | |
//.attr("width", legendSize[0]+legendSize[2]) | |
//.attr("height", legendSize[1]+12) | |
.attr("y", y) | |
.attr("x", x) | |
.attr("id", "vertLegend") | |
if(heatmapLegendVert==1) | |
legendObj.style("opacity", 0.01) | |
for(var i=0; i<=legendSize[0]; i=i+legendSize[2]){ | |
legendObj.append("rect") | |
.attr("y", i-1) | |
.attr("fill", color(legendcolorRangecale(i))) | |
.attr("width", legendSize[1]) | |
.attr("height", legendSize[2]) | |
.attr("transform", "translate(5,0)") | |
} | |
var legendScale = d3.scale.linear() | |
.domain([colorDomain[0], colorDomain[colorDomain.length-1]]) | |
.range([5,legendSize[0]-5]); | |
var legendXAxis = d3.svg.axis() | |
.scale(legendScale) | |
.orient("right") | |
.tickSize(0,0,0) | |
.ticks(5) | |
legendObj.append("g") | |
.attr('class', 'axis') | |
.attr("transform", "translate("+(legendSize[1]*1.5)+"," + (0*legendSize[1]) + ")") | |
.call(legendXAxis); | |
} | |
function drawLegendBox(x, y, rectWidth, rectHeight, svg){ | |
var legendObj=svg.append("svg") | |
//.attr("width", legendSize[0]+legendSize[2]) | |
//.attr("height", legendSize[1]+12) | |
.attr("y", y-rectHeight) | |
.attr("x", x) | |
var addLength = dataAdd.length; | |
var cumulHeight=fontSizeCellsLabels.sum()+addLength*2; | |
var g=legendObj.append("g") | |
.attr("class", "heatmapCell") | |
g.append("rect") | |
.attr("x", 1) | |
.attr("y", rectHeight-heatmap.fillProportion/heatmap.rectHeight*rectHeight) | |
.attr("fill", colorRange[0]) | |
.attr("width", rectWidth-1) | |
.attr("height", heatmap.fillProportion/heatmap.rectHeight*rectHeight) | |
g.append("text") | |
.attr("x", rectWidth-5) | |
.attr("y", rectHeight-cumulHeight-5-heatmap.fillProportion) | |
.attr("dy", fontSizeCellsLabels[0]+"px") | |
.style("font-size", fontSizeCellsLabels[0]+"px") | |
.attr("text-anchor", "end") | |
.text(varLabels[0]); | |
for(var k=0; k<addLength; k++){ | |
g.append("text") | |
.attr("x", rectWidth-5) | |
.attr("y", rectHeight-5-heatmap.fillProportion-cumulHeight+fontSizeCellsLabels.slice(0,k+1).sum()+(k+1)*2) | |
.attr("dy", fontSizeCellsLabels[k+1]+"px") | |
.style("font-size", fontSizeCellsLabels[k+1]+"px") | |
.attr("text-anchor", "end") | |
.text(varLabels[k+1]); | |
} | |
g.append("polyline") | |
.attr("points", "1,1 "+ (rectWidth-1) +",1 "+ (rectWidth-1) +","+rectHeight+" 1,"+rectHeight+" 1,1") | |
} | |
var regressionResults=svg.append("g").attr('id', 'svgElement'+d3ObjId+figTag) | |
if(heatmap.draw==1){ | |
drawHeatmap(data/*data*/, | |
0/*x*/, | |
0/*y*/, | |
heatmap.spacing/*spacing*/, | |
heatmap.fillProportion/*fillProportion*/, | |
heatmap.addText/*addText*/, | |
heatmap.addTextRows/*addTextRows*/, | |
heatmap.addBorders/*addBorders*/, | |
heatmap.addOutsideBorders/*addOutsideBorders*/, | |
heatmap.rectWidth/*rectWidth*/, | |
heatmap.rectHeight/*rectHeight*/, | |
regressionResults,/*svg parent*/ | |
'heatmap'/*id*/) | |
} | |
var legendX=Math.round(sRowsMargins.slice(0,sRowsMargins.length-1).sum()/2+data[0].length*(heatmap.rectWidth+heatmap.spacing)+5+rightPaneOffset); | |
if(smallHeatmap.draw==1){ | |
drawHeatmap(data/*data*/, | |
legendX/*x*/, | |
Math.round(heatmap.addTextRows*(sColsMargins.sum()))/*y*/, | |
smallHeatmap.spacing/*spacing*/, | |
smallHeatmap.fillProportion/*fillProportion*/, | |
smallHeatmap.addText/*addText*/, | |
smallHeatmap.addTextRows/*addTextRows*/, | |
smallHeatmap.addBorders/*addBorders*/, | |
smallHeatmap.addOutsideBorders/*addOutsideBorders*/, | |
smallHeatmap.rectWidth/*rectWidth*/, | |
smallHeatmap.rectHeight/*rectHeight*/, | |
regressionResults,/*svg parent*/ | |
'smallHeatmap'/*id*/) | |
} | |
if(legend.draw==1){ | |
if(smallHeatmap.draw==1){ | |
drawLegend( [data[0].length*(smallHeatmap.rectWidth+smallHeatmap.spacing)-smallHeatmap.spacing-smallHeatmap.rectWidth,legend.height,1] /*legendSize*/, | |
Math.round(smallHeatmap.rectWidth/2+legendX-5+ Math.max(0,smallHeatmap.addOutsideBorders ))/*x*/, | |
Math.round((data.length)*(smallHeatmap.rectHeight+smallHeatmap.spacing)+sColsMargins.sum()+legend.height+5+2*Math.max(0,smallHeatmap.addOutsideBorders))/*y*/, | |
[colorDomain[1], colorDomain[colorDomain.length-2]]/*tickValues*/, | |
colorDomain/*colorDomain*/, | |
color/*color*/, | |
regressionResults/*svg*/); | |
} | |
drawLegendBox(legendX, | |
Math.round((data.length)*(heatmap.rectHeight+heatmap.spacing)+heatmap.spacing+1+sColsMargins.sum()), | |
Math.max(legend.rectWidth, data[0].length*(smallHeatmap.rectWidth+smallHeatmap.spacing)-smallHeatmap.spacing+Math.max(0,2*smallHeatmap.addOutsideBorders)), | |
legend.rectHeight, | |
regressionResults) | |
} | |
if(heatmapLegendVert==1||heatmapLegendVert==2) | |
drawLegendVert( [data.length*(heatmap.rectHeight+heatmap.spacing),legend.height,1] /*legendSize*/, | |
sRowsMargins.slice(0,sRowsMargins.length ).sum()+data[0].length*(heatmap.rectWidth+heatmap.spacing)+25/*x*/, | |
sColsMargins.sum()+5/*y*/, | |
[colorDomain[1], colorDomain[colorDomain.length-2]]/*tickValues*/, | |
colorDomain/*colorDomain*/, | |
color/*color*/, | |
regressionResults/*svg*/); | |
var boundingRect=document.getElementById('svgElement'+d3ObjId+figTag).getBoundingClientRect(); | |
var boundingRectParent=$(document.getElementById('svgElement'+d3ObjId+figTag)).parent()[0].getBoundingClientRect(); | |
regressionResults.attr("transform", "translate("+ ((width-boundingRect.width)/2-boundingRectParent.left) +","+ ((height-boundingRect.height)/2+boundingRectParent.top-boundingRect.top) + ")") | |
''') | |
def getPhantomJsScript(self, mode, renderTime=1000): | |
if 'html' in mode: | |
phantomJs=''' | |
var page = require('webpage').create(), | |
system = require('system'), | |
address, elementHtml; | |
address = system.args[1]; | |
page.viewportSize = { width: 600, height: 600 }; | |
page.open(address, function (status) { | |
if (status !== 'success') { | |
console.log('Unable to load the address!'); | |
} else { | |
window.setTimeout(function () { | |
elementHtml=page.evaluate(function() { | |
document.body.bgColor = 'white'; | |
return document.getElementById("d3OutputOutterContainer").innerHTML; | |
}); | |
console.log(elementHtml); | |
phantom.exit(1); | |
}, %s); | |
} | |
}); | |
''' % (renderTime) | |
elif 'png' in mode: | |
phantomJs=''' | |
var page = require('webpage').create(), | |
system = require('system'), | |
address, elementHtml; | |
address = system.args[1]; | |
page.viewportSize = { width: 1, height: 1 }; | |
page.open(address, function (status) { | |
if (status !== 'success') { | |
console.log('Unable to load the address!'); | |
} else { | |
window.setTimeout(function () { | |
console.log(page.renderBase64('PNG')); | |
phantom.exit(1); | |
}, %s); | |
} | |
}); | |
''' % (renderTime) | |
return phantomJs | |
def render(self, mode=['html'], fileName=None, renderTime=1000): | |
if type(mode) not in (list, tuple): | |
mode=(mode,) | |
self.getJsInputs() | |
html=['<style>', | |
'\n'.join(self.css), | |
'</style>', | |
'</head>', | |
'<body>', | |
'<div id="d3OutputOutterContainer">', | |
self.html, | |
'</div>', | |
'<script>', | |
self.js[0], | |
self.jsInputs,] + self.js[1:] + ['</script>' | |
] | |
if self.publish: | |
html='\n'.join(html) | |
from IPython.display import HTML | |
return HTML(html) | |
import tempfile | |
from os import unlink | |
import subprocess | |
from time import sleep | |
html=['<html>', | |
'<head>', | |
'<title></title>', | |
'<script src="http://code.jquery.com/jquery-1.8.3.min.js"></script>', | |
'<script src="http://d3js.org/d3.v3.min.js"></script>',] +\ | |
html +\ | |
['</body>', | |
'</html>',] | |
html='\n'.join(html) | |
if 'keepTemp' not in mode: | |
tempJs=tempfile.NamedTemporaryFile(mode="w+b", delete=False, suffix='.js') | |
temp=tempfile.NamedTemporaryFile(mode="w+b", delete=False, suffix='.htm') | |
else: | |
tempJs=open(self.keepTempDir+'//ipyD3_temp.js', "wb") | |
temp=open(self.keepTempDir+'//ipyD3_temp.htm', "wb") | |
tempJs.write(self.getPhantomJsScript(mode, renderTime)) | |
temp.write(html) | |
if 'keepTemp' not in mode: | |
temp.flush() | |
tempJs.flush() | |
tempJs.close() | |
temp.close() | |
phantomJsArgs = (self.phantomExec, tempJs.name, temp.name) | |
else: | |
tempJs.close() | |
temp.close() | |
phantomJsArgs = (self.phantomExec, self.keepTempDir+'//ipyD3_temp.js', self.keepTempDir+'//ipyD3_temp.htm') | |
phantomJsProc = subprocess.Popen( phantomJsArgs, stdout = subprocess.PIPE, stderr = subprocess.PIPE) | |
html = '' | |
err = '' | |
while phantomJsProc.poll() is None: | |
sleep( 0.1 ) | |
html, err = phantomJsProc.communicate() | |
if 'keepTemp' not in mode: | |
unlink(temp.name) | |
unlink(tempJs.name) | |
if 'html' in mode: | |
html=html.replace("&", "&").replace("use href=", "use xlink:href=") | |
if 'only' in mode: | |
return html | |
if 'file'in mode and fileName!=None: | |
html=['<html>', | |
'<head>', | |
'</head>', | |
'<style>', | |
'\n'.join(self.css), | |
'</style>', | |
html, | |
'</body>', | |
'</html>',] | |
fileOpen=open(fileName,'wb') | |
fileOpen.write('\n'.join(html)) | |
fileOpen.close() | |
return True | |
html='\n'.join(['<style>','\n'.join(self.css),'</style>'])+html | |
if 'show'in mode: | |
from IPython.display import HTML | |
return HTML(html) | |
return html | |
elif 'png' in mode: | |
if 'only' in mode: | |
return html | |
if 'file'in mode and fileName!=None: | |
fileOpen=open(fileName,'wb') | |
fileOpen.write(html) | |
fileOpen.close() | |
return True | |
if 'show'in mode: | |
from IPython.display import Image | |
return Image(data=html) | |
return html | |
def addSimpleTable(self, | |
data, | |
dataAdd=[], | |
pVals=False, | |
fontSizeCells=[], | |
sRows=[], | |
sColumns=[], | |
sRowsMargins=[5,100], | |
sColsMargins=[5,20], | |
fontSizeHeaders=9, | |
shrinkHeadersBorders=1.5, | |
spacing=0, | |
addBorders=1, | |
addOutsideBorders=-1, | |
rectWidth=45, | |
rectHeight=0, | |
barSize=0.6, | |
colorRange=None, | |
varLabels=[], | |
): | |
if len(fontSizeCells)==0: | |
fontSizeCells=[12]*(1+len(dataAdd)) | |
self.addTable(data=data, | |
dataAdd=dataAdd, | |
pVals=pVals, | |
fontSizeCells=fontSizeCells+[5], | |
fontSizeCellsLabels=fontSizeCells+[5], | |
sRows=sRows, | |
sColumns=sColumns, | |
sRowsMargins=sRowsMargins, | |
sColsMargins=sColsMargins, | |
varLabels=varLabels, | |
fontSizeHeaders=fontSizeHeaders, | |
shrinkHeadersBorders=shrinkHeadersBorders, | |
heatmapIgnoreText=1, | |
heatmap={ | |
'draw':1, | |
'spacing':spacing, | |
'fillProportion':0, | |
'addText':1, | |
'addTextRows':1, | |
'addBorders':addBorders, | |
'addOutsideBorders':addOutsideBorders, | |
'rectWidth':rectWidth, | |
'rectHeight':rectHeight if rectHeight>0 else int(sum(fontSizeCells)+10+2*len(dataAdd)), | |
}, | |
smallHeatmap={ | |
'draw':0, | |
'spacing':0, | |
'fillProportion':4, | |
'addText':0, | |
'addTextRows':0, | |
'addBorders':0, | |
'addOutsideBorders':-1, | |
'rectWidth':4, | |
'rectHeight':4, | |
}, | |
legend= { | |
'draw':min(len(varLabels),1), | |
'rectWidth': rectWidth, | |
'rectHeight':rectHeight if rectHeight>0 else int(sum(fontSizeCells)+10+2*len(dataAdd)), | |
}, | |
rightPaneOffset=min(len(varLabels),1)*120, | |
colorRange=colorRange, | |
barSize=barSize | |
) | |
def addPageBreak(self): | |
self.addJs('''$("#"+d3ObjId).append('<div style="page-break-after:always; display:block; width:1px; height:1px;"> </div>')''') | |
def getStandardCss(self, mode='jfCss'): | |
if mode=='jfCss': | |
return''' | |
body{ | |
font-family: "Lucinda Grande", "Lucinda Sans Unicode", Helvetica, Arial, Verdana, sans-serif; | |
} | |
.d3Output{ | |
min-height: 1.2em; | |
line-height: 1.2em; | |
position: relative; | |
font-size: 1em; | |
padding: 5px 0; | |
list-style: none; | |
background: #fff; | |
color: #000; | |
} | |
svg{ | |
color-rendering: optimizeQuality !important; | |
shape-rendering: geometricPrecision !important; | |
text-rendering: geometricPrecision !important; | |
} | |
.d3Output.header{ | |
text-align: center; | |
font-weight: bold; | |
border-bottom: none; | |
font-size: 0.9em; | |
} | |
.d3Output.title{ | |
text-align: center; | |
font-weight: bold; | |
border-bottom: none; | |
font-size: 1.2em; | |
} | |
.d3Output .description, .d3Output.description{ | |
font-size: 0.8em; | |
text-align:justify; | |
text-justify:inter-word; | |
border-bottom: 1px solid #000; | |
} | |
.d3Output .panel{ | |
text-align: center !important; | |
page-break-after:avoid; | |
} | |
svg, canvas { | |
border-bottom: 1px solid #000; | |
display: block; | |
margin: 5px 0; | |
} | |
.d3Output.description.figure{ | |
border-bottom: none; | |
} | |
''' |
GNU GENERAL PUBLIC LICENSE | |
Version 3, 29 June 2007 | |
Copyright (C) 2007 Free Software Foundation, Inc. {http://fsf.org/} | |
Everyone is permitted to copy and distribute verbatim copies | |
of this license document, but changing it is not allowed. | |
Preamble | |
The GNU General Public License is a free, copyleft license for | |
software and other kinds of works. | |
The licenses for most software and other practical works are designed | |
to take away your freedom to share and change the works. By contrast, | |
the GNU General Public License is intended to guarantee your freedom to | |
share and change all versions of a program--to make sure it remains free | |
software for all its users. We, the Free Software Foundation, use the | |
GNU General Public License for most of our software; it applies also to | |
any other work released this way by its authors. You can apply it to | |
your programs, too. | |
When we speak of free software, we are referring to freedom, not | |
price. Our General Public Licenses are designed to make sure that you | |
have the freedom to distribute copies of free software (and charge for | |
them if you wish), that you receive source code or can get it if you | |
want it, that you can change the software or use pieces of it in new | |
free programs, and that you know you can do these things. | |
To protect your rights, we need to prevent others from denying you | |
these rights or asking you to surrender the rights. Therefore, you have | |
certain responsibilities if you distribute copies of the software, or if | |
you modify it: responsibilities to respect the freedom of others. | |
For example, if you distribute copies of such a program, whether | |
gratis or for a fee, you must pass on to the recipients the same | |
freedoms that you received. You must make sure that they, too, receive | |
or can get the source code. And you must show them these terms so they | |
know their rights. | |
Developers that use the GNU GPL protect your rights with two steps: | |
(1) assert copyright on the software, and (2) offer you this License | |
giving you legal permission to copy, distribute and/or modify it. | |
For the developers' and authors' protection, the GPL clearly explains | |
that there is no warranty for this free software. For both users' and | |
authors' sake, the GPL requires that modified versions be marked as | |
changed, so that their problems will not be attributed erroneously to | |
authors of previous versions. | |
Some devices are designed to deny users access to install or run | |
modified versions of the software inside them, although the manufacturer | |
can do so. This is fundamentally incompatible with the aim of | |
protecting users' freedom to change the software. The systematic | |
pattern of such abuse occurs in the area of products for individuals to | |
use, which is precisely where it is most unacceptable. Therefore, we | |
have designed this version of the GPL to prohibit the practice for those | |
products. If such problems arise substantially in other domains, we | |
stand ready to extend this provision to those domains in future versions | |
of the GPL, as needed to protect the freedom of users. | |
Finally, every program is threatened constantly by software patents. | |
States should not allow patents to restrict development and use of | |
software on general-purpose computers, but in those that do, we wish to | |
avoid the special danger that patents applied to a free program could | |
make it effectively proprietary. To prevent this, the GPL assures that | |
patents cannot be used to render the program non-free. | |
The precise terms and conditions for copying, distribution and | |
modification follow. | |
TERMS AND CONDITIONS | |
0. Definitions. | |
"This License" refers to version 3 of the GNU General Public License. | |
"Copyright" also means copyright-like laws that apply to other kinds of | |
works, such as semiconductor masks. | |
"The Program" refers to any copyrightable work licensed under this | |
License. Each licensee is addressed as "you". "Licensees" and | |
"recipients" may be individuals or organizations. | |
To "modify" a work means to copy from or adapt all or part of the work | |
in a fashion requiring copyright permission, other than the making of an | |
exact copy. The resulting work is called a "modified version" of the | |
earlier work or a work "based on" the earlier work. | |
A "covered work" means either the unmodified Program or a work based | |
on the Program. | |
To "propagate" a work means to do anything with it that, without | |
permission, would make you directly or secondarily liable for | |
infringement under applicable copyright law, except executing it on a | |
computer or modifying a private copy. Propagation includes copying, | |
distribution (with or without modification), making available to the | |
public, and in some countries other activities as well. | |
To "convey" a work means any kind of propagation that enables other | |
parties to make or receive copies. Mere interaction with a user through | |
a computer network, with no transfer of a copy, is not conveying. | |
An interactive user interface displays "Appropriate Legal Notices" | |
to the extent that it includes a convenient and prominently visible | |
feature that (1) displays an appropriate copyright notice, and (2) | |
tells the user that there is no warranty for the work (except to the | |
extent that warranties are provided), that licensees may convey the | |
work under this License, and how to view a copy of this License. If | |
the interface presents a list of user commands or options, such as a | |
menu, a prominent item in the list meets this criterion. | |
1. Source Code. | |
The "source code" for a work means the preferred form of the work | |
for making modifications to it. "Object code" means any non-source | |
form of a work. | |
A "Standard Interface" means an interface that either is an official | |
standard defined by a recognized standards body, or, in the case of | |
interfaces specified for a particular programming language, one that | |
is widely used among developers working in that language. | |
The "System Libraries" of an executable work include anything, other | |
than the work as a whole, that (a) is included in the normal form of | |
packaging a Major Component, but which is not part of that Major | |
Component, and (b) serves only to enable use of the work with that | |
Major Component, or to implement a Standard Interface for which an | |
implementation is available to the public in source code form. A | |
"Major Component", in this context, means a major essential component | |
(kernel, window system, and so on) of the specific operating system | |
(if any) on which the executable work runs, or a compiler used to | |
produce the work, or an object code interpreter used to run it. | |
The "Corresponding Source" for a work in object code form means all | |
the source code needed to generate, install, and (for an executable | |
work) run the object code and to modify the work, including scripts to | |
control those activities. However, it does not include the work's | |
System Libraries, or general-purpose tools or generally available free | |
programs which are used unmodified in performing those activities but | |
which are not part of the work. For example, Corresponding Source | |
includes interface definition files associated with source files for | |
the work, and the source code for shared libraries and dynamically | |
linked subprograms that the work is specifically designed to require, | |
such as by intimate data communication or control flow between those | |
subprograms and other parts of the work. | |
The Corresponding Source need not include anything that users | |
can regenerate automatically from other parts of the Corresponding | |
Source. | |
The Corresponding Source for a work in source code form is that | |
same work. | |
2. Basic Permissions. | |
All rights granted under this License are granted for the term of | |
copyright on the Program, and are irrevocable provided the stated | |
conditions are met. This License explicitly affirms your unlimited | |
permission to run the unmodified Program. The output from running a | |
covered work is covered by this License only if the output, given its | |
content, constitutes a covered work. This License acknowledges your | |
rights of fair use or other equivalent, as provided by copyright law. | |
You may make, run and propagate covered works that you do not | |
convey, without conditions so long as your license otherwise remains | |
in force. You may convey covered works to others for the sole purpose | |
of having them make modifications exclusively for you, or provide you | |
with facilities for running those works, provided that you comply with | |
the terms of this License in conveying all material for which you do | |
not control copyright. Those thus making or running the covered works | |
for you must do so exclusively on your behalf, under your direction | |
and control, on terms that prohibit them from making any copies of | |
your copyrighted material outside their relationship with you. | |
Conveying under any other circumstances is permitted solely under | |
the conditions stated below. Sublicensing is not allowed; section 10 | |
makes it unnecessary. | |
3. Protecting Users' Legal Rights From Anti-Circumvention Law. | |
No covered work shall be deemed part of an effective technological | |
measure under any applicable law fulfilling obligations under article | |
11 of the WIPO copyright treaty adopted on 20 December 1996, or | |
similar laws prohibiting or restricting circumvention of such | |
measures. | |
When you convey a covered work, you waive any legal power to forbid | |
circumvention of technological measures to the extent such circumvention | |
is effected by exercising rights under this License with respect to | |
the covered work, and you disclaim any intention to limit operation or | |
modification of the work as a means of enforcing, against the work's | |
users, your or third parties' legal rights to forbid circumvention of | |
technological measures. | |
4. Conveying Verbatim Copies. | |
You may convey verbatim copies of the Program's source code as you | |
receive it, in any medium, provided that you conspicuously and | |
appropriately publish on each copy an appropriate copyright notice; | |
keep intact all notices stating that this License and any | |
non-permissive terms added in accord with section 7 apply to the code; | |
keep intact all notices of the absence of any warranty; and give all | |
recipients a copy of this License along with the Program. | |
You may charge any price or no price for each copy that you convey, | |
and you may offer support or warranty protection for a fee. | |
5. Conveying Modified Source Versions. | |
You may convey a work based on the Program, or the modifications to | |
produce it from the Program, in the form of source code under the | |
terms of section 4, provided that you also meet all of these conditions: | |
a) The work must carry prominent notices stating that you modified | |
it, and giving a relevant date. | |
b) The work must carry prominent notices stating that it is | |
released under this License and any conditions added under section | |
7. This requirement modifies the requirement in section 4 to | |
"keep intact all notices". | |
c) You must license the entire work, as a whole, under this | |
License to anyone who comes into possession of a copy. This | |
License will therefore apply, along with any applicable section 7 | |
additional terms, to the whole of the work, and all its parts, | |
regardless of how they are packaged. This License gives no | |
permission to license the work in any other way, but it does not | |
invalidate such permission if you have separately received it. | |
d) If the work has interactive user interfaces, each must display | |
Appropriate Legal Notices; however, if the Program has interactive | |
interfaces that do not display Appropriate Legal Notices, your | |
work need not make them do so. | |
A compilation of a covered work with other separate and independent | |
works, which are not by their nature extensions of the covered work, | |
and which are not combined with it such as to form a larger program, | |
in or on a volume of a storage or distribution medium, is called an | |
"aggregate" if the compilation and its resulting copyright are not | |
used to limit the access or legal rights of the compilation's users | |
beyond what the individual works permit. Inclusion of a covered work | |
in an aggregate does not cause this License to apply to the other | |
parts of the aggregate. | |
6. Conveying Non-Source Forms. | |
You may convey a covered work in object code form under the terms | |
of sections 4 and 5, provided that you also convey the | |
machine-readable Corresponding Source under the terms of this License, | |
in one of these ways: | |
a) Convey the object code in, or embodied in, a physical product | |
(including a physical distribution medium), accompanied by the | |
Corresponding Source fixed on a durable physical medium | |
customarily used for software interchange. | |
b) Convey the object code in, or embodied in, a physical product | |
(including a physical distribution medium), accompanied by a | |
written offer, valid for at least three years and valid for as | |
long as you offer spare parts or customer support for that product | |
model, to give anyone who possesses the object code either (1) a | |
copy of the Corresponding Source for all the software in the | |
product that is covered by this License, on a durable physical | |
medium customarily used for software interchange, for a price no | |
more than your reasonable cost of physically performing this | |
conveying of source, or (2) access to copy the | |
Corresponding Source from a network server at no charge. | |
c) Convey individual copies of the object code with a copy of the | |
written offer to provide the Corresponding Source. This | |
alternative is allowed only occasionally and noncommercially, and | |
only if you received the object code with such an offer, in accord | |
with subsection 6b. | |
d) Convey the object code by offering access from a designated | |
place (gratis or for a charge), and offer equivalent access to the | |
Corresponding Source in the same way through the same place at no | |
further charge. You need not require recipients to copy the | |
Corresponding Source along with the object code. If the place to | |
copy the object code is a network server, the Corresponding Source | |
may be on a different server (operated by you or a third party) | |
that supports equivalent copying facilities, provided you maintain | |
clear directions next to the object code saying where to find the | |
Corresponding Source. Regardless of what server hosts the | |
Corresponding Source, you remain obligated to ensure that it is | |
available for as long as needed to satisfy these requirements. | |
e) Convey the object code using peer-to-peer transmission, provided | |
you inform other peers where the object code and Corresponding | |
Source of the work are being offered to the general public at no | |
charge under subsection 6d. | |
A separable portion of the object code, whose source code is excluded | |
from the Corresponding Source as a System Library, need not be | |
included in conveying the object code work. | |
A "User Product" is either (1) a "consumer product", which means any | |
tangible personal property which is normally used for personal, family, | |
or household purposes, or (2) anything designed or sold for incorporation | |
into a dwelling. In determining whether a product is a consumer product, | |
doubtful cases shall be resolved in favor of coverage. For a particular | |
product received by a particular user, "normally used" refers to a | |
typical or common use of that class of product, regardless of the status | |
of the particular user or of the way in which the particular user | |
actually uses, or expects or is expected to use, the product. A product | |
is a consumer product regardless of whether the product has substantial | |
commercial, industrial or non-consumer uses, unless such uses represent | |
the only significant mode of use of the product. | |
"Installation Information" for a User Product means any methods, | |
procedures, authorization keys, or other information required to install | |
and execute modified versions of a covered work in that User Product from | |
a modified version of its Corresponding Source. The information must | |
suffice to ensure that the continued functioning of the modified object | |
code is in no case prevented or interfered with solely because | |
modification has been made. | |
If you convey an object code work under this section in, or with, or | |
specifically for use in, a User Product, and the conveying occurs as | |
part of a transaction in which the right of possession and use of the | |
User Product is transferred to the recipient in perpetuity or for a | |
fixed term (regardless of how the transaction is characterized), the | |
Corresponding Source conveyed under this section must be accompanied | |
by the Installation Information. But this requirement does not apply | |
if neither you nor any third party retains the ability to install | |
modified object code on the User Product (for example, the work has | |
been installed in ROM). | |
The requirement to provide Installation Information does not include a | |
requirement to continue to provide support service, warranty, or updates | |
for a work that has been modified or installed by the recipient, or for | |
the User Product in which it has been modified or installed. Access to a | |
network may be denied when the modification itself materially and | |
adversely affects the operation of the network or violates the rules and | |
protocols for communication across the network. | |
Corresponding Source conveyed, and Installation Information provided, | |
in accord with this section must be in a format that is publicly | |
documented (and with an implementation available to the public in | |
source code form), and must require no special password or key for | |
unpacking, reading or copying. | |
7. Additional Terms. | |
"Additional permissions" are terms that supplement the terms of this | |
License by making exceptions from one or more of its conditions. | |
Additional permissions that are applicable to the entire Program shall | |
be treated as though they were included in this License, to the extent | |
that they are valid under applicable law. If additional permissions | |
apply only to part of the Program, that part may be used separately | |
under those permissions, but the entire Program remains governed by | |
this License without regard to the additional permissions. | |
When you convey a copy of a covered work, you may at your option | |
remove any additional permissions from that copy, or from any part of | |
it. (Additional permissions may be written to require their own | |
removal in certain cases when you modify the work.) You may place | |
additional permissions on material, added by you to a covered work, | |
for which you have or can give appropriate copyright permission. | |
Notwithstanding any other provision of this License, for material you | |
add to a covered work, you may (if authorized by the copyright holders of | |
that material) supplement the terms of this License with terms: | |
a) Disclaiming warranty or limiting liability differently from the | |
terms of sections 15 and 16 of this License; or | |
b) Requiring preservation of specified reasonable legal notices or | |
author attributions in that material or in the Appropriate Legal | |
Notices displayed by works containing it; or | |
c) Prohibiting misrepresentation of the origin of that material, or | |
requiring that modified versions of such material be marked in | |
reasonable ways as different from the original version; or | |
d) Limiting the use for publicity purposes of names of licensors or | |
authors of the material; or | |
e) Declining to grant rights under trademark law for use of some | |
trade names, trademarks, or service marks; or | |
f) Requiring indemnification of licensors and authors of that | |
material by anyone who conveys the material (or modified versions of | |
it) with contractual assumptions of liability to the recipient, for | |
any liability that these contractual assumptions directly impose on | |
those licensors and authors. | |
All other non-permissive additional terms are considered "further | |
restrictions" within the meaning of section 10. If the Program as you | |
received it, or any part of it, contains a notice stating that it is | |
governed by this License along with a term that is a further | |
restriction, you may remove that term. If a license document contains | |
a further restriction but permits relicensing or conveying under this | |
License, you may add to a covered work material governed by the terms | |
of that license document, provided that the further restriction does | |
not survive such relicensing or conveying. | |
If you add terms to a covered work in accord with this section, you | |
must place, in the relevant source files, a statement of the | |
additional terms that apply to those files, or a notice indicating | |
where to find the applicable terms. | |
Additional terms, permissive or non-permissive, may be stated in the | |
form of a separately written license, or stated as exceptions; | |
the above requirements apply either way. | |
8. Termination. | |
You may not propagate or modify a covered work except as expressly | |
provided under this License. Any attempt otherwise to propagate or | |
modify it is void, and will automatically terminate your rights under | |
this License (including any patent licenses granted under the third | |
paragraph of section 11). | |
However, if you cease all violation of this License, then your | |
license from a particular copyright holder is reinstated (a) | |
provisionally, unless and until the copyright holder explicitly and | |
finally terminates your license, and (b) permanently, if the copyright | |
holder fails to notify you of the violation by some reasonable means | |
prior to 60 days after the cessation. | |
Moreover, your license from a particular copyright holder is | |
reinstated permanently if the copyright holder notifies you of the | |
violation by some reasonable means, this is the first time you have | |
received notice of violation of this License (for any work) from that | |
copyright holder, and you cure the violation prior to 30 days after | |
your receipt of the notice. | |
Termination of your rights under this section does not terminate the | |
licenses of parties who have received copies or rights from you under | |
this License. If your rights have been terminated and not permanently | |
reinstated, you do not qualify to receive new licenses for the same | |
material under section 10. | |
9. Acceptance Not Required for Having Copies. | |
You are not required to accept this License in order to receive or | |
run a copy of the Program. Ancillary propagation of a covered work | |
occurring solely as a consequence of using peer-to-peer transmission | |
to receive a copy likewise does not require acceptance. However, | |
nothing other than this License grants you permission to propagate or | |
modify any covered work. These actions infringe copyright if you do | |
not accept this License. Therefore, by modifying or propagating a | |
covered work, you indicate your acceptance of this License to do so. | |
10. Automatic Licensing of Downstream Recipients. | |
Each time you convey a covered work, the recipient automatically | |
receives a license from the original licensors, to run, modify and | |
propagate that work, subject to this License. You are not responsible | |
for enforcing compliance by third parties with this License. | |
An "entity transaction" is a transaction transferring control of an | |
organization, or substantially all assets of one, or subdividing an | |
organization, or merging organizations. If propagation of a covered | |
work results from an entity transaction, each party to that | |
transaction who receives a copy of the work also receives whatever | |
licenses to the work the party's predecessor in interest had or could | |
give under the previous paragraph, plus a right to possession of the | |
Corresponding Source of the work from the predecessor in interest, if | |
the predecessor has it or can get it with reasonable efforts. | |
You may not impose any further restrictions on the exercise of the | |
rights granted or affirmed under this License. For example, you may | |
not impose a license fee, royalty, or other charge for exercise of | |
rights granted under this License, and you may not initiate litigation | |
(including a cross-claim or counterclaim in a lawsuit) alleging that | |
any patent claim is infringed by making, using, selling, offering for | |
sale, or importing the Program or any portion of it. | |
11. Patents. | |
A "contributor" is a copyright holder who authorizes use under this | |
License of the Program or a work on which the Program is based. The | |
work thus licensed is called the contributor's "contributor version". | |
A contributor's "essential patent claims" are all patent claims | |
owned or controlled by the contributor, whether already acquired or | |
hereafter acquired, that would be infringed by some manner, permitted | |
by this License, of making, using, or selling its contributor version, | |
but do not include claims that would be infringed only as a | |
consequence of further modification of the contributor version. For | |
purposes of this definition, "control" includes the right to grant | |
patent sublicenses in a manner consistent with the requirements of | |
this License. | |
Each contributor grants you a non-exclusive, worldwide, royalty-free | |
patent license under the contributor's essential patent claims, to | |
make, use, sell, offer for sale, import and otherwise run, modify and | |
propagate the contents of its contributor version. | |
In the following three paragraphs, a "patent license" is any express | |
agreement or commitment, however denominated, not to enforce a patent | |
(such as an express permission to practice a patent or covenant not to | |
sue for patent infringement). To "grant" such a patent license to a | |
party means to make such an agreement or commitment not to enforce a | |
patent against the party. | |
If you convey a covered work, knowingly relying on a patent license, | |
and the Corresponding Source of the work is not available for anyone | |
to copy, free of charge and under the terms of this License, through a | |
publicly available network server or other readily accessible means, | |
then you must either (1) cause the Corresponding Source to be so | |
available, or (2) arrange to deprive yourself of the benefit of the | |
patent license for this particular work, or (3) arrange, in a manner | |
consistent with the requirements of this License, to extend the patent | |
license to downstream recipients. "Knowingly relying" means you have | |
actual knowledge that, but for the patent license, your conveying the | |
covered work in a country, or your recipient's use of the covered work | |
in a country, would infringe one or more identifiable patents in that | |
country that you have reason to believe are valid. | |
If, pursuant to or in connection with a single transaction or | |
arrangement, you convey, or propagate by procuring conveyance of, a | |
covered work, and grant a patent license to some of the parties | |
receiving the covered work authorizing them to use, propagate, modify | |
or convey a specific copy of the covered work, then the patent license | |
you grant is automatically extended to all recipients of the covered | |
work and works based on it. | |
A patent license is "discriminatory" if it does not include within | |
the scope of its coverage, prohibits the exercise of, or is | |
conditioned on the non-exercise of one or more of the rights that are | |
specifically granted under this License. You may not convey a covered | |
work if you are a party to an arrangement with a third party that is | |
in the business of distributing software, under which you make payment | |
to the third party based on the extent of your activity of conveying | |
the work, and under which the third party grants, to any of the | |
parties who would receive the covered work from you, a discriminatory | |
patent license (a) in connection with copies of the covered work | |
conveyed by you (or copies made from those copies), or (b) primarily | |
for and in connection with specific products or compilations that | |
contain the covered work, unless you entered into that arrangement, | |
or that patent license was granted, prior to 28 March 2007. | |
Nothing in this License shall be construed as excluding or limiting | |
any implied license or other defenses to infringement that may | |
otherwise be available to you under applicable patent law. | |
12. No Surrender of Others' Freedom. | |
If conditions are imposed on you (whether by court order, agreement or | |
otherwise) that contradict the conditions of this License, they do not | |
excuse you from the conditions of this License. If you cannot convey a | |
covered work so as to satisfy simultaneously your obligations under this | |
License and any other pertinent obligations, then as a consequence you may | |
not convey it at all. For example, if you agree to terms that obligate you | |
to collect a royalty for further conveying from those to whom you convey | |
the Program, the only way you could satisfy both those terms and this | |
License would be to refrain entirely from conveying the Program. | |
13. Use with the GNU Affero General Public License. | |
Notwithstanding any other provision of this License, you have | |
permission to link or combine any covered work with a work licensed | |
under version 3 of the GNU Affero General Public License into a single | |
combined work, and to convey the resulting work. The terms of this | |
License will continue to apply to the part which is the covered work, | |
but the special requirements of the GNU Affero General Public License, | |
section 13, concerning interaction through a network will apply to the | |
combination as such. | |
14. Revised Versions of this License. | |
The Free Software Foundation may publish revised and/or new versions of | |
the GNU General Public License from time to time. Such new versions will | |
be similar in spirit to the present version, but may differ in detail to | |
address new problems or concerns. | |
Each version is given a distinguishing version number. If the | |
Program specifies that a certain numbered version of the GNU General | |
Public License "or any later version" applies to it, you have the | |
option of following the terms and conditions either of that numbered | |
version or of any later version published by the Free Software | |
Foundation. If the Program does not specify a version number of the | |
GNU General Public License, you may choose any version ever published | |
by the Free Software Foundation. | |
If the Program specifies that a proxy can decide which future | |
versions of the GNU General Public License can be used, that proxy's | |
public statement of acceptance of a version permanently authorizes you | |
to choose that version for the Program. | |
Later license versions may give you additional or different | |
permissions. However, no additional obligations are imposed on any | |
author or copyright holder as a result of your choosing to follow a | |
later version. | |
15. Disclaimer of Warranty. | |
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY | |
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT | |
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY | |
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, | |
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | |
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM | |
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF | |
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. | |
16. Limitation of Liability. | |
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | |
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS | |
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY | |
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE | |
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF | |
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD | |
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), | |
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF | |
SUCH DAMAGES. | |
17. Interpretation of Sections 15 and 16. | |
If the disclaimer of warranty and limitation of liability provided | |
above cannot be given local legal effect according to their terms, | |
reviewing courts shall apply local law that most closely approximates | |
an absolute waiver of all civil liability in connection with the | |
Program, unless a warranty or assumption of liability accompanies a | |
copy of the Program in return for a fee. | |
END OF TERMS AND CONDITIONS | |
How to Apply These Terms to Your New Programs | |
If you develop a new program, and you want it to be of the greatest | |
possible use to the public, the best way to achieve this is to make it | |
free software which everyone can redistribute and change under these terms. | |
To do so, attach the following notices to the program. It is safest | |
to attach them to the start of each source file to most effectively | |
state the exclusion of warranty; and each file should have at least | |
the "copyright" line and a pointer to where the full notice is found. | |
{one line to give the program's name and a brief idea of what it does.} | |
Copyright (C) {year} {name of author} | |
This program is free software: you can redistribute it and/or modify | |
it under the terms of the GNU General Public License as published by | |
the Free Software Foundation, either version 3 of the License, or | |
(at your option) any later version. | |
This program is distributed in the hope that it will be useful, | |
but WITHOUT ANY WARRANTY; without even the implied warranty of | |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
GNU General Public License for more details. | |
You should have received a copy of the GNU General Public License | |
along with this program. If not, see {http://www.gnu.org/licenses/}. | |
Also add information on how to contact you by electronic and paper mail. | |
If the program does terminal interaction, make it output a short | |
notice like this when it starts in an interactive mode: | |
ipyD3 Copyright (C) 2013 z-m-k | |
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. | |
This is free software, and you are welcome to redistribute it | |
under certain conditions; type `show c' for details. | |
The hypothetical commands `show w' and `show c' should show the appropriate | |
parts of the General Public License. Of course, your program's commands | |
might be different; for a GUI interface, you would use an "about box". | |
You should also get your employer (if you work as a programmer) or school, | |
if any, to sign a "copyright disclaimer" for the program, if necessary. | |
For more information on this, and how to apply and follow the GNU GPL, see | |
{http://www.gnu.org/licenses/}. | |
The GNU General Public License does not permit incorporating your program | |
into proprietary programs. If your program is a subroutine library, you | |
may consider it more useful to permit linking proprietary applications with | |
the library. If this is what you want to do, use the GNU Lesser General | |
Public License instead of this License. But first, please read | |
{http://www.gnu.org/philosophy/why-not-lgpl.html}. |