https://github.com/kyori19/satysfi-notebook

https://github.com/kyori19/satysfi-notebook

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kyori19/satysfi-notebook
• Owner: kyori19
• License: mit
• Created: 2024-01-21T07:28:10.000Z (12 months ago)
• Default Branch: experimental
• Last Pushed: 2024-06-17T20:27:19.000Z (7 months ago)
• Last Synced: 2024-06-18T22:02:47.586Z (7 months ago)
• Language: Dockerfile
• Size: 262 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SATySFi Notebook

## Usage

### On Binder

> [!WARNING]

>

> Any changes made on Binder will not be persisted.

> You should try other options below if you want to write something.

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/kyori19/satysfi-notebook/binder?urlpath=lab)

### On VSCode or GitHub Codespaces

Create `.devcontainer.json` with following content and start/recreate DevContainer:

```json

{

  "image": "ghcr.io/kyori19/devcontainers/images/satysfi-notebook",

  "customizations": {

    "vscode": {

      "extensions": [

        "ms-toolsai.jupyter"

      ]

    }

  }

}

```

Opening any `.ipynb` file will automatically starts SATySFi Notebook environment.

### On JupyterLab

You have to create DevContainer once using VSCode (or DevContainer CLI).

In the container, run:

```sh

sudo apt update

sudo apt install python3-pip

sudo pip3 install jupyterlab satysfi_notebook_tweaks --break-system-packages

```

Then you can run `jupyter lab` or open GitHub Codespaces using JupyterLab.