SoS extension for papermill
Project description
Papermill engine for SoS Notebook
papermill is a tool for parameterizing, executing, and analyzing Jupyter Notebooks. It lets you parameterize and execute notebooks in batch mode.
SoS Notebook is a Jupyter kernel that allows the use of multiple kernels in one Jupyter notebook. Using language modules that understand datatypes of underlying languages (modules sos-bash, sos-r, sos-matlab, etc), SoS Notebook allows data exchange among live kernels of supported languages. SoS Notebook is also a frontend to the SoS Workflow that allows the development and execution of workflows from Jupyter notebooks.
Because the default papermill executor assumes a single kernel for the entire notebook, sos-papermill
is provided as a customized engine for the execution of SoS notebooks.
Installation
pip install sos-papermill
or
conda install sos-papermill -c conda-forge
if you are using a conda environment.
Note that you will need to install sos-notebook
, all relevant kernels (e.g. bash_kernel
, irkernel
) and related language modules (e.g. sos-bash, sos-r) to execute notebooks that use these kernels. Please refer to Running SoS for details on how to install SoS Notebook.
Documentation
sos-papermill
provides sos
engine for papermill. All you need to do is to add option --engine sos
to any papermill command that you might use:
papermill --engine sos [other options]
For example, to execute a parametrized notebook with parameter cutoff
, you can use command
papermill --engine sos my_experiment.ipynb experiment_cutoff_2.ipynb -y '{"cutoff": 2}'
Please refer to the Papermill documentation for details on the use of papermill.
Note that parameters
can be defined in either a SoS
or a subkernel cell but in both cases
parameters should be passed in Python syntax. Parameters defined in a subkernel will be automatically
transferred to the subkernel using a %put
magic.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sos-papermill-0.2.1.tar.gz
.
File metadata
- Download URL: sos-papermill-0.2.1.tar.gz
- Upload date:
- Size: 12.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
010fb490efb7b89eaf06eff9ae8e7424d2c4d22e627adc867becabb736fe9937
|
|
MD5 |
5d2dd3baa455f9d3d6948621693ef123
|
|
BLAKE2b-256 |
0c8aa4279c5399f4c264ed26a99503b70b74d2f2d26b0becad0635572421eb5a
|
File details
Details for the file sos_papermill-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: sos_papermill-0.2.1-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
eeaf951c65b598714e415b73ea296b28dfacf445bd1ea65da48baccb2154a57c
|
|
MD5 |
48ca5be09eea3a913027ee1746ef6d77
|
|
BLAKE2b-256 |
66f428ce227fc2dd0b4e8b99485c67a4f805c86f16b0429dcce82575f0b47b3f
|