Metadata-Version: 2.4
Name: pycopancore
Version: 0.8.4
Summary: Reference implementation of the copan:CORE World-Earth modelling framework
Project-URL: Homepage, https://github.com/pik-copan/pycopancore
Project-URL: Issues, https://github.com/pik-copan/pycopancore/issues
Project-URL: Repository, https://github.com/pik-copan/pycopancore
Author-email: "COPAN team @ PIK" <core@pik-potsdam.de>
License: BSD 2-Clause License
        
        Copyright (c) 2016--2020, Potsdam Institute for Climate Impact Research,
        COPAN flagship project,
        Authors: Jobst Heitzig, Jonathan F. Donges, Wolfram Barfuss, Tim Kittel, 
        Jakob Kolb, Till Kolster, Svenja Uslu, Kilian Zimmerer, Johannes Kassel,
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: ABM,DGVM,World-Earth,framework,modelling
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.9
Requires-Dist: numba
Requires-Dist: numpy>=1.11.0
Requires-Dist: profilehooks
Requires-Dist: python-louvain>=0.9
Requires-Dist: scipy>=0.17.0
Requires-Dist: sympy>=1.0
Provides-Extra: dev
Requires-Dist: pylama; extra == 'dev'
Requires-Dist: pylama-pylint; extra == 'dev'
Requires-Dist: pylint; extra == 'dev'
Requires-Dist: pytest-cov>=2.5.1; extra == 'dev'
Requires-Dist: pytest>=4.6; extra == 'dev'
Description-Content-Type: text/markdown

# pycopancore

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14938316.svg)](https://doi.org/10.5281/zenodo.14938316)
[![CI](https://github.com/pik-copan/pycopancore/actions/workflows/check.yml/badge.svg)](https://github.com/pik-copan/pycopancore/actions)
[![PyPI version](https://badge.fury.io/py/pycopancore.svg)](https://badge.fury.io/py/pycopancore)

Reference implementation of the copan:CORE World-Earth modelling framework.

## Overview

pycopancore is a Python implementation of the copan:CORE modeling framework for building World-Earth (global social-ecological) models. The framework allows easy implementation of complex models by combining different environmental, social-metabolic, and cultural submodels using various modeling techniques including differential equations, stochastic and deterministic events.

## Installation

```bash
pip install pycopancore
```

### Documentation
Comprehensive documentation is available at: https://pik-copan.github.io/pycopancore

See [examples](./examples/) for examples on how to use the framework.

## Questions / Problems

In case of questions please contact core@pik-potsdam.de or [open an issue](https://github.com/pik-copan/pycopancore/issues/new).

## Contributing
Merge requests are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md).
For major changes, please open an issue first to discuss what you would like to
change.