Skip to content

F# Profile for iPython Notebook 1.x and 2.x

License

Notifications You must be signed in to change notification settings

npmurphy/IfSharp

 
 

Repository files navigation

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: Build status (master/Windows) Build Status (master/Travis)

Compatibility

IfSharp supports Jupyter 4.0, 4.1, 4.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)

  1. Download Anaconda for Python 3.6
  2. 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.

Installation screenshot


  1. Download current zip release of IfSharp v3.0.0-beta2
  2. 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)

  1. Install Anaconda
  2. Install Jupyter
  3. Install Mono (tested Mono 4.2.4 & Mono 5.0.1)
  4. Download current zip release v3.0.0-beta2
  5. Unzip the release then run mono IfSharp.exe
  6. Run jupyter notebook

Manual Installation (Linux)

  1. Install Jupyter via pip or Anaconda etc.
  2. Install Mono (tested 4.2.4) and F# (tested 4.0). (warning: Mono 4.6 does not work due to a networking bug which is addressed in the upcoming Mono 4.8)
  3. Download the current IfSharp zip release v3.0.0-beta1
  4. Unzip the release to a safe place such as ~/opt/ifsharp.
  5. Run mono ~/opt/ifsharp/IfSharp.exe to set up the jupyter config files in ~/.jupyter/ and ~/.local/share/jupyter/kernels/ifsharp/.
  6. (For XPlot) From the install directory ~/opt/ run mono paket.bootstrapper.exe then mono paket.exe install
  7. Run jupyter notebook, the IfSharp kernel should now be one of the supported kernel types.

Screens

Intellisense

Intellisense Example #1


Intellisense Example #2


Intellisense Example #4 #r Directive


Intellisense Example #5 #load Directive


Integrated NuGet

NuGet Example

Inline Error Messages

Inline Error Message

About

F# Profile for iPython Notebook 1.x and 2.x

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Jupyter Notebook 91.5%
  • F# 5.5%
  • JavaScript 2.1%
  • CSS 0.7%
  • C# 0.1%
  • Inno Setup 0.1%