diff --git a/.gitignore b/.gitignore index 50990fe..7975da3 100644 --- a/.gitignore +++ b/.gitignore @@ -148,3 +148,5 @@ _html/ # Project initialization script .initialize_new_project.sh +demo.ipynb +data.parquet diff --git a/README.md b/README.md index a3d4519..55441f2 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A Jupyter IPython magic extension for measuring I/O operations per second (IOPS) in your code. +![iops-profiler in action](images/demo_screenshot.gif) + [![PyPI version](https://badge.fury.io/py/iops-profiler.svg)](https://badge.fury.io/py/iops-profiler) [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) [![Documentation Status](https://readthedocs.org/projects/iops-profiler/badge/?version=latest)](https://iops-profiler.readthedocs.io/en/latest/?badge=latest) diff --git a/images/demo_screenshot.gif b/images/demo_screenshot.gif new file mode 100644 index 0000000..4440475 Binary files /dev/null and b/images/demo_screenshot.gif differ diff --git a/images/demo_screenshot_uncropped.gif b/images/demo_screenshot_uncropped.gif new file mode 100644 index 0000000..493b379 Binary files /dev/null and b/images/demo_screenshot_uncropped.gif differ diff --git a/images/histogram_example.png b/images/histogram_example.png deleted file mode 100644 index 9c18b56..0000000 Binary files a/images/histogram_example.png and /dev/null differ diff --git a/images/screenshots/frame_00_empty_notebook.png b/images/screenshots/frame_00_empty_notebook.png new file mode 100644 index 0000000..24e746d Binary files /dev/null and b/images/screenshots/frame_00_empty_notebook.png differ diff --git a/images/screenshots/frame_01_first_cell_typed.png b/images/screenshots/frame_01_first_cell_typed.png new file mode 100644 index 0000000..b795f3c Binary files /dev/null and b/images/screenshots/frame_01_first_cell_typed.png differ diff --git a/images/screenshots/frame_02_after_first_cell.png b/images/screenshots/frame_02_after_first_cell.png new file mode 100644 index 0000000..546a99b Binary files /dev/null and b/images/screenshots/frame_02_after_first_cell.png differ diff --git a/images/screenshots/frame_03_code_complete.png b/images/screenshots/frame_03_code_complete.png new file mode 100644 index 0000000..91cef1a Binary files /dev/null and b/images/screenshots/frame_03_code_complete.png differ diff --git a/images/screenshots/frame_04_final_output.png b/images/screenshots/frame_04_final_output.png new file mode 100644 index 0000000..3d6c33d Binary files /dev/null and b/images/screenshots/frame_04_final_output.png differ diff --git a/test.ipynb b/test.ipynb deleted file mode 100644 index 1ca8307..0000000 --- a/test.ipynb +++ /dev/null @@ -1,90 +0,0 @@ -{ - "cells": [ - { - "cell_type": "code", - "execution_count": null, - "id": "a09c7706", - "metadata": {}, - "outputs": [], - "source": [ - "%load_ext iops_profiler" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "f9d6f70a", - "metadata": {}, - "outputs": [], - "source": [ - "%%iops\n", - "import os\n", - "f = open(\"test.txt\", 'w')\n", - "f.write(\"stuff\" * 100) # Write data\n", - "f.write(\"stuff\" * 100) # Write more data\n", - "f.close()" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "6b864577", - "metadata": {}, - "outputs": [], - "source": [ - "import lsdb" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "1ec9de4c", - "metadata": {}, - "outputs": [], - "source": [ - "catalog = lsdb.open_catalog(\"https://data.lsdb.io/hats/erosita\", columns=[\"RA\", \"DEC\"])\n", - "catalog" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "b607cfe7", - "metadata": {}, - "outputs": [], - "source": [ - "%%iops\n", - "catalog.to_hats(base_catalog_path=\"./my_catalog\", catalog_name=\"my_catalog\", overwrite=True)" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "182827c2", - "metadata": {}, - "outputs": [], - "source": [] - } - ], - "metadata": { - "kernelspec": { - "display_name": "lsdb", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.12.12" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -}