diff --git a/README.md b/README.md index 3598f6e5b0..fdb76ba043 100644 --- a/README.md +++ b/README.md @@ -39,20 +39,21 @@ The [documentation](https://github.com/twosigma/beakerx/blob/master/StartHere.ip consists of tutorial notebooks on GitHub and a [cheatsheet](https://github.com/twosigma/beakerx/blob/master/doc/Cheatsheet.pdf). - BeakerX is the successor to the [Beaker Notebook (source code -archive)](https://github.com/twosigma/beaker-notebook-archive). It +archive)](https://github.com/twosigma/beaker-notebook-archive). It comes from [Two Sigma Open Source](http://opensource.twosigma.com/). Yes we are [hiring](https://www.twosigma.com/careers). ## How to use To install BeakerX and all kernels use: + ``` conda install -c beakerx beakerx_all ``` To install only part of the solution choose which kernels to install: + ``` conda install -c beakerx beakerx_kernel_groovy conda install -c beakerx beakerx_kernel_java @@ -61,7 +62,9 @@ conda install -c beakerx beakerx_kernel_sql conda install -c beakerx beakerx_kernel_clojure conda install -c beakerx beakerx_kernel_kotlin ``` + And then install optional packages: + ``` conda install -c beakerx beakerx_kernel_autotranslation conda install -c beakerx beakerx_tabledisplay @@ -69,6 +72,7 @@ conda install -c beakerx beakerx_widgets ``` To install BeakerX extensions inside Jupyter Lab 1.2 use + ``` // ensure you have yarn, nodejs and npm installed conda install -c conda-forge jupyterlab=1.2 @@ -76,6 +80,7 @@ conda install -c beakerx beakerx_all ``` To install BeakerX extensions inside Jupyter Lab 2.x use + ``` // ensure you have yarn, nodejs and npm installed conda install -c conda-forge jupyterlab=2 @@ -85,14 +90,17 @@ conda install -c beakerx beakerx_all ## Features ### JVM kernels with Interactive Plotting: + screen shot This feature requires all optional packages. ### Autotranslation from Python to JavaScript and D3 + screen shot This feature requires beakerx_kernel_autotranslation package. ### Interactive Tables + screen shot This feature requires beakerx_tabledisplay package. @@ -110,29 +118,29 @@ but has been rewritten in Java and refactored and expanded. The Java support uses Adrian Witas' org.abstractmeta.toolbox. -ANTLR Copyright (c) 2012 Terence Parr and Sam Harwell +ANTLR Copyright :copyright: 2012 Terence Parr and Sam Harwell -d3 Copyright (c) 2010-2015, Michael Bostock +d3 Copyright :copyright: 2010-2015, Michael Bostock -IPython Copyright (c) 2008-2014, IPython Development Team -Copyright (c) 2001-2007, Fernando Perez -Copyright (c) 2001, Janko Hauser -Copyright (c) 2001, Nathaniel Gray +IPython Copyright :copyright: 2008-2014, IPython Development Team +Copyright :copyright: 2001-2007, Fernando Perez +Copyright :copyright: 2001, Janko Hauser +Copyright :copyright: 2001, Nathaniel Gray The table of contents and init cells extensions come from: -IPython-contrib Copyright (c) 2013-2015, IPython-contrib Developers +IPython-contrib Copyright :copyright: 2013-2015, IPython-contrib Developers -Scala Copyright (c) 2002-2015 EPFL - Copyright (c) 2011-2015 Typesafe, Inc. +Scala Copyright :copyright: 2002-2015 EPFL +Copyright :copyright: 2011-2015 Typesafe, Inc. -[Guava](https://github.com/google/guava) Copyright (C) 2012 The Guava Authors +[Guava](https://github.com/google/guava) Copyright :copyright: 2012 The Guava Authors -[Apache Spark](https://github.com/apache/spark) Copyright (C) 2014 and onwards The Apache Software Foundation. +[Apache Spark](https://github.com/apache/spark) Copyright :copyright: 2014 and onwards The Apache Software Foundation. H2 database engine This software contains unmodified binary redistributions for H2 database engine (http://www.h2database.com/), which is dual licensed and available under the MPL 2.0 (Mozilla Public License) or under the -EPL 1.0 (Eclipse Public License). An original copy of the license +EPL 1.0 (Eclipse Public License). An original copy of the license agreement can be found at: http://www.h2database.com/html/license.html