Port of nbdev to write SCALA / chisel library entirely in notebooks
Project description
chisel-nbdev
The goal of this repo is to provide a seamless way to develop Chisel code in a Jupyter Notebook environment.
Requirements (mac)
- setup some virtualenv (im using python3.8.2)
pip install virtualenv
- find your python3 binary:
which python3
which for me is/usr/local/bin/python3
- create virtualenv:
python3 -m virtualenv --python=/usr/local/bin/python3 chisel_nb_env
- activate it:
source chisel_nb_env/bin/activate
- install jupyterlab (which includes jupyter notebook):
pip install jupyterlab
## Requirements (mac) - setup some virtualenv (im using python3.8.2)
pip install virtualenv
- find your python3 binary:
which python3
which for me is/usr/local/bin/python3
- create virtualenv:
python3 -m virtualenv --python=/usr/local/bin/python3 chisel_nb_env
- activate it:
source chisel_nb_env/bin/activate
- install jupyterlab (which includes jupyter notebook):
pip install jupyterlab
Setup the Jupyter Scala kernel Almond (https://almond.sh)
- Borrowed from the Chisel-Bootcamp install guide: https://github.com/freechipsproject/chisel-bootcamp/blob/master/Install.md
- If you experience errors or issues with this section, try running rm -rf ~/.local/share/jupyter/kernels/scala/ first.
- Next, download coursier (our dependency manager) and use it to install almond (our kernel wrapped around Ammonite) (see here for the source for these instructions):
curl -L -o coursier https://git.io/coursier-cli && chmod +x coursier
SCALA_VERSION=2.12.10 ALMOND_VERSION=0.9.1
./coursier bootstrap -r jitpack \
-i user -I user:sh.almond:scala-kernel-api_$SCALA_VERSION:$ALMOND_VERSION \
sh.almond:scala-kernel_$SCALA_VERSION:$ALMOND_VERSION \
--sources --default=true \
-o almond
./almond --install
- You can delete coursier and almond files if you so desire.
Start JupyterLab
- Making sure you are in your virtualenv then run:
jupyter lab
Project Structure
- By default, notebook source files (.ipynb) will live in the
nbs
folder. - Upon running
notebook2script()
the notebooks innbs
will export code to.sc
files in thenbdev
folder. These are auto-generated files that can be imported back into notebooks via Ammonite: For exampleimport $file.MyMod, MyMod._
imports the contents of the fileMyMod.sc
.
Testing Notebooks
- Currently can run
nbdev_test_nbs('MyMod.ipynb')
to run all of the tests contained in theMyMod.ipynb
notebook. - Tests are identified by either omitting any export flags (
//export
) or by including special flags defined insettings.ini
(i.e//slowtest
orchiseltest
).
settings.ini
- Configurations belong in this file.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
chisel_nbdev-0.1.tar.gz
(33.9 kB
view hashes)
Built Distribution
chisel_nbdev-0.1-py3-none-any.whl
(36.4 kB
view hashes)
Close
Hashes for chisel_nbdev-0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffa1e11816f68585637d69487612c9d2bce7900ac509fee682a32f648f2da3a0 |
|
MD5 | 3c35538790fb54f95f9406d41d4b0d3c |
|
BLAKE2b-256 | 51ceb7145d030010b293f0bfeb1c8fbe3da32a423718d1d53d0db6f716ae689e |