https://github.com/pablofrommars/fsharp-notebook

Data Science Notebook for F# interactive
https://github.com/pablofrommars/fsharp-notebook

data-science data-visualization fsharp vscode-extension

Last synced: 9 days ago
JSON representation

Data Science Notebook for F# interactive

• Host: GitHub
• URL: https://github.com/pablofrommars/fsharp-notebook
• Owner: pablofrommars
• Created: 2020-03-11T17:16:03.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T14:16:56.000Z (almost 2 years ago)
• Last Synced: 2024-07-05T16:59:58.896Z (7 months ago)
• Topics: data-science, data-visualization, fsharp, vscode-extension
• Language: HTML
• Homepage: https://pablofrommars.github.io
• Size: 3.1 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# fsharp-notebook

[fsharp-notebook](https://marketplace.visualstudio.com/items?itemName=PabloBelin.fsharp-notebook) is a lightweight visualization tool to assist during data exploration and prototyping. In combination with [ionide](https://ionide.io), VSCode becomes a very capable F# IDE for data science.

![demo](demo.gif)

## Features

* Register "rich output" printers to FSI

* Render [SVG plots](https://pablofrommars.github.io), HTML fragments, Markdown and text cells

* Export Notebooks to HTML

## Command Palette

* **F# Notebook: Open Panel**

* **F# Notebook: Export Panel**

* **F# Notebook: Clear Panel**

## Settings

* **fsharpnotebook.styles**: A list of CSS style sheets to use in notebooks.

* **fsharpnotebook.exportStyles**: A list of CSS style sheets to use when exporting notebooks.

## Configure [Ionide-fsharp](https://marketplace.visualstudio.com/items?itemName=Ionide.Ionide-fsharp)

Locate where fsharp-notebook extension is installed:

* **Windows** ```%USERPROFILE%\.vscode\extensions\pablobelin.fsharp-notebook-*```

* **macOS** ```~/.vscode/extensions/pablobelin.fsharp-notebook-*```

* **Linux** ```~/.vscode/extensions/pablobelin.fsharp-notebook-*```

And edit VSCode ```settings.json```:

```json

"FSharp.fsiExtraParameters": ["--load:path/to/extension/scripts/Notebook.fsx"]

```

## Usage

### Basic Example

```fsharp

open Notebook

let md = Markdown """

# Hello, Markdown!

"""

```

### Custom printers

```fsharp

fsi.AddPrinter(fun (data : YourType) ->

    ... // Format to string

    |> SVG // or HTML or Markdown or Text

    |> printerNotebook

)

```