DGCV 0.3.2__tar.gz → 0.3.4__tar.gz

{dgcv-0.3.2/src/dgcv.egg-info → dgcv-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dgcv
-Version: 0.3.2
+Version: 0.3.4
 Summary: Differential Geometry with Complex Variables
 Author: David Sykes
 Author-email: David Sykes <david@realandimaginary.com>
@@ -18,51 +18,35 @@ Dynamic: requires-python
 
 **dgcv** is an open-source Python package providing basic tools for differential geometry integrated with systematic organization of structures naturally accompanying complex variables, in short, Differential Geometry with Complex Variables.
 
-At its core are symbolic representations of standard DG objects such as vector fields and differential forms. There are coordinate free representations, and representations defined relative to coordinate systems falling into two broad categories:
+At its core are symbolic representations of standard DG objects such as vector fields and differential forms. There are coordinate free representations, and representations defined relative to coordinate systems falling into two general categories:
 
-- **standard** - basic systems that can represent real or complex coordinates, sufficient for all applications that do not require **dgcv**'s complex variable handling features.
+- **standard** - basic systems that can represent real or complex coordinates, sufficient for applications that do not require **dgcv**'s complex variable handling features.
 - **complex** - richer systems for representing complex coordinate patches that interact with **dgcv**'s complex variable handling features. These are comprised of holomorphic coordinate functions, their conjugates, and their real and imaginary parts (e.g., $\\{z_j,\overline{z_j},x_j,y_j\\}$).
 
 **dgcv** functions account for coordinate types dynamically when operating on objects built from such coordinate systems. The package has a growing library for coordinate-free representations as well, and tools for converting between the two paradigms.
 
 As systems of differential geometric objects constructed from complex variables inherit natural relationships from the underlying complex structure, **dgcv** objects track these relationships across the constructions. This system enables smooth switching between real and holomorphic coordinate representations of mathematical objects. In computations, **dgcv** objects dynamically manage this format switching on their own so that typical complex variables formulas can be written plainly and will simply work. Some examples of this: In coordinates $z_j = x_j + iy_j$, expressions such as $\frac{\partial}{\partial x_j}|z_j|^2$ or $d z_j \wedge d \overline{z_j} \left( \frac{\partial}{\partial z_j}, \frac{\partial}{\partial y_j} \right)$ are correctly parsed without needing to convert everything to a uniform variable format. Retrieving objects' complex structure-related attributes, like the holomorphic part of a vector field or pluriharmonic terms from a polynomial is straightforward. Complexified cotangent bundles and their exterior algebras are easily decomposed into components from the Dolbeault complex and Dolbeault operators themselves can be applied to functions and k-forms in either coordinate format.
 
-**dgcv** was developed using Python 3.13, and has dependencies on the SymPy and Pandas libraries in addition to base Python.
+**dgcv** is tested on Python 3.13, and has dependencies on the SymPy, Pandas, and iPython libraries.
 
 ## Features
 
-- Fully featured symbolic representations of various tensor fields (vector fields, differential forms, etc.), and dedicated python classes for representing many other common differential geometric structures
-- Intuitive interactions with complex structures from holomorphic coordinate systems: **dgcv** objects dynamically manage coordinate transformations between real and holomorphic coordinates during computation as necessary, so objects can be represented in and freely converted between either coordinate format at any time.
-- Natural LaTeX rendering for representation of mathematical objects, designed with Jupyter notebooks in mind.
+- Symbolic representations of various tensor fields (vector fields, differential forms, etc.) and dedicated python classes for representing many other common differential geometric structures
+- Intuitive interactions with complex structures from holomorphic coordinate systems: **dgcv** objects dynamically manage coordinate transformations between real and holomorphic coordinates during computation as necessary, so objects can be represented in and freely converted between either coordinate format
 
 ## Installation
 
-You can install **dgcv** directly from PyPI with pip, e.g.:
+**dgcv** can be installed directly from PyPI with pip, e.g.:
 
 ```bash
 pip install dgcv
 ```
 
-Depending on Python install configurations, the above command can vary. The key is to have the relevant Python environment active so that the package manager pip sources from the right location (suggested to use virtual environments: [Getting started with virtual environments](https://docs.python.org/3/library/venv.html)).
-
-## Tutorials
-
-Two Jupyter Notebook tutorials are available to help getting started with **dgcv**:
-
-1. **dgcv Introduction**: An introduction to the key concepts and setup
-
-   - [View **dgcv** Introduction Tutorial](https://www.realandimaginary.com/dgcv/tutorials/DGCV_introduction/)
-
-2. **dgcv in Action**: A quick tour through examples from some of the library's more elaborate functions
-   - [View **dgcv** in Action Tutorial](https://www.realandimaginary.com/dgcv/tutorials/DGCV_in_action/)
-
-### Running the Tutorials Locally
-
-You can download the tutorials individually from the **dgcv** repository [**dgcv** github repo](https://github.com/YikesItsSykes/DGCV).
+Depending on Python install configurations, the above command can vary. The key is to have the relevant Python environment active so that the package manager `pip` sources from the right location (suggested to use virtual environments: [Getting started with virtual environments](https://docs.python.org/3/library/venv.html)).
 
 ## Documentation
 
-**dgcv** documentation is hosted at [https://www.realandimaginary.com/dgcv/](https://www.realandimaginary.com/dgcv/), with documentation pages for each function in the library and more. Full documentation is gradually being filled in. In the mean time, docstrings within the code provide more information on available classes/methods and functions.
+**dgcv** documentation is hosted at [https://www.realandimaginary.com/dgcv/](https://www.realandimaginary.com/dgcv/), with documentation pages for individual functions in the library and more. Docstrings within the code provide more information on available classes/methods and functions.
 
 ## License
 
@@ -76,7 +60,7 @@ You can download the tutorials individually from the **dgcv** repository [**dgcv
 
 ### Future Development
 
-The current (0.3.x) version of **dgcv** is designed with several planned extensions to the library in mind. Current plans broadly fall into these categories:
+The current (0.3.x) version of **dgcv** is designed with several planned extensions to the library in mind. Current plans broadly fall into two categories:
 
 - Extending complex variable handling and dynamic coordinate-type conversion automations. The simple goal is to fully automate handling of complex variable formats, allowing input to be formatted freely with any coordinate type, with features to fully control coordinate type formatting or let the systems automate the process.
 - Expanding libraries dedicated to more specialized areas of differential geometry

{dgcv-0.3.2 → dgcv-0.3.4}/README.md

@@ -2,51 +2,35 @@
 
 **dgcv** is an open-source Python package providing basic tools for differential geometry integrated with systematic organization of structures naturally accompanying complex variables, in short, Differential Geometry with Complex Variables.
 
-At its core are symbolic representations of standard DG objects such as vector fields and differential forms. There are coordinate free representations, and representations defined relative to coordinate systems falling into two broad categories:
+At its core are symbolic representations of standard DG objects such as vector fields and differential forms. There are coordinate free representations, and representations defined relative to coordinate systems falling into two general categories:
 
-- **standard** - basic systems that can represent real or complex coordinates, sufficient for all applications that do not require **dgcv**'s complex variable handling features.
+- **standard** - basic systems that can represent real or complex coordinates, sufficient for applications that do not require **dgcv**'s complex variable handling features.
 - **complex** - richer systems for representing complex coordinate patches that interact with **dgcv**'s complex variable handling features. These are comprised of holomorphic coordinate functions, their conjugates, and their real and imaginary parts (e.g., $\\{z_j,\overline{z_j},x_j,y_j\\}$).
 
 **dgcv** functions account for coordinate types dynamically when operating on objects built from such coordinate systems. The package has a growing library for coordinate-free representations as well, and tools for converting between the two paradigms.
 
 As systems of differential geometric objects constructed from complex variables inherit natural relationships from the underlying complex structure, **dgcv** objects track these relationships across the constructions. This system enables smooth switching between real and holomorphic coordinate representations of mathematical objects. In computations, **dgcv** objects dynamically manage this format switching on their own so that typical complex variables formulas can be written plainly and will simply work. Some examples of this: In coordinates $z_j = x_j + iy_j$, expressions such as $\frac{\partial}{\partial x_j}|z_j|^2$ or $d z_j \wedge d \overline{z_j} \left( \frac{\partial}{\partial z_j}, \frac{\partial}{\partial y_j} \right)$ are correctly parsed without needing to convert everything to a uniform variable format. Retrieving objects' complex structure-related attributes, like the holomorphic part of a vector field or pluriharmonic terms from a polynomial is straightforward. Complexified cotangent bundles and their exterior algebras are easily decomposed into components from the Dolbeault complex and Dolbeault operators themselves can be applied to functions and k-forms in either coordinate format.
 
-**dgcv** was developed using Python 3.13, and has dependencies on the SymPy and Pandas libraries in addition to base Python.
+**dgcv** is tested on Python 3.13, and has dependencies on the SymPy, Pandas, and iPython libraries.
 
 ## Features
 
-- Fully featured symbolic representations of various tensor fields (vector fields, differential forms, etc.), and dedicated python classes for representing many other common differential geometric structures
-- Intuitive interactions with complex structures from holomorphic coordinate systems: **dgcv** objects dynamically manage coordinate transformations between real and holomorphic coordinates during computation as necessary, so objects can be represented in and freely converted between either coordinate format at any time.
-- Natural LaTeX rendering for representation of mathematical objects, designed with Jupyter notebooks in mind.
+- Symbolic representations of various tensor fields (vector fields, differential forms, etc.) and dedicated python classes for representing many other common differential geometric structures
+- Intuitive interactions with complex structures from holomorphic coordinate systems: **dgcv** objects dynamically manage coordinate transformations between real and holomorphic coordinates during computation as necessary, so objects can be represented in and freely converted between either coordinate format
 
 ## Installation
 
-You can install **dgcv** directly from PyPI with pip, e.g.:
+**dgcv** can be installed directly from PyPI with pip, e.g.:
 
 ```bash
 pip install dgcv
 ```
 
-Depending on Python install configurations, the above command can vary. The key is to have the relevant Python environment active so that the package manager pip sources from the right location (suggested to use virtual environments: [Getting started with virtual environments](https://docs.python.org/3/library/venv.html)).
-
-## Tutorials
-
-Two Jupyter Notebook tutorials are available to help getting started with **dgcv**:
-
-1. **dgcv Introduction**: An introduction to the key concepts and setup
-
-   - [View **dgcv** Introduction Tutorial](https://www.realandimaginary.com/dgcv/tutorials/DGCV_introduction/)
-
-2. **dgcv in Action**: A quick tour through examples from some of the library's more elaborate functions
-   - [View **dgcv** in Action Tutorial](https://www.realandimaginary.com/dgcv/tutorials/DGCV_in_action/)
-
-### Running the Tutorials Locally
-
-You can download the tutorials individually from the **dgcv** repository [**dgcv** github repo](https://github.com/YikesItsSykes/DGCV).
+Depending on Python install configurations, the above command can vary. The key is to have the relevant Python environment active so that the package manager `pip` sources from the right location (suggested to use virtual environments: [Getting started with virtual environments](https://docs.python.org/3/library/venv.html)).
 
 ## Documentation
 
-**dgcv** documentation is hosted at [https://www.realandimaginary.com/dgcv/](https://www.realandimaginary.com/dgcv/), with documentation pages for each function in the library and more. Full documentation is gradually being filled in. In the mean time, docstrings within the code provide more information on available classes/methods and functions.
+**dgcv** documentation is hosted at [https://www.realandimaginary.com/dgcv/](https://www.realandimaginary.com/dgcv/), with documentation pages for individual functions in the library and more. Docstrings within the code provide more information on available classes/methods and functions.
 
 ## License
 
@@ -60,7 +44,7 @@ You can download the tutorials individually from the **dgcv** repository [**dgcv
 
 ### Future Development
 
-The current (0.3.x) version of **dgcv** is designed with several planned extensions to the library in mind. Current plans broadly fall into these categories:
+The current (0.3.x) version of **dgcv** is designed with several planned extensions to the library in mind. Current plans broadly fall into two categories:
 
 - Extending complex variable handling and dynamic coordinate-type conversion automations. The simple goal is to fully automate handling of complex variable formats, allowing input to be formatted freely with any coordinate type, with features to fully control coordinate type formatting or let the systems automate the process.
 - Expanding libraries dedicated to more specialized areas of differential geometry

{dgcv-0.3.2 → dgcv-0.3.4}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 requires-python = ">=3.6"
 name = "dgcv"
-version = "0.3.2"
+version = "0.3.4"
 description = "Differential Geometry with Complex Variables"
 authors = [{ name = "David Sykes", email = "david@realandimaginary.com" }]
 license = { text = "MIT" }

{dgcv-0.3.2 → dgcv-0.3.4}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = dgcv
-version = 0.3.2
+version = 0.3.4
 description = A package for Differential Geometry with Complex Variables
 author = David Sykes
 author_email = david@realandimaginary.com

{dgcv-0.3.2 → dgcv-0.3.4}/setup.py

@@ -15,7 +15,7 @@ To get started, check out the Jupyter Notebook tutorials:
 
 setup(
     name="dgcv",
-    version="0.3.2",
+    version="0.3.4",
     description="Differential Geometry with Complex Variables",
     long_description=long_description,  # This shows up on PyPI
     long_description_content_type="text/markdown",

{dgcv-0.3.2 → dgcv-0.3.4}/src/dgcv/CR_geometry.py

@@ -34,10 +34,8 @@ from .dgcv_core import (
     VFClass,
     addVF,
     allToReal,
-    clearVar,
     holToReal,
     holVF_coeffs,
-    listVar,
     realPartOfVF,
     scaleVF,
     symToReal,
@@ -46,6 +44,7 @@ from .dgcv_core import (
 from .polynomials import createMultigradedPolynomial
 from .solvers import solve_dgcv
 from .vector_fields_and_differential_forms import assembleFromHolVFC
+from .vmf import clearVar, listVar
 
 
 def tangencyObstruction(vf, CR_defining_expr, graph_variable, simplify=False, *args):
@@ -208,7 +207,7 @@ def findWeightedCRSymmetries_old(
             arg2,
             arg4,
             arg3,
-            "Akey",
+            Akey,
             _tempVar=retrieve_passkey(),
             degreeCap=degreeCap,
             assumeReal=True,
@@ -217,7 +216,7 @@ def findWeightedCRSymmetries_old(
                 arg2,
                 arg4,
                 arg3,
-                "Bkey",
+                Bkey,
                 _tempVar=retrieve_passkey(),
                 degreeCap=degreeCap,
                 assumeReal=True,

{dgcv-0.3.2 → dgcv-0.3.4}/src/dgcv/__init__.py

@@ -51,6 +51,20 @@ from ._dgcv_display import (
     show,
 )
 from ._settings import set_dgcv_settings
+from .algebras.algebras_aux import algebraDataFromMatRep, algebraDataFromVF
+from .algebras.algebras_core import (
+    adjointRepresentation,
+    algebra_class,
+    algebra_element_class,
+    algebra_subspace_class,
+    killingForm,
+)
+from .algebras.algebras_secondary import (
+    createAlgebra,
+    createFiniteAlg,  # deprecated
+    createSimpleLieAlgebra,
+    subalgebra_class,
+)
 from .combinatorics import carProd, chooseOp, permSign
 from .complex_structures import Del, DelBar, KahlerStructure
 from .coordinate_maps import coordinate_map
@@ -62,7 +76,6 @@ from .CR_geometry import (
 )
 from .dgcv_core import (
     DFClass,
-    DGCV_snapshot,  # deprecated
     DGCVPolyClass,  # deprecated
     STFClass,
     VF_bracket,
@@ -80,7 +93,6 @@ from .dgcv_core import (
     changeTFBasis,
     changeVFBasis,
     cleanUpConjugation,
-    clearVar,
     complex_struct_op,
     complexVFC,
     compress_dgcv_class,
@@ -98,7 +110,6 @@ from .dgcv_core import (
     holVF_coeffs,
     im_with_hol_coor,
     im_with_real_coor,
-    listVar,
     re_with_hol_coor,
     re_with_real_coor,
     realPartOfVF,
@@ -111,11 +122,7 @@ from .dgcv_core import (
     symToReal,
     tensor_product,
     tensorField,
-    variableSummary,
-    vmf_summary,
 )
-
-# EDS imports exposed at the top level
 from .eds import (
     DF_representation,
     abst_coframe,
@@ -132,17 +139,7 @@ from .eds import (
     transform_coframe,
     zeroFormAtom,
 )
-from .finite_dim_algebras import (
-    AlgebraElement,
-    FAClass,
-    adjointRepresentation,
-    algebraDataFromMatRep,
-    algebraDataFromVF,
-    algebraSubspace,
-    createClassicalLA,
-    createFiniteAlg,
-    killingForm,
-)
+from .filtered_structures import Tanaka_symbol, distribution
 from .polynomials import (
     createBigradPolynomial,
     createPolynomial,
@@ -156,7 +153,7 @@ from .Riemannian_geometry import (
 )
 from .solvers import solve_dgcv
 from .styles import get_DGCV_themes, get_dgcv_themes  # get_DGCV_themes is deprecated
-from .tensors import createVectorSpace, tensorProduct, vectorSpace, vectorSpaceElement
+from .tensors import createVectorSpace, tensorProduct, vector_space_element, vectorSpace
 from .vector_fields_and_differential_forms import (
     LieDerivative,
     annihilator,
@@ -171,6 +168,7 @@ from .vector_fields_and_differential_forms import (
     interiorProduct,
     makeZeroForm,
 )
+from .vmf import DGCV_snapshot, clearVar, listVar, variableSummary, vmf_summary
 
 # Default functions/classes
 __all__ = [
@@ -203,6 +201,19 @@ __all__ = [
     # From _config
     "canonicalize",         # Reformat supported objects canonically
 
+    # From algebras
+    "algebra_element_class",# Algebra element class
+    "algebra_subspace_class",     # Algebra subspace class
+    "algebra_class",        # Finite dimensional algebra
+    "adjointRepresentation",# Adjoint representation of algebra
+    "algebraDataFromMatRep",# Algebra data from matrix representation
+    "algebraDataFromVF",    # Algebra data from vector fields
+    "createFiniteAlg",      # deprecated
+    "createAlgebra",        # Create a finite dimensional algebra
+    "createSimpleLieAlgebra",
+    "killingForm",          # Compute the Killing form
+    "subalgebra_class",
+
     # From coordinateMaps
     "coordinate_map",       # Transforms coordinates systems
 
@@ -285,16 +296,9 @@ __all__ = [
     "DF_representation",
     "transform_coframe",
 
-    # From finiteDimAlgebras
-    "AlgebraElement",       # Algebra element class
-    "algebraSubspace",      # Algebra subspace class
-    "FAClass",              # Finite dimensional algebra class
-    "createClassicalLA",    # Initialize classicle simple L.A.
-    "adjointRepresentation",# Adjoint representation of algebra
-    "algebraDataFromMatRep",# Algebra data from matrix representation
-    "algebraDataFromVF",    # Algebra data from vector fields
-    "createFiniteAlg",      # Create a finite dimensional algebra
-    "killingForm",          # Compute the Killing form
+    # From filtered_structures
+    "distribution", 
+    "Tanaka_symbol",
 
     # From polynomials
     "createBigradPolynomial",# Create bigraded polynomial
@@ -316,7 +320,7 @@ __all__ = [
 
     # From tensors
     "vectorSpace",          # Class representing vector spaces
-    "vectorSpaceElement",   # Class representing elements in a vector space
+    "vector_space_element",   # Class representing elements in a vector space
     "tensorProduct",       # Class representing elements in tensor products (of VS elements)
                             # of vector space and their dual spaces
     "createVectorSpace",    # Create vectorSpace class instances with labeling

{dgcv-0.3.2 → dgcv-0.3.4}/src/dgcv/_config.py

@@ -183,14 +183,17 @@ variable_registry = {
         "real_part": StringifiedSymbolsDict(),
         "im_part": StringifiedSymbolsDict(),
     },
+    "_labels":{}
 }
 dgcv_settings_registry = {
     'use_latex':False,
     'theme':'blue',
     'format_displays':False,
-    'version_specific_defaults':f'v{__version__}'
+    'version_specific_defaults':f'v{__version__}',
+    'ask_before_overwriting_objects_in_vmf':True,
+    'forgo_warnings':False
 }
-# retrieval function for accessing variable_registry
+# retrieval functions for accessing and clearing registries
 def get_variable_registry():
     return variable_registry
 
@@ -198,7 +201,6 @@ def get_dgcv_settings_registry():
     return dgcv_settings_registry
 
 def clear_variable_registry():
-    # Optional: function to reset variable_registry if needed
     global variable_registry
     variable_registry = {
         "standard_variable_systems": {},

{dgcv-0.3.2 → dgcv-0.3.4}/src/dgcv/_dgcv_display.py

@@ -19,6 +19,7 @@ from IPython.display import HTML, Latex, display
 from sympy.printing.latex import LatexPrinter
 
 ############# dgcv classes to format
+from ._safeguards import check_dgcv_category, get_dgcv_category
 from .dgcv_core import (
     DFClass,
     STFClass,
@@ -29,7 +30,6 @@ from .dgcv_core import (
     tensorField,
 )
 from .filtered_structures import Tanaka_symbol
-from .finite_dim_algebras import AlgebraElement, FAClass
 from .Riemannian_geometry import metricClass
 
 
@@ -58,9 +58,9 @@ def LaTeX(obj, removeBARs=False):
                 return sp.latex(symToHol(term))
             else:
                 return sp.latex(term)
-        elif isinstance(term, FAClass):
-            return _alglabeldisplayclass(term.label)._repr_latex_()
-        elif isinstance(term, AlgebraElement):
+        elif get_dgcv_category(term) in {'algebra','algebra_element'}:
+            return term._repr_latex_()
+        elif get_dgcv_category(term)=='algebra_element':
             return _alglabeldisplayclass(term.algebra.label, term)._repr_latex_()
         elif isinstance(term, Tanaka_symbol):
             return "Tanaka_symbol Class"
@@ -68,16 +68,9 @@ def LaTeX(obj, removeBARs=False):
             return sp.latex(symToHol(term))
 
     def strip_dollar_signs(latex_str):
-        """Strip leading and trailing $ or $$ signs from a LaTeX string."""
-        # if latex_str == None:
-        #     return ''
         if latex_str is None:
             return latex_str
-        if latex_str.startswith("$$") and latex_str.endswith("$$"):
-            return latex_str[2:-2]
-        if latex_str.startswith("$") and latex_str.endswith("$"):
-            return latex_str[1:-1]
-        return latex_str
+        return latex_str.replace("$", "")
 
     if isinstance(obj, list):
         latex_elements = [strip_dollar_signs(filter(elem)) for elem in obj]
@@ -90,7 +83,6 @@ def LaTeX(obj, removeBARs=False):
         return r"\left\{ " + ", ".join(latex_elements) + r" \right\}"
 
     else:
-        # Apply sympy.latex() for non-list/tuple objects
         return strip_dollar_signs(filter(obj))
 
 def LaTeX_eqn_system(eqn_dict, math_mode = '$$', left_prefix = "", left_suffix = "", right_prefix = "", right_suffix = "", one_line = False, bare_latex = False, add_period = False):
@@ -157,13 +149,13 @@ def _display_DGCV_single(arg):
         display(Latex(arg))
     elif isinstance(
         arg,
-        (sp.Expr, metricClass, DFClass, VFClass, STFClass, tensorField, dgcvPolyClass, Tanaka_symbol),
+        (sp.Expr, metricClass, DFClass, VFClass, STFClass, tensorField, dgcvPolyClass, Tanaka_symbol) or check_dgcv_category(arg),
     ):
         _complexDisplay(arg)
-    elif isinstance(arg, FAClass):
-        _complexDisplay(_alglabeldisplayclass(arg.label))
-    elif isinstance(arg, AlgebraElement):
-        _complexDisplay(_alglabeldisplayclass(arg.algebra.label, ae=arg))
+    # elif get_dgcv_category(arg)=='algebra':
+    #     _complexDisplay(_alglabeldisplayclass(arg.label))
+    # elif get_dgcv_category(arg)=='algebra_element_class':
+    #     _complexDisplay(_alglabeldisplayclass(arg.algebra.label, ae=arg))
     else:
         display(arg)