Metadata-Version: 2.1
Name: pmxutils
Version: 0.0.3.1
Summary: Collection of tools for programmation and modeling X
Home-page: https://github.com/Areskiko/stefan-tools
Author: Stefan Mack
Author-email: stefan_mack@hotmail.com
License: UNKNOWN
Description: # PMXUtils
        
        Tools for ProgModX
        
        Note that the package is in development and may undergo frequent updates
        
        Install with `python -m pip install pmxutils` for windows and `python3 -m pip install pmxutils` for unix/linux
        
        # Table of content
        * [Mathtools](https://github.com/Areskiko/pmxutils/blob/master/README.md#mathtools-pmxutilsmathtools)
          * [construct](https://github.com/Areskiko/pmxutils/blob/master/README.md#constructexpression-varx)
          * [computeList](https://github.com/Areskiko/pmxutils/blob/master/README.md#computelistsfunctionlow-high-step1)
          * [newton](https://github.com/Areskiko/pmxutils/blob/master/README.md#newtonfunction-derivative-tolerance1e-8-rounding--3-iterations--1000)
          * [isInbetween](https://github.com/Areskiko/pmxutils/blob/master/README.md#isinbetweennumber-limone-limtwo)
        * [Other](https://github.com/Areskiko/pmxutils/blob/master/README.md#other-pmxutilsother)
          * [loading](https://github.com/Areskiko/pmxutils/blob/master/README.md#loading)
            * [start](https://github.com/Areskiko/pmxutils/blob/master/README.md#startflavorloading)
            * [stop](https://github.com/Areskiko/pmxutils/blob/master/README.md#stop)
            * [animate](https://github.com/Areskiko/pmxutils/blob/master/README.md#animate)
        
        ## Mathtools (`pmxutils.mathtools`)
        
        * #### `construct(expression, var=x)`
            >Returns a function computing the given expression
            
            * `expression` - The mathematical expression to compute, type = string
            * `var` - The variable used in the mathematical expression, defaults tp 'x', type = string
        
        * #### `computeLists(function,low, high, step=1)`
            >Returns a touple of two lists containing x values inbetween low and high, and the computed results for y. In the format of (x_list, y_list)
            
            * `low` - The lower end of the function limit, type = number
            * `high` - The upper end of the function limit, type = number
            * `function` - The mathematical expression to use for y value computation, type = string or function from construct
            * `step` - The step size in the x value list, defaults to '1', type = number
        
        * #### `newton(function, derivative, limOne, limTwo, tolerance=1e-8, rounding = 3, iterations = 1000)`
            >Uses Newtons way of finding the root of a function, using the function and its derivative, within the given limits.Returns None if it can't find a solution that satisfies the tolerance after the defined number of terations
            
            * `function` - The target mathematical expression, type = string or function from construct
            * `derivative` - The derivative of the target mathematical expression, type = string or function from construct
            * `limOne` - The lower end of the are which should be checked for roots, type = number
            * `limTwo` - The upper end of the are which should be checked for roots, type = number
            * `tolerance` - The tolerance for error to speed up computation, defaults to '1e-8', type = number
            * `rounding` - Rounds the x value for the root to the specified amount of decimals, defaults to '3', type = number
            * `iterations` - The number of tries, after which the function will end early
        
        * #### `isInbetween(number, limOne, limTwo)`
            >Returns True if number is inbetween limOne and limTwo, returns False otherwise
            
            * `number` - The number to be checked, type = number
            * `limOne` - The lower limit for which the number is checked, type = number
            * `limTwo` - The upper limit for which the number is checked, tyoe = number
        
        ## Other (`pmxutils.other`)
        
        ### `loading()`
        Loading class
            
        * #### `start(flavor="loading")`
            >Starts a loading sequence
                
            * `flavor` - The message to be displayed during loading, defaults to 'loading', type = string
        * #### `stop()`
            >Stops the loading sequence
                
        * #### `animate()`
            >DO NOT USE, internal function
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
