Metadata-Version: 2.1
Name: open-atmos-jupyter-utils
Version: 1.0.0
Summary: utility routines used in PySDM and PyMPDATA examples and tests
Author: https://github.com/open-atmos/jupyter-utils/graphs/contributors
Author-email: sylwester.arabas@uj.edu.pl
License: GPL-3.0
Project-URL: Tracker, https://github.com/open-atmos/jupyter-utils/issues
Project-URL: Documentation, https://open-atmos.github.io/jupyter-utils
Project-URL: Source, https://github.com/open-atmos/jupyter-utils
Description-Content-Type: text/markdown
License-File: LICENSE

# utils

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
[![Github Actions Status](https://github.com/open-atmos/jupyter-utils/workflows/Pylint/badge.svg?branch=main)](https://github.com/open-atmos/jupyter-utils/actions)
[![PyPI version](https://badge.fury.io/py/open-atmos-jupyter-utils.svg)](https://pypi.org/project/open-atmos-jupyter-utils)

Utility routines used in Jupyter notebooks in [PySDM-examples](https://github.com/open-atmos/PySDM-examples), [PyMPDATA-examples](https://github.com/open-atmos/PyMPDATA-examples) and [PyPartMC-examples](https://github.com/open-atmos/PyPartMC-examples) projects:
- [``show_plot()``](https://open-atmos.github.io/jupyter-utils/show_plot.html) - a drop-in replacement for matplotlib's show() displaying the figure using vector graphics (svg) by default and offering a download-as-pdf widget just below (on Colab the widget triggers Google Drive download)
- [``TemporaryFile``](https://open-atmos.github.io/jupyter-utils/temporary_file.html) - a class equipped with ``make_link_widget()`` method returning a click-to-download Colab-compatible widget to be display()-ed in a Jupyter notebook
- [``pip_install_on_colab('package_a', 'package_b', ...)``](https://open-atmos.github.io/jupyter-utils/pip_install_on_colab.html) - a function handling execution of ``pip`` (and ``ldconfig``) on Colab 

public API docs are maintained at: https://open-atmos.github.io/jupyter-utils/
