From 319f74a89c4853be17f294cf613653e29a81bfc0 Mon Sep 17 00:00:00 2001 From: "Joshua E. Jodesty" Date: Tue, 24 Sep 2019 20:22:01 -0400 Subject: [PATCH 1/3] documentation is important for contributors . . . --- README.md | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4d85680..7e832bf 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,32 @@ by BlockScience ***cadCAD*** is a Python package that assists in the processes of designing, testing and validating complex systems through simulation, with support for Monte Carlo methods, A/B testing and parameter sweeping. # Getting Started -## 1. Install cadCAD -cadCAD requires [Python 3](https://www.python.org/downloads/) -cadCAD can be installed using Python’s package manager, [pip](https://pypi.org/project/cadCAD/) -```bash -pip install cadCAD -``` -## 2. Learn the basics -Check out our tutorials (available both as [Jupyter Notebooks](tutorials) and [videos](https://www.youtube.com/watch?v=uJEiYHRWA9g&list=PLmWm8ksQq4YKtdRV-SoinhV6LbQMgX1we)) to familiarize yourself with some system modelling concepts and cadCAD terminology. Alternatively, go straight to the [documentation](documentation). +## 1. Installation: +Requires [Python 3](https://www.python.org/downloads/) -## 3. Connect +**Option A: Install Using [pip](https://pypi.org/project/cadCAD/)** +```bash +pip3 install cadCAD +``` + +**Option B:** Build From Source +``` +pip3 install -r requirements.txt +python3 setup.py sdist bdist_wheel +pip3 install dist/*.whl +``` + + +## 2. Learn the basics +**Tutorials:** available both as [Jupyter Notebooks](tutorials) and [videos](https://www.youtube.com/watch?v=uJEiYHRWA9g&list=PLmWm8ksQq4YKtdRV-SoinhV6LbQMgX1we) + +Familiarize yourself with some system modelling concepts and cadCAD terminology. + +## 3. Documentation: +* [System Model Configuration](documentation/Simulation_Configuration.md) +* [System Simulation Execution](documentation/Simulation_Execution.md) +* [Policy Aggregation](documentation/Policy_Aggregation.md) +* [System Model Parameter Sweep](documentation/System_Model_Parameter_Sweep.md) + +## 4. Connect Find other cadCAD users at our [Discourse](https://community.cadcad.org/). We are a small but rapidly growing community. From 422b0fb6710d7c5a05e8e3f128c34df9bb5b60ea Mon Sep 17 00:00:00 2001 From: "Joshua E. Jodesty" Date: Thu, 26 Sep 2019 09:16:20 -0400 Subject: [PATCH 2/3] documentation & build from source is important for contributors --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e832bf..bcc964e 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,8 @@ pip3 install dist/*.whl ## 2. Learn the basics -**Tutorials:** available both as [Jupyter Notebooks](tutorials) and [videos](https://www.youtube.com/watch?v=uJEiYHRWA9g&list=PLmWm8ksQq4YKtdRV-SoinhV6LbQMgX1we) +**Tutorials:** available both as [Jupyter Notebooks](tutorials) +and [videos](https://www.youtube.com/watch?v=uJEiYHRWA9g&list=PLmWm8ksQq4YKtdRV-SoinhV6LbQMgX1we) Familiarize yourself with some system modelling concepts and cadCAD terminology. From c326f3c8c0d2dcac40832a85650cf77972549318 Mon Sep 17 00:00:00 2001 From: "Joshua E. Jodesty" Date: Thu, 26 Sep 2019 14:57:00 -0400 Subject: [PATCH 3/3] docs --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bcc964e..4315183 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,19 @@ ``` - __________ ____ + __________ ____ ________ __ _____/ ____/ | / __ \ / ___/ __` / __ / / / /| | / / / / -/ /__/ /_/ / /_/ / /___/ ___ |/ /_/ / -\___/\__,_/\__,_/\____/_/ |_/_____/ +/ /__/ /_/ / /_/ / /___/ ___ |/ /_/ / +\___/\__,_/\__,_/\____/_/ |_/_____/ by BlockScience +====================================== + Complex Adaptive Dynamics + o i e + m d s + p e i + u d g + t n + e + r ``` ***cadCAD*** is a Python package that assists in the processes of designing, testing and validating complex systems through simulation, with support for Monte Carlo methods, A/B testing and parameter sweeping.