Installation requires a recent ScalaTion distribution (>= 1.3) from
here. Once you have
ScalaTion, make sure the SCALATION_JARS environment variable is
set appropriately before continuing. This can be done individually,
as seen here:
$ export SCALATION_JARS=/path/to/scalation_mathstat.jar
$ export SCALATION_JARS=/path/to/scalation_modeling.jar:$SCALATION_JARS
It can also be done with a single command if you know the path to the
scalation_models directory:
$ export SCALATION_JARS=$(find /path/to/scalation_models/lib | grep .jar | paste -sd ":" -)
If you plan on using the kernel in a
JupyterHub environment, then
you must configure it to recognize the SCALATION_JARS environment variable
by adjusting the c.Spawner.env_keep or c.Spawner.environment options in
jupyterhub_config.py appropriately.
To install Scalation Kernel from PyPI, you can use the following commands:
$ python3 -m pip install -U scalation_kernel
$ python3 -m scalation_kernel.install
After installing ScalaTion Kernel, you may want to test it out with Jupyter. To run Jupyter, you might use the following command:
$ python3 -m jupyter notebook
Use Case: The user wants to rapidly deploy a local Jupyter instance with ScalaTion notebook support.
A quick setup script is provided that creates an independent Python 3 virtual
environment using virtualenv and
installs everything you need to get started with Jupyter, ScalaTion Kernel,
and ScalaTion 1.4. To inspect this script before you run it, see
quick_setup_1.4.sh. To download and run the script, you
have two options, outlined below, depending on whether or not you have Git
installed. These instructions assume you are using one of Linux, MacOS, or
Windows 10 (with
Windows Subsystem for Linux).
Open your terminal and run the following commands to setup and run everything
in a Python 3 virtual environment under a subdirectory called venv-dir (which
the script will create, if needed):
$ git clone https://github.com/scalation/scalation_kernel.git
$ cd scalation_kernel
$ bash quick_setup_1.4.sh venv-dir
The first time the script runs, it may take some time due to downloading dependencies. Subsequent runs should launch Jupyter rather quickly.
If you don't have Git installed, download the
zip or
tar.gz
file and extract it. By default, the directory should be named
scalation_kernel-master. Open your terminal, change into the extracted
directory, and run the following commands to setup and run everything
in a Python 3 virtual environment under a subdirectory called venv-dir (which
the script will create, if needed):
$ bash quick_setup_1.4.sh venv-dir
The first time the script runs, it may take some time due to downloading dependencies. Subsequent runs should launch Jupyter rather quickly.
A Dockerfile
is availble to those with Docker installed.
Instructions on how to build and run the Docker image using the provided Dockerfile can be
found here.
The development version of ScalaTion Kernel is hosted
here on GitHub.
Installation requires a recent ScalaTion distribution (>= 1.3) from
here. Make sure that
the SCALATION_JARS environment variable is set appropriately as
described in General Instructions before
continuing. To install the development version of Scalation Kernel,
you can use the following commands:
$ git clone https://github.com/scalation/scalation_kernel.git
$ python3 -m pip install -U pip
$ python3 -m pip install -e scalation_kernel
$ python3 -m scalation_kernel.install
After installing ScalaTion Kernel, you may want to test it out with Jupyter. To run Jupyter, you might use the following command:
$ python3 -m jupyter notebook
Copyright (c) 2017 Michael E. Cotterell and the University of Georgia. This software is free and open source under an MIT License. The content and opinions expressed on this Web page do not necessarily reflect the views of nor are they endorsed by the University of Georgia or the University System of Georgia.