Skip to content

Getting Started

Ashley Davis edited this page Dec 15, 2023 · 5 revisions

Getting started with Data-Forge Notebook

Thanks for downloading Data-Forge Notebook (DFN). This document will help guide through the process of getting started with it.

You might also want to watch the short getting started video.

If you have any problems that aren't covered in this guide, please email support@data-forge-notebook.com and we'll get you some help ASAP.

Please feel free to make edits to this page and help us improve it.

To understand more about what's included and how it works please see the Overview.

Getting access to DFN

If you don't yet have access to Data-Forge Notebook please download an installer from GitHub.

Installation

Click here for more detailed installation and setup instructions.

Portable

All platforms have a portable version (.tar.gz for Linux and MacOS, .zip for Windows).

The portable version is a zip file that you can unpack to any folder on your system. You can then browse into this folder and double-click to start the application.

Windows

The Windows download is a self-installing executable. Once downloaded, double-click on the file to install it. Once it has finished installing the application will automatically start. Later you can find Data-Forge Notebook in your Start menu.

MacOS

After downloading the dmg file double-click to open the installer window. Then drag the icon into your Applications folder. After installation has completed you can find Data-Forge Notebook in Finder in your Applications folder. Because the application isn't yet digitally signed you must go into your system preferences and give it permission to run.

Linux

Linux doesn't have an installer. PLease use the appropriate portable version for your system.

First startup

On starting DFN you are presented with the welcome screen.

Try out the example notebooks

From the Welcome screen you can open various example notebooks. Start with the Intro notebook. Explore all examples from the File menu Open example notebook or click the example notebooks button on the toolbar.

And/or create your first notebook

Open the File menu and choose New notebook or click the new notebook button in the toolbar. Write some code, e.g console.log("Hello world!");

Evaluate your notebook

Run your code with Evaluate notebook fro the Run menu, clicking the run button in the toolbar or using the hotkey Ctrl/Cmd+Alt+R.

After running the default notebook you'll see output from the code cell displayed in the notebook after the code cell.

Accessing commands

Use the File menu to create, open and save your notebooks.

You can also use the buttons on the toolbar.

Use the button on the toolbar or the hotkey Ctrl/Cmd+Shift+P to open the command palette.

The command palette is a useful way to browse and search for commands and discover their hotkeys.

Getting more help

Need help?

Please read the wiki.

In addition there is a wealth of resources and links in the DFN Help menu.

Have fun!