diplotocus 0.4.0__tar.gz → 0.5.0__tar.gz

{diplotocus-0.4.0 → diplotocus-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diplotocus
-Version: 0.4.0
+Version: 0.5.0
 Summary: A python package to generate animations of matplotlib objects.
 Author-email: Tristan Boin <tristan.boin@obspm.fr>
 License-Expression: MIT

{diplotocus-0.4.0 → diplotocus-0.5.0}/docs/requirements.txt

@@ -5,4 +5,5 @@ sphinx-autodoc-typehints
 matplotlib
 numpy
 svgpath2mpl
-sphinx-copybutton
+sphinx-copybutton
+sphinx_design

{diplotocus-0.4.0 → diplotocus-0.5.0}/docs/source/conf.py

@@ -52,7 +52,8 @@ extensions = [
     "sphinx.ext.linkcode",
     "sphinx.ext.intersphinx",
     "sphinx_autodoc_typehints",
-    "sphinx_copybutton"
+    "sphinx_copybutton",
+    "sphinx_design"
 ]
 
 intersphinx_mapping = {
@@ -65,7 +66,7 @@ myst_all_links_external = True
 templates_path = ['_templates']
 # exclude specific generated/unused notebooks to avoid spurious warnings
 exclude_patterns = [
-    'notebooks/logo.ipynb','notebooks/index.ipynb'
+    'notebooks/index.ipynb'
 ]
 
 html_favicon = "_static/favicon.ico"
@@ -93,6 +94,7 @@ html_js_files = [
 myst_enable_extensions = [
     "html_image",
     "dollarmath",
+    "colon_fence"
 ]
 
 nb_execution_allow_errors = True

{diplotocus-0.4.0 → diplotocus-0.5.0}/docs/source/index.rst

@@ -62,6 +62,7 @@ Here's a quick example of the syntax of diplotocus:
    :target: notebooks/GUI.html
 
 Get started by :doc:`Installing Diplotocus <notebooks/installation>`, and follow the :doc:`Quick-Start guide <notebooks/quick-start>`.
+For examples, see the :doc:`Examples <notebooks/examples>` page.
 
 .. toctree::
    :maxdepth: 2
@@ -71,7 +72,7 @@ Get started by :doc:`Installing Diplotocus <notebooks/installation>`, and follow
    notebooks/quick-start
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
    :caption: Library reference
    
    notebooks/timeline

{diplotocus-0.4.0 → diplotocus-0.5.0}/docs/source/notebooks/animations.ipynb

@@ -60,7 +60,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_translate.mp4"
+       "Saved video ../_static/animations/anim_translate.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -74,7 +74,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_translate.mp4?randId=449\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_translate.mp4?randId=449\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -98,7 +98,7 @@
     "p.translate(start_pos=(0,0),end_pos=(1,1),duration=60)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_translate.mp4')"
+    "tl.save_video('../_static/animations/anim_translate.mp4')"
    ]
   },
   {
@@ -137,7 +137,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_rotate.mp4"
+       "Saved video ../_static/animations/anim_rotate.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -151,7 +151,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_rotate.mp4?randId=1017\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_rotate.mp4?randId=1017\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -175,7 +175,7 @@
     "p.rotate(start_angle=20,end_angle=110,duration=60)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_rotate.mp4')"
+    "tl.save_video('../_static/animations/anim_rotate.mp4')"
    ]
   },
   {
@@ -214,7 +214,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_scale.mp4"
+       "Saved video ../_static/animations/anim_scale.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -228,7 +228,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_scale.mp4?randId=2110\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_scale.mp4?randId=2110\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -252,7 +252,7 @@
     "p.scale(start_scale=(0,1),end_scale=(2,0),duration=60)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_scale.mp4')"
+    "tl.save_video('../_static/animations/anim_scale.mp4')"
    ]
   },
   {
@@ -303,7 +303,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_tween.mp4"
+       "Saved video ../_static/animations/anim_tween.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -317,7 +317,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_tween.mp4?randId=9568\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_tween.mp4?randId=9568\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -341,7 +341,7 @@
     "p.tween(property='c',start='red',end='green',duration=60)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_tween.mp4')"
+    "tl.save_video('../_static/animations/anim_tween.mp4')"
    ]
   },
   {
@@ -380,7 +380,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_math.mp4"
+       "Saved video ../_static/animations/anim_math.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -394,7 +394,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_math.mp4?randId=508\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_math.mp4?randId=508\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -419,7 +419,7 @@
     "p.math(property='lw',func=lambda t:np.cos(t*6*np.pi)*20+3,duration=60)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_math.mp4')"
+    "tl.save_video('../_static/animations/anim_math.mp4')"
    ]
   },
   {
@@ -458,7 +458,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_morph.mp4"
+       "Saved video ../_static/animations/anim_morph.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -472,7 +472,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_morph.mp4?randId=1825\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_morph.mp4?randId=1825\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -500,7 +500,7 @@
     "p.morph(new_x=x2,new_y=y2,duration=60)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_morph.mp4')"
+    "tl.save_video('../_static/animations/anim_morph.mp4')"
    ]
   },
   {
@@ -539,7 +539,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_draw.mp4"
+       "Saved video ../_static/animations/anim_draw.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -553,7 +553,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_draw.mp4?randId=6085\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_draw.mp4?randId=6085\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -578,7 +578,7 @@
     "p.draw(duration=60)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_draw.mp4')"
+    "tl.save_video('../_static/animations/anim_draw.mp4')"
    ]
   },
   {
@@ -617,7 +617,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/anim_sequence.mp4"
+       "Saved video ../_static/animations/anim_sequence.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -631,7 +631,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/anim_sequence.mp4?randId=1390\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/anim_sequence.mp4?randId=1390\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -658,7 +658,7 @@
     "p.sequence(duration=50)\n",
     "\n",
     "tl.animate(p)\n",
-    "tl.save_video('../_static/anim_sequence.mp4')"
+    "tl.save_video('../_static/animations/anim_sequence.mp4')"
    ]
   },
   {
@@ -699,7 +699,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/axis_zoom.mp4"
+       "Saved video ../_static/animations/axis_zoom.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -713,7 +713,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/axis_zoom.mp4?randId=9285\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/axis_zoom.mp4?randId=9285\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -737,7 +737,7 @@
     "a = dpl.axis_zoom(zoom=2,duration=60)\n",
     "\n",
     "tl.animate(a)\n",
-    "tl.save_video('../_static/axis_zoom.mp4')"
+    "tl.save_video('../_static/animations/axis_zoom.mp4')"
    ]
   },
   {
@@ -776,7 +776,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/axis_limits.mp4"
+       "Saved video ../_static/animations/axis_limits.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -790,7 +790,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/axis_limits.mp4?randId=2059\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/axis_limits.mp4?randId=2059\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -814,7 +814,7 @@
     "a = dpl.axis_limits(xlim=(-5,5),ylim=(-1,1),duration=60)\n",
     "\n",
     "tl.animate(a)\n",
-    "tl.save_video('../_static/axis_limits.mp4')"
+    "tl.save_video('../_static/animations/axis_limits.mp4')"
    ]
   },
   {
@@ -853,7 +853,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/axis_move.mp4"
+       "Saved video ../_static/animations/axis_move.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -867,7 +867,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/axis_move.mp4?randId=7288\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/axis_move.mp4?randId=7288\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -891,7 +891,83 @@
     "a = dpl.axis_move(end_pos=(1,1),duration=60)\n",
     "\n",
     "tl.animate(a)\n",
-    "tl.save_video('../_static/axis_move.mp4')"
+    "tl.save_video('../_static/animations/axis_move.mp4')"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "fc9ac910",
+   "metadata": {},
+   "source": [
+    "### Axis track\n",
+    "\n",
+    "```{eval-rst}\n",
+    ".. automethod:: diplotocus.animations.axis_track\n",
+    "    :noindex:\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "15283849",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "698754ccec1b4218be341de8f233a3fc",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "  0%|          | 0/60 [00:00<?, ?it/s]"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/markdown": [
+       "Saved video ../_static/animations/axis_track.mp4"
+      ],
+      "text/plain": [
+       "<IPython.core.display.Markdown object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "data": {
+      "text/html": [
+       "\n",
+       "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
+       "                <source src=\"../_static/animations/axis_track.mp4?randId=6295\" type=\"video/mp4\">\n",
+       "                </video>\n",
+       "            "
+      ],
+      "text/plain": [
+       "<IPython.core.display.HTML object>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "import diplotocus as dpl\n",
+    "\n",
+    "tl = dpl.Timeline(xlim=(-2,2),ylim=(-2,2))\n",
+    "tl.main_axis.grid()\n",
+    "\n",
+    "s = dpl.scatter(x=1,y=0)\n",
+    "s.rotate(start_angle=0,end_angle=360,center=(0,0),duration=60)\n",
+    "a = dpl.axis_track(obj=s,duration=60)\n",
+    "\n",
+    "tl.animate((s,a))\n",
+    "tl.save_video('../_static/animations/axis_track.mp4')"
    ]
   },
   {
@@ -930,7 +1006,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/axis_alpha.mp4"
+       "Saved video ../_static/animations/axis_alpha.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -944,7 +1020,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/axis_alpha.mp4?randId=3022\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/axis_alpha.mp4?randId=3022\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -968,7 +1044,7 @@
     "a = dpl.axis_alpha(start_alpha=0,end_alpha=1,duration=50)\n",
     "\n",
     "tl.animate(a)\n",
-    "tl.save_video('../_static/axis_alpha.mp4')"
+    "tl.save_video('../_static/animations/axis_alpha.mp4')"
    ]
   },
   {
@@ -1007,7 +1083,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/fig_width_ratio.mp4"
+       "Saved video ../_static/animations/fig_width_ratio.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -1021,7 +1097,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/fig_width_ratio.mp4?randId=4844\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/fig_width_ratio.mp4?randId=4844\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -1048,7 +1124,7 @@
     "a = dpl.fig_width_ratio(start_widths=(1,0),end_widths=(0,1),duration=60)\n",
     "\n",
     "tl.animate(a)\n",
-    "tl.save_video('../_static/fig_width_ratio.mp4')"
+    "tl.save_video('../_static/animations/fig_width_ratio.mp4')"
    ]
   },
   {
@@ -1087,7 +1163,7 @@
     {
      "data": {
       "text/markdown": [
-       "Saved video ../_static/fig_height_ratio.mp4"
+       "Saved video ../_static/animations/fig_height_ratio.mp4"
       ],
       "text/plain": [
        "<IPython.core.display.Markdown object>"
@@ -1101,7 +1177,7 @@
       "text/html": [
        "\n",
        "                <video width=\"640\" height=\"360\" autoplay loop muted playsinline>\n",
-       "                <source src=\"../_static/fig_height_ratio.mp4?randId=767\" type=\"video/mp4\">\n",
+       "                <source src=\"../_static/animations/fig_height_ratio.mp4?randId=767\" type=\"video/mp4\">\n",
        "                </video>\n",
        "            "
       ],
@@ -1128,7 +1204,7 @@
     "a = dpl.fig_height_ratio(start_heights=(1,0),end_heights=(0,1),duration=60)\n",
     "\n",
     "tl.animate(a)\n",
-    "tl.save_video('../_static/fig_height_ratio.mp4')"
+    "tl.save_video('../_static/animations/fig_height_ratio.mp4')"
    ]
   }
  ],