Skip to main content

Package that uses a Line Integral Convolution library to clothe a 2D field (ex: density field) with a LIC texture, given two vector fields (ex: velocity (vx, vy))

Project description

lick

PyPI pre-commit.ci status Code style: black Ruff

Line Integral Convolution Knit : Package that uses a Line Integral Convolution library to clothe a 2D field (ex: density field) with a LIC texture, given two vector fields (ex: velocity (vx, vy)).

Authors: Gaylor Wafflard-Fernandez, Clément Robert

Author-email: gaylor.wafflard@univ-grenoble-alpes.fr

Installation

Install with pip

pip install lick

To import lick:

import lick as lk

The important functions are lick_box and lick_box_plot. While lick_box interpolates the data and perform a line integral convolution, lick_box_plot directly plots the final image. Use lick_box if you want to have more control of the plots you want to do with the lic. Use lick_box_plot if you want to take advantage of the fine-tuning of the pcolormesh parameters.

Example

import numpy as np
import matplotlib.pyplot as plt
from lick import lick_box_plot

fig, ax = plt.subplots()
x = np.geomspace(0.1, 10, 128)
y = np.geomspace(0.1, 5, 128)
a, b = np.meshgrid(x, y)
v1 = np.cos(a)
v2 = np.sin(b)
field = v1 ** 2 + v2 ** 2
lick_box_plot(
    fig,
    ax,
    x,
    y,
    v1,
    v2,
    field,
    size_interpolated=256,
    xmin=1,
    xmax=9,
    ymin=1,
    ymax=4,
    niter_lic=5,
    kernel_length=64,
    cmap="inferno",
    stream_density=0.5
)
plt.show()

vectorplot

The core LIC implementation was authored by Anne Archibald, and is forked from https://github.com/aarchiba/scikits-vectorplot

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lick-0.6.0.tar.gz (22.0 kB view hashes)

Uploaded Source

Built Distributions

lick-0.6.0-cp312-cp312-win_amd64.whl (100.1 kB view hashes)

Uploaded CPython 3.12 Windows x86-64

lick-0.6.0-cp312-cp312-musllinux_1_1_x86_64.whl (578.2 kB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ x86-64

lick-0.6.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (574.9 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

lick-0.6.0-cp312-cp312-macosx_11_0_arm64.whl (104.0 kB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

lick-0.6.0-cp312-cp312-macosx_10_9_x86_64.whl (114.2 kB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

lick-0.6.0-cp311-cp311-win_amd64.whl (98.3 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

lick-0.6.0-cp311-cp311-musllinux_1_1_x86_64.whl (576.1 kB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ x86-64

lick-0.6.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (570.0 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

lick-0.6.0-cp311-cp311-macosx_11_0_arm64.whl (102.3 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

lick-0.6.0-cp311-cp311-macosx_10_9_x86_64.whl (111.8 kB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

lick-0.6.0-cp310-cp310-win_amd64.whl (98.2 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

lick-0.6.0-cp310-cp310-musllinux_1_1_x86_64.whl (537.8 kB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ x86-64

lick-0.6.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (534.9 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

lick-0.6.0-cp310-cp310-macosx_11_0_arm64.whl (102.6 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

lick-0.6.0-cp310-cp310-macosx_10_9_x86_64.whl (112.1 kB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

lick-0.6.0-cp39-cp39-win_amd64.whl (98.8 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

lick-0.6.0-cp39-cp39-musllinux_1_1_x86_64.whl (539.3 kB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ x86-64

lick-0.6.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (537.1 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

lick-0.6.0-cp39-cp39-macosx_11_0_arm64.whl (103.1 kB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

lick-0.6.0-cp39-cp39-macosx_10_9_x86_64.whl (112.7 kB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page