Commit c7a0764e authored by Paolo Tosco's avatar Paolo Tosco
Browse files

- updated installation instructions

parent bd9d2049
......@@ -50,17 +50,33 @@ Demonstrates how to create a ribbon tab and group containing various buttons and
Add the Jupyter-based Python Notebook to Flare.
To install, copy the whole `pythonnotebook` directory to your `extensions` directory,
which is in the respective locations on Windows, Linux and macOS:
whose location is platform-specific:
Windows: `%LOCALAPPDATA%\Cresset BMD\Flare\python\extensions`
Linux: `$HOME/.com.cresset-bmd/Flare/python/extensions`
macOS: `$HOME/Library/Application Support/Cresset BMD/Flare/python/extensions`
Make sure that `jupyter` and its dependencies are installed in your `pyflare`
installation:
installation. The location of the `pyflare` binary depends on where Flare was
installed on the different platforms:
Windows:
* `%PROGRAMFILES%\Cresset-BMD\Flare\pyflare.exe` (system-wide install)
* `%LOCALAPPDATA%\Cresset-BMD\Flare\pyflare.exe` (user-level install)
Linux:
* `/opt/cresset/Flare/bin/pyflare` (system-wide RPM install)
* `/your/path/cresset/Flare/bin/pyflare` (user-level TGZ install, `/your/path` is user-determined)
macOS:
* `/Applications/Flare.app/Contents/MacOS/pyflare` (system-wide install)
* `$HOME/Applications/Flare.app/Contents/MacOS/pyflare` (user-level install)
Once you have identified where the `pyflare` binary lives on your system, replace
`/path/to` in the command reported below with the relevant path on your system:
```
pyflare -m pip install jupyter
pyflare -m pip install --user jupyter
```
Please note that currently the Python Notebook extension is not compatible
......
# -*- coding: utf-8 -*-
# Copyright (C) 2018 Cresset Biomolecular Discovery Ltd.
# Copyright (C) 2019 Cresset Biomolecular Discovery Ltd.
# Released under CC-BY-SA 4.0 (https://creativecommons.org/licenses/by-sa/4.0/).
# Originally downloaded from https://gitlab.com/cresset
"""Add the Jupyter-based Python Notebook to Flare.
......@@ -11,8 +11,24 @@ Windows: %LOCALAPPDATA%\Cresset BMD\Flare\python\extensions
Linux: $HOME/.com.cresset-bmd/Flare/python/extensions
macOS: $HOME/Library/Application Support/Cresset BMD/Flare/python/extensions
Make sure that "jupyter" and its dependencies are installed in your "pyflare"
installation:
Make sure that jupyter and its dependencies are installed in your pyflare
installation. The location of the pyflare binary depends on where Flare was
installed on the different platforms:
Windows:
* %PROGRAMFILES%\Cresset-BMD\Flare\pyflare.exe (system-wide install)
* %LOCALAPPDATA%\Cresset-BMD\Flare\pyflare.exe (user-level install)
Linux:
* /opt/cresset/Flare/bin/pyflare (system-wide RPM install)
* /your/path/cresset/Flare/bin/pyflare (user-level TGZ install, /your/path is user-determined)
macOS:
* /Applications/Flare.app/Contents/MacOS/pyflare (system-wide install)
* $HOME/Applications/Flare.app/Contents/MacOS/pyflare (user-level install)
Once you have identified where the pyflare binary lives on your system, replace
/path/to in the command reported below with the relevant path on your system:
pyflare -m pip install jupyter
......@@ -34,7 +50,7 @@ from .common import flare_extension_dir
log = get_logger("FlareJupyter")
# The NotebookPreload.py script is executed before anything else
# This is useful, for example, for thinks that need to be monkey-patched
# This is useful, for example, for things that need to be monkey-patched
# before anything else happens
preload_script_path = os.path.join(flare_extension_dir(), "notebookpreload.py")
preload_script = None
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment