Skip to main content

Implementation of MWP analysis on C code in Python.

Project description

pymwp: MWP analysis in Python

build codecov PyPI - Python Version PyPI DOI

pymwp is a tool for automatically performing static analysis on programs written in C. It is inspired by "A Flow Calculus of mwp-Bounds for Complexity Analysis". It analyzes resource usage and determines if a program's variables growth rates are no more than polynomially related to their inputs sizes. Try our online demo to see it action. For more details on usage and behavior, see pymwp documentation, particularly supported C language features.

Documentation and Demo

Refer to statycc.github.io/pymwp for a documentation, an online demo, and a presentation of examples.

Installation

Install the latest release from PyPI

pip install pymwp

How to Use

To analyze a C file, run:

pymwp path/to_some_file.c

For all available options and help, run:

pymwp --help

You can also use pymwp by importing it in a Python script:

from pymwp import Polynomial
from pymwp.matrix import identity_matrix, show

matrix = identity_matrix(3)
matrix[0][1] = Polynomial('m')
matrix[1][0] = Polynomial('w')
matrix[2][1] = Polynomial('p')

show(matrix)

See modules documentation for available methods.

Running from source

If you want to use the latest stable version (possibly ahead of latest release), use the version from source following these steps.

  1. Clone the repository

    git clone https://github.com/statycc/pymwp.git
    
  2. Set up Python environment (use venv)

    install required packages

    python -m pip install -r requirements.txt
    

    Note: for development purposes install dev dependencies instead:

    python -m pip install -r requirements-dev.txt
    
  3. Run the analysis

    From project root run:

    python -m pymwp path/to_some_file.c
    

    for example:

    python -m pymwp c_files/basics/if.c
    

    for all available options and help, run:

    python -m pymwp
    

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

pymwp-0.4.2.tar.gz (60.4 kB view hashes)

Uploaded Source

Built Distribution

pymwp-0.4.2-py3-none-any.whl (54.7 kB view hashes)

Uploaded Python 3

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