plotlp 0.1.0__tar.gz → 0.1.2__tar.gz

{plotlp-0.1.0 → plotlp-0.1.2}/PKG-INFO

@@ -1,39 +1,47 @@
 Metadata-Version: 2.3
 Name: plotlp
-Version: 0.1.0
+Version: 0.1.2
 Summary: A library wrapper around matplotlib for custom plots.
-Author: LancelotPincet
-Author-email: LancelotPincet <40608570+LancelotPincet@users.noreply.github.com>
 Requires-Dist: corelp
-Requires-Dist: pytest>=8.4.1
-Requires-Dist: sphinx>=8.2.3
-Requires-Dist: sphinx-rtd-theme>=3.0.2
-Requires-Dist: toml>=0.10.2
+Requires-Dist: cycler
+Requires-Dist: ipykernel
+Requires-Dist: matplotlib
+Requires-Dist: pytest
+Requires-Dist: sphinx
+Requires-Dist: sphinx-design
+Requires-Dist: sphinx-rtd-theme
+Requires-Dist: spyder-kernels
+Requires-Dist: toml
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 
-# plotLP
-
-```text
-Author        : Lancelot PINCET
-GitHub        : https://github.com/LancelotPincet/plotLP
-HTTPS         : https://github.com/LancelotPincet/plotLP.git
-SSH           : git@github.com:LancelotPincet/plotLP.git
-PyPI          : https://pypi.org/project/plotLP
-Docs          : https://plotLP.readthedocs.io
-```
-
-**A library wrapper around matplotlib for custom plots.**
-
-plotLP is available on [PyPI](https://pypi.org/project/plotLP) for pip installs.
-For more information, do not hesitate to consult the [Documentation](https://plotLP.readthedocs.io).
-
----
-
-## MIT License
-
-Intellectual property behind this Library is protected via an [MIT license](LICENSE). This means everyone can *freely* use it in a personnal, academic or commercial manner, if they **keep the copyright name** at the top of the codes.
-
-The library can be redistributed, *with or without modifications*, in open or closed projects. However the **MIT license must be conserved**. For example in a commercial closed project, this means the **copyright and license must be visible somewhere**, like in the documentation or credits.
-
-The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+# plotLP
+
+```text
+Author        : Lancelot PINCET
+GitHub        : https://github.com/LancelotPincet/plotLP
+HTTPS         : https://github.com/LancelotPincet/plotLP.git
+SSH           : git@github.com:LancelotPincet/plotLP.git
+PyPI          : https://pypi.org/project/plotLP
+Docs          : https://plotLP.readthedocs.io
+```
+
+**A library wrapper around matplotlib for custom plots.**
+
+plotLP is available on [PyPI](https://pypi.org/project/plotLP) for pip installs.
+For more information, do not hesitate to consult the [Documentation](https://plotLP.readthedocs.io).
+
+---
+
+## MIT License
+
+<details>
+<summary>details</summary>
+
+Intellectual property behind this Library is protected via an [MIT license](LICENSE). This means everyone can *freely* use it in a personnal, academic or commercial manner, if they **keep the copyright name** at the top of the codes.
+
+The library can be redistributed, *with or without modifications*, in open or closed projects. However the **MIT license must be conserved**. For example in a commercial closed project, this means the **copyright and license must be visible somewhere**, like in the documentation or credits.
+
+The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+
+</details>

{plotlp-0.1.0 → plotlp-0.1.2}/README.md

@@ -1,25 +1,30 @@
-# plotLP
-
-```text
-Author        : Lancelot PINCET
-GitHub        : https://github.com/LancelotPincet/plotLP
-HTTPS         : https://github.com/LancelotPincet/plotLP.git
-SSH           : git@github.com:LancelotPincet/plotLP.git
-PyPI          : https://pypi.org/project/plotLP
-Docs          : https://plotLP.readthedocs.io
-```
-
-**A library wrapper around matplotlib for custom plots.**
-
-plotLP is available on [PyPI](https://pypi.org/project/plotLP) for pip installs.
-For more information, do not hesitate to consult the [Documentation](https://plotLP.readthedocs.io).
-
----
-
-## MIT License
-
-Intellectual property behind this Library is protected via an [MIT license](LICENSE). This means everyone can *freely* use it in a personnal, academic or commercial manner, if they **keep the copyright name** at the top of the codes.
-
-The library can be redistributed, *with or without modifications*, in open or closed projects. However the **MIT license must be conserved**. For example in a commercial closed project, this means the **copyright and license must be visible somewhere**, like in the documentation or credits.
-
-The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+# plotLP
+
+```text
+Author        : Lancelot PINCET
+GitHub        : https://github.com/LancelotPincet/plotLP
+HTTPS         : https://github.com/LancelotPincet/plotLP.git
+SSH           : git@github.com:LancelotPincet/plotLP.git
+PyPI          : https://pypi.org/project/plotLP
+Docs          : https://plotLP.readthedocs.io
+```
+
+**A library wrapper around matplotlib for custom plots.**
+
+plotLP is available on [PyPI](https://pypi.org/project/plotLP) for pip installs.
+For more information, do not hesitate to consult the [Documentation](https://plotLP.readthedocs.io).
+
+---
+
+## MIT License
+
+<details>
+<summary>details</summary>
+
+Intellectual property behind this Library is protected via an [MIT license](LICENSE). This means everyone can *freely* use it in a personnal, academic or commercial manner, if they **keep the copyright name** at the top of the codes.
+
+The library can be redistributed, *with or without modifications*, in open or closed projects. However the **MIT license must be conserved**. For example in a commercial closed project, this means the **copyright and license must be visible somewhere**, like in the documentation or credits.
+
+The license also explains that the **code performances are not warrantied**, and you are responsible for how you are using it. For more information on your rights and obligations please refer to [descriptive websites](https://en.wikipedia.org/wiki/MIT_License), or contact author for approvales.
+
+</details>

{plotlp-0.1.0 → plotlp-0.1.2}/pyproject.toml

@@ -1,26 +1,17 @@
 [project]
 name = "plotlp"
-version = "0.1.0"
+version = "0.1.2"
 description = "A library wrapper around matplotlib for custom plots."
 readme = "README.md"
 requires-python = ">=3.12"
-dependencies = [
-    "corelp",
-    "pytest>=8.4.1",
-    "sphinx>=8.2.3",
-    "sphinx-rtd-theme>=3.0.2",
-    "toml>=0.10.2",
-]
-[[project.authors]]
-name = "LancelotPincet"
-email = "40608570+LancelotPincet@users.noreply.github.com"
+dependencies = [ "corelp", "cycler", "ipykernel", "matplotlib", "pytest", "sphinx", "sphinx-design", "sphinx-rtd-theme", "spyder-kernels", "toml",]
 
 [build-system]
 requires = [ "uv_build>=0.8.8,<0.9.0",]
 build-backend = "uv_build"
 
-["tool.uv"]
+[tool.uv]
 required-environments = [ "sys_platform == 'linux' and platform_machine == 'x86_64'", "sys_platform == 'win32' and (platform_machine == 'AMD64' or platform_machine == 'x86_64')",]
 
-[tool.uv.sources]
-corelp = { workspace = true }
+[tool.uv.sources.corelp]
+workspace = true

{plotlp-0.1.0 → plotlp-0.1.2}/src/plotlp/__init__.py

@@ -1,23 +1,23 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Date          : 2025-08-28
-# Author        : Lancelot PINCET
-# GitHub        : https://github.com/LancelotPincet
-# Library       : plotLP
-
-"""
-A library wrapper around matplotlib for custom plots.
-"""
-
-
-
-# %% Lazy imports
-from corelp import getmodule
-__getattr__, __all__ = getmodule(__file__)
-
-
-
-# %% Test function run
-if __name__ == "__main__":
-    from corelp import test
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-08-28
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : plotLP
+
+"""
+A library wrapper around matplotlib for custom plots.
+"""
+
+
+
+# %% Lazy imports
+from corelp import getmodule
+__getattr__, __all__ = getmodule(__file__)
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
     test(__file__)

plotlp-0.1.2/src/plotlp/modules/cmap_LP/cmap.py

@@ -0,0 +1,132 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-11-17
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : plotLP
+# Module        : cmap
+
+"""
+This module adds custom cmaps to matplotlib.
+"""
+
+
+
+# %% Libraries
+from corelp import selfkwargs, prop
+from arrLP import normalize
+from plotlp import color
+from matplotlib.colors import LinearSegmentedColormap, to_rgba_array
+import numpy as np
+from scipy.special import erf,erfinv
+
+
+
+# %% Function
+def cmap(**kwargs) :
+    '''
+    This module adds custom cmaps to matplotlib.
+    
+    Parameters
+    ----------
+    a : int or float
+        TODO.
+
+    Returns
+    -------
+    b : int or float
+        TODO.
+
+    Raises
+    ------
+    TypeError
+        TODO.
+
+    Examples
+    --------
+    >>> from plotlp import cmap
+    ...
+    >>> cmap() # TODO
+    '''
+
+    return None
+
+
+
+class Cmap(LinearSegmentedColormap) :
+    name = 'cmapLP'
+
+    def __init__(self, **kwargs) :
+        selfkwargs(self,kwargs)
+        r, g, b, a = to_rgba_array(self.colors).T
+        nodes = self.nodes
+        cdict = {
+            "red": np.column_stack([nodes, r, r]),
+            "green": np.column_stack([nodes, g, g]),
+            "blue": np.column_stack([nodes, b, b]),
+            "alpha": np.column_stack([nodes, a, a]),
+        }
+        super().__init__(self.name,cdict)
+
+    _black = 'black'
+    @prop(variable=True)
+    def black(self) -> str :
+        if self._black is None :
+            return color(rgb=self(self.get_node(0.)))
+        return color(auto=self._black)
+
+    _white =  'white'
+    @prop(variable=True)
+    def white(self) -> str :
+        if self._white is None :
+            return color(rgb=self(self.get_node(1.)))
+        return color(auto=self._white)
+
+    _color = None
+    @prop(variable=True)
+    def color(self) :
+        if self._color is None :
+            return color(rgb=self(self.get_node(0.5)))
+        return color(auto=self._color)
+
+    _dark = None #dark color
+    @prop(variable=True)
+    def dark(self) -> str :
+        if self._dark is None :
+            return color(self(self.get_node(0.25)))
+        return color(self._dark)
+
+    _light = None #light color
+    @prop(variable=True)
+    def light(self) -> str :
+        if self._light is None :
+            return color(self(self.get_node(0.75)))
+        return color(self._light)
+
+    _colors = None #list of colors
+    @prop()
+    def colors(self) -> str :
+        return [self.black,self.dark,self.color,self.light,self.white]
+    @colors.setter
+    def colors(self, value) -> float :
+        self._colors = [color(auto=color) for color in value]
+    @property
+    def ncolors(self) :
+        return len(self.colors)
+
+    _nodes = None #nodes corresponding to colors
+    @prop()
+    def nodes(self) -> str :
+        nodes = np.linspace(0.,1.,self.ncolors)
+        return self.get_node(nodes)
+    nodebase = 0 #Base defining distribution of colors around center based on erf function, when approching 0 the function tends towards linear distribution
+    def get_node(self,node) :
+        if self.nodebase == 0 : return node
+        node = (erfinv(normalize(node,-erf(self.nodebase),erf(self.nodebase),offset=0,norm=1))/self.nodebase+1)/2
+        return (np.round(node * 1000)).astype(int)/1000
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)

plotlp-0.1.2/src/plotlp/modules/cmap_LP/test_cmap.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Date          : 2025-11-17
+# Author        : Lancelot PINCET
+# GitHub        : https://github.com/LancelotPincet
+# Library       : plotLP
+# Module        : cmap
+
+"""
+This file allows to test cmap
+
+cmap : This module adds custom cmaps to matplotlib.
+"""
+
+
+
+# %% Libraries
+from corelp import print, debug
+import pytest
+from plotlp import cmap
+debug_folder = debug(__file__)
+
+
+
+# %% Function test
+def test_function() :
+    '''
+    Test cmap function
+    '''
+    print('Hello world!')
+
+
+
+# %% Instance fixture
+@pytest.fixture()
+def instance() :
+    '''
+    Create a new instance at each test function
+    '''
+    return cmap()
+
+def test_instance(instance) :
+    '''
+    Test on fixture
+    '''
+    pass
+
+
+# %% Returns test
+@pytest.mark.parametrize("args, kwargs, expected, message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_returns(args, kwargs, expected, message) :
+    '''
+    Test cmap return values
+    '''
+    assert cmap(*args, **kwargs) == expected, message
+
+
+
+# %% Error test
+@pytest.mark.parametrize("args, kwargs, error, error_message", [
+    #([], {}, None, ""),
+    ([], {}, None, ""),
+])
+def test_errors(args, kwargs, error, error_message) :
+    '''
+    Test cmap error values
+    '''
+    with pytest.raises(error, match=error_message) :
+        cmap(*args, **kwargs)
+
+
+
+# %% Test function run
+if __name__ == "__main__":
+    from corelp import test
+    test(__file__)