Metadata-Version: 2.3
Name: qmm-core
Version: 0.2.32
Summary: A software platform for analysing the structure and function of complex systems
Project-URL: Homepage, https://github.com/jaydenhyman/qmm
Project-URL: Bug Tracker, https://github.com/jaydenhyman/qmm/issues
Author-email: Jayden Hyman <j.hyman@uq.edu.au>
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Requires-Dist: matplotlib>=3.9.2
Requires-Dist: networkx>=2.6.3
Requires-Dist: numba>=0.60.0
Requires-Dist: numpy<1.28,>=1.26.4
Requires-Dist: pandas>=2.2.3
Requires-Dist: pytest>=8.3.2
Requires-Dist: seaborn>=0.13.2
Requires-Dist: sphinx
Requires-Dist: sphinx-rtd-theme
Requires-Dist: sympy>=1.11.1
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Description-Content-Type: text/markdown

# Qualitative Mathematical Modelling (QMM) in Python

[![Python Version](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

![QMM Logo](logo.png)

Qualitative Mathematical Modelling (QMM) is a method for analysing the structure of complex systems where general causal relationships are known but precise quantitative data are lacking. By utilising networks (signed digraphs) to visualise system structure, QMM enables users to build models of real-world systems and generate testable predictions of system response to perturbations.

## Features

- Python package (`qmm`) for qualitative mathematical modelling, including core modules for defining model structure, stability analysis, perturbation analysis and making qualitative predictions.
- Integration with an interactive web application for creating signed digraph (network) models representing the mathematical structure of a complex system.

## Quick start

1. Install using pip: ```pip install qmm-core```.
2. Create a model using the [web application](https://dev.d1u6yx7pe96k0m.amplifyapp.com/).
3. Analyse your model in Python. See `qmm.ipynb` for a complete tutorial and example.

## Documentation

Detailed documentation for the `qmm` package and its modules is not currently available.

## Licensing

This project is licensed under the BSD 3-Clause License and is **free** and **open source**.

## Contact

Jayden Hyman - <j.hyman@uq.edu.au>

## Contributing

We welcome contributions to improve and expand the QMM software. As the project is in its early stages of development, we appreciate your patience and support in helping us refine the software.
