Feature: integrate pycirclize into UltraPlot

.readthedocs.yml

@@ -22,3 +22,5 @@ python:
   install:
     - method: pip
       path: .
+      extra_requirements:
+        - all

INSTALL.rst

@@ -10,6 +10,14 @@ with ``pip`` or ``conda`` as follows:
    pip install ultraplot
    conda install -c conda-forge ultraplot
 
+The default install includes optional features (for example, pyCirclize-based plots).
+For a minimal install, use ``--no-deps`` and install the core requirements:
+
+.. code-block:: bash
+
+   pip install ultraplot --no-deps
+   pip install -r requirements-minimal.txt
+
 Likewise, an existing installation of ultraplot can be upgraded to the latest version with:
 
 .. code-block:: bash

README.rst

@@ -104,6 +104,14 @@ UltraPlot is published on `PyPi <https://pypi.org/project/ultraplot/>`__ and
    pip install ultraplot
    conda install -c conda-forge ultraplot
 
+The default install includes optional features (for example, pyCirclize-based plots).
+For a minimal install, use ``--no-deps`` and install the core requirements:
+
+.. code-block:: bash
+
+   pip install ultraplot --no-deps
+   pip install -r requirements-minimal.txt
+
 Likewise, an existing installation of UltraPlot can be upgraded
 to the latest version with:
 

docs/contributing.rst

@@ -90,6 +90,9 @@ To build the documentation locally, use the following commands:
    # ...or create a new conda environment
    # conda env create -n ultraplot-dev --file docs/environment.yml
    # source activate ultraplot-dev
+   # Minimal install (no optional dependencies)
+   # pip install ultraplot --no-deps
+   # pip install -r ../requirements-minimal.txt
    # Create HTML documentation
    make html
 

docs/examples/plot_types/07_radar.py

@@ -0,0 +1,32 @@
+"""
+Radar chart
+===========
+
+UltraPlot wrapper around pyCirclize's radar chart helper.
+"""
+
+import pandas as pd
+
+import ultraplot as uplt
+
+data = pd.DataFrame(
+    {
+        "Design": [3.5, 4.0],
+        "Speed": [4.2, 3.1],
+        "Reliability": [4.6, 4.1],
+        "Support": [3.2, 4.4],
+    },
+    index=["Model A", "Model B"],
+)
+
+fig, ax = uplt.subplots(proj="polar", refwidth=3.6)
+ax.radar_chart(
+    data,
+    vmin=0,
+    vmax=5,
+    fill=True,
+    marker_size=4,
+    grid_interval_ratio=0.2,
+)
+ax.format(title="Product radar")
+fig.show()

docs/examples/plot_types/08_chord_diagram.py

@@ -0,0 +1,21 @@
+"""
+Chord diagram
+=============
+
+UltraPlot wrapper around pyCirclize chord diagrams.
+"""
+
+import pandas as pd
+
+import ultraplot as uplt
+
+matrix = pd.DataFrame(
+    [[10, 6, 2], [6, 12, 4], [2, 4, 8]],
+    index=["A", "B", "C"],
+    columns=["A", "B", "C"],
+)
+
+fig, ax = uplt.subplots(proj="polar", refwidth=3.6)
+ax.chord_diagram(matrix, ticks_interval=None, space=4)
+ax.format(title="Chord diagram")
+fig.show()

docs/examples/plot_types/09_phylogeny.py

@@ -0,0 +1,15 @@
+"""
+Phylogeny
+=========
+
+UltraPlot wrapper around pyCirclize phylogeny plots.
+"""
+
+import ultraplot as uplt
+
+newick = "((A,B),C);"
+
+fig, ax = uplt.subplots(proj="polar", refwidth=3.2)
+ax.phylogeny(newick, leaf_label_size=10)
+ax.format(title="Phylogeny")
+fig.show()

docs/examples/plot_types/10_circos_bed.py

@@ -0,0 +1,34 @@
+"""
+Circos from BED
+===============
+
+Build sectors from a BED file and render on UltraPlot polar axes.
+"""
+
+import tempfile
+from pathlib import Path
+
+import numpy as np
+
+import ultraplot as uplt
+
+bed_text = "chr1\t0\t100\nchr2\t0\t140\n"
+
+with tempfile.TemporaryDirectory() as tmpdir:
+    bed_path = Path(tmpdir) / "mini.bed"
+    bed_path.write_text(bed_text, encoding="utf-8")
+
+    fig, ax = uplt.subplots(proj="polar", refwidth=3.6)
+    ax = ax[0]  # pycirclize expects a PolarAxes, not a SubplotGrid wrapper
+    circos = ax.circos_bed(bed_path, plot=False)
+
+    for sector in circos.sectors:
+        x = np.linspace(sector.start, sector.end, 8)
+        y = np.linspace(0, 50, 8)
+        track = sector.add_track((60, 90), r_pad_ratio=0.1)
+        track.axis()
+        track.line(x, y)
+
+    circos.plotfig(ax=ax)
+    ax.format(title="BED sectors")
+    fig.show()

environment.yml

@@ -35,3 +35,4 @@ dependencies:
   - lxml-html-clean
   - pip:
       - git+https://github.com/ultraplot/UltraTheme.git
+      - pycirclize

pyproject.toml

@@ -34,6 +34,7 @@ classifiers = [
 dependencies= [
     "numpy>=1.26.0",
     "matplotlib>=3.9,<3.11",
+    "pycirclize>=1.10.1",
     "typing-extensions; python_version < '3.12'",
 ]
 dynamic = ["version"]

requirements-minimal.txt

@@ -0,0 +1,3 @@
+numpy>=1.26.0
+matplotlib>=3.9,<3.11
+typing-extensions; python_version < "3.12"