IfSharp, Jupyter and F# Azure Notebooks
This is the F# implementation for Jupyter. View the Feature Notebook for some of the features that are included.
You can use Jupyter F# Notebooks for free (with free server-side execution) at Azure Notebooks. If you select "Show me some samples", then there is an "Introduction to F#" which guides you through the language and its use in Jupyter.
Build status: (master/Windows)
(master/Travis)
Compatibility
IfSharp supports Jupyter 4.0-5.2 and works with both Python 2.X and Python 3.X
If you need IPython 1.x or 2.x support please see the archived https://github.com/fsprojects/IfSharp/tree/ipython-archive
Automatic Installation
Previous releases for the IPython notebook are here: release repository. Automatic installs for Jupyter will be provided in the future.
Running inside a Docker container
There is a Docker file for running the F# kernel v. 3.0.0-alpha in a container. Build the container with:
docker build -t ifsharp:3.0.0-alpha .
Run it with:
docker run -d -v your_local_notebooks_dir:/notebooks -p your_port:8888 ifsharp:3.0.0-alpha
The container exposes a volume called notebooks
where the files get saved. On Linux, connect to the notebook on http://localhost:your_port
and, on Windows, use http://your_docker_machine:your_port
.
Manual Installation (Windows)
- Download Anaconda for Python 3.6
- Launch Anaconda3-4.4.0-Windows-x86_64.exe (or x-86.exe for 32-bit) Click through the installation wizard, choosing the given install location. At the 'advanced installation options' screen shown below, select "Add Anaconda to my PATH environment variable". The installer warns against this step, as it can clash with previously installed software, however it's essential in running IfSharp. Now install.
This should also install Jupyter: you may check this by entering 'jupyter notebook' into the Anaconda console window. If Jupyter does not launch (it should launch in the browser), install using 'pip install jupyter', or by following Jupyter instructions.
- Download current zip release of IfSharp v3.0.0-beta3
- Run IfSharp.exe (IfSharp application icon).
Jupyter with IfSharp can be run via "jupyter notebook" in future
Troubleshooting
If the launch fails in the console window, check that the Anaconda version used is currently added to the path. If not, uninstalling Anaconda and reinstalling using instructions 1-
Manual Installation (Mac)
- Install Jupyter via pip or Anaconda etc.
- Install Mono (tested Mono 5.2.0.224)
- Download current IfSharp zip release v3.0.0-beta3
- Unzip the release then run
mono ifsharp.exe
- Run
jupyter notebook
, the IfSharp kernel should now be one of the supported kernel types.
Manual Installation (Linux)
- Install Jupyter via pip or Anaconda etc.
- Install Mono (Tested mono 5.2) and F# (tested 4.1).
- Download the current IfSharp zip release v3.0.0-beta3
- Unzip the release then run
mono ifsharp.exe
(this sets up the Jupyter kernel files in~/.local/share/jupyter/kernels/ifsharp/
) - Run
jupyter notebook
, the IfSharp kernel should now be one of the supported kernel types.
Manual Installation (Linux - HDInsights)
- Follow instructions to install or update Mono on HDInsights.
- SSH into the HDInsights cluster.
- Download the current Ifsharp zip release v3.0.0-beta3 with the following commands:
# create ifsharp folder under /tmp
mkdir ifsharp
cd ifsharp
wget https://github.com/fsprojects/IfSharp/releases/download/v3.0.0-beta3/IfSharp.v3.0.0-beta3.zip
unzip IfSharp.v3.0.0-beta3.zip
chmod +x ifsharp.exe
-
From the Azure portal, open your cluster. See List and show clusters for the instructions. The cluster is opened in a new portal blade.
-
From the Quick links section, click Cluster dashboards to open the Cluster dashboards blade. If you don't see Quick Links, click Overview from the left menu on the blade.
-
Click Jupyter Notebook. If prompted, enter the admin credentials for the cluster.
[!NOTE] You may also reach the Jupyter notebook on Spark cluster by opening the following URL in your browser. Replace CLUSTERNAME with the name of your cluster:
https://CLUSTERNAME.azurehdinsight.net/jupyter
-
Click New, and then click Terminal.
-
In the terminal window
cd
into the/tmp/ifsharp/
folder and using mono, run the installer:
cd /tmp/ifsharp
mono IfSharp.exe
- Back on the Jupyter homepage, click New and you will now see the IFsharp kernel installed.