Skip to content

Add the proper copyright symbol to the README.md file. #8329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zbraiterman wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add the proper copyright symbol to the README.md file. #8329

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1b764d
Add the proper copyright symbol to the README.md file.
zbraiterman Feb 5, 2025
571e159
Update README.md
zbraiterman Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -61,21 +62,25 @@ 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
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
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
Expand All @@ -85,14 +90,17 @@ conda install -c beakerx beakerx_all
## Features

### JVM kernels with Interactive Plotting:

<img width="700" alt="screen shot" src="https://user-images.githubusercontent.com/963093/28300136-585f9f7c-6b4b-11e7-8827-b5807d3fc9a8.png">
This feature requires all optional packages.

### Autotranslation from Python to JavaScript and D3

<img width="700" alt="screen shot" src="https://cloud.githubusercontent.com/assets/963093/21077947/261def64-bf2a-11e6-8518-4845caf75690.png">
This feature requires beakerx_kernel_autotranslation package.

### Interactive Tables

<img width="700" alt="screen shot" src="https://user-images.githubusercontent.com/963093/38704584-d1fc16d8-3e74-11e8-95d5-c916bd44d10b.png">
This feature requires beakerx_tabledisplay package.

Expand All @@ -110,29 +118,29 @@ but has been rewritten in Java and refactored and expanded.

The Java support uses Adrian Witas' org.abstractmeta.toolbox.

<a href="http://www.antlr.org/license.html">ANTLR</a> Copyright (c) 2012 Terence Parr and Sam Harwell
<a href="http://www.antlr.org/license.html">ANTLR</a> Copyright :copyright: 2012 Terence Parr and Sam Harwell

<a href="https://github.com/mbostock/d3/blob/master/LICENSE">d3</a> Copyright (c) 2010-2015, Michael Bostock
<a href="https://github.com/mbostock/d3/blob/master/LICENSE">d3</a> Copyright :copyright: 2010-2015, Michael Bostock

<a href="https://github.com/ipython/ipython/blob/master/COPYING.rst">IPython</a> Copyright (c) 2008-2014, IPython Development Team
Copyright (c) 2001-2007, Fernando Perez
Copyright (c) 2001, Janko Hauser
Copyright (c) 2001, Nathaniel Gray
<a href="https://github.com/ipython/ipython/blob/master/COPYING.rst">IPython</a> 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:
<a href="https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/COPYING.rst">IPython-contrib</a> Copyright (c) 2013-2015, IPython-contrib Developers
<a href="https://github.com/ipython-contrib/jupyter_contrib_nbextensions/blob/master/COPYING.rst">IPython-contrib</a> Copyright :copyright: 2013-2015, IPython-contrib Developers

<a href="http://www.scala-lang.org/license.html">Scala</a> Copyright (c) 2002-2015 EPFL
Copyright (c) 2011-2015 Typesafe, Inc.
<a href="http://www.scala-lang.org/license.html">Scala</a> 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.

<a href=" http://www.h2database.com/html/license.html"> H2 database
engine</a>
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
⚡