Introduction
psymple is a package designed for general complex systems modelling. A complex system is a dynamic system whose interconnectivity produces non-trivial or unexpected behaviour. Examples of complex systems exist everywhere, from ecological systems, chemical reactions, economic systems, astronomy and even social networks.
The sections below give a wide introduction to the structure of psymple, why it exists, how to use it, and how to get involved.
Installation
psymple is a Python package currently supporting versions 3.10 and higher.
The latest version of psymple is available on PyPI and can be installed with pip.
psymple includes automated tests. More information can be found on the testing page.
Where to start
For most new users, going through the following resources in the suggested order will provide a good introduction to psymple.
-
Why psymple exists
Find out about the purpose and design principles of
psymple. -
Modelling in psymple
Learn how to capture functions and differential equations in
psymple, and combine these into complex models. -
Simulating models
Understand how to create and run simulations for
psymplemodels. -
Tutorials
Work through full examples of implementing, parametrising and simulating models.
-
The mathematics
Learn more about the mathematical structures underneath psymple which tie everything together.
-
Get involved
Find out how you can get involved in the community by using or developing
psymple.
Citing psymple
psymple has been peer-reviewed and published by the Journal of Open Source Software (JOSS).
The following link will take you to the article page on JOSS where you can also access the software paper, which provides more information on the background, development and context of psymple.
For more information, including how to cite psymple, please visit the citations page.