diff --git a/README.md b/README.md index 69d2bab2092a1a7535e463b8ddd13b2cda64336a..1766e28fbe541fa76b3b262503ce2edd253eadd2 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ # Pydynamo Pydynamo is a module to define, run and analyse system dynamics. -It was originally created to run the World3 model [2], written in DYNAMO language [1]. Included in the module are functions to convert DYNAMO code to pydynamo syntax. All scenarios of *Limits to Growth* are shown in [LimitsToGrowth72](./examples/LimitsToGrowth72.ipynb). +It was originally created to run the World3 model [2], written in DYNAMO language [1]. Included in the module are functions to convert DYNAMO code to pydynamo syntax. All scenarios of *Limits to Growth*, updated with 2003 version, are shown in [LimitsToGrowth03](./examples/LimitsToGrowth03.ipynb). -Documentation about world3 is in <https://abaucher.gitlabpages.inria.fr/pydynamo/> ! +Documentation about the World models is in <https://abaucher.gitlabpages.inria.fr/pydynamo/> ! # Installation - clone this repository and got to folder - python -m pip install -r requirements.txt - you can import pydynamo +# Note +_This is a beta version and all documentation and commands may not be complete or updated_ + # Usage (see [BTmodel](./examples/BTmodel.ipynb) for example) - Define the system equations in a function or file with pydynamo syntax - Get a System object from this function or file