Merge pull request #120 from ECSIM/develop

Version 1.1
ECSIM · Jul 5, 2019 · c480893 · c480893
2 parents cda0e8a + 77f6ed4
commit c480893
Show file tree

Hide file tree

Showing 60 changed files with 1,513 additions and 639 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -18,7 +18,10 @@ matrix:
         - os: linux
           python: 3.4
           env: TOXENV=py34-linux
-
+    allow_failures:
+        - os: linux
+          python: 3.4
+          env: TOXENV=py34-linux
 install: 
   - bash .travis/install.sh
 

diff --git a/.travis/test.sh b/.travis/test.sh
@@ -6,7 +6,11 @@ set -x
 python -m opem test
 pip install -r dev-requirements.txt
 python version_check.py
-python -m bandit -r opem -s B322
-python -m vulture --min-confidence 80 --exclude=opem,build,.eggs --sort-by-size .
+if [ "$TRAVIS_PYTHON_VERSION" = '3.6' ]
+then
+	python -m bandit -r opem -s B322
+	python -m vulture --min-confidence 80 --exclude=opem,build,.eggs --sort-by-size .
+	python -m pydocstyle
+fi
 python -m pytest opem/Test --cov=opem --cov-report=term
 python -m cProfile -s cumtime opem/Profile.py
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [1.1] - 2019-07-05
+### Added
+- MATLAB examples
+### Changed
+- Menu updated
+- Test system modified
+- Docstrings modified
+- Drop Python 3.4 support
+- `description_control` function modified
+- `version_check.py` modified
+- `README.md` modified
+- Padulles-Amphlett model import bug fixed
+- `dev-requirements.txt` modified
+- Website switched to HTTPS
 ## [1.0] - 2019-03-01
 ### Added
 - Interactive notebooks section
@@ -136,7 +150,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - CSV output files
 - Documents and `README.md`
 
-[Unreleased]: https://github.com/ECSIM/opem/compare/v1.0...develop
+[Unreleased]: https://github.com/ECSIM/opem/compare/v1.1...develop
+[1.1]: https://github.com/ECSIM/opem/compare/v1.0...v1.1
 [1.0]: https://github.com/ECSIM/opem/compare/v0.9...v1.0
 [0.9]: https://github.com/ECSIM/opem/compare/v0.8...v0.9
 [0.8]: https://github.com/ECSIM/opem/compare/v0.7...v0.8

diff --git a/Documents/Amphlett.ipynb b/Documents/Amphlett.ipynb
@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Version 1.0"
+    "### Version 1.1"
    ]
   },
   {
@@ -2924,13 +2924,7 @@
       "Power-Thermal : 8.493335953702141 W\n",
       "VStack : 0.7024636053601154 V\n",
       "Vcell : 0.7024636053601154 V\n",
-      "###########\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
+      "###########\n",
       "I : 16.2\n",
       "Enernst : 1.19075 V\n",
       "Eta Activation : 0.45501182313078914 V\n",
@@ -3167,7 +3161,13 @@
       "###########\n",
       "I : 18.0\n",
       "Enernst : 1.19075 V\n",
-      "Eta Activation : 0.4619896340937498 V\n",
+      "Eta Activation : 0.4619896340937498 V\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "Eta Concentration : 0.004331188797162155 V\n",
       "Eta Ohmic : 0.033657389798262084 V\n",
       "Loss : 0.4999782126891741 V\n",
@@ -4665,15 +4665,15 @@
       "Eta Activation : 0.49470746697174134 V\n",
       "Eta Concentration : 0.007873875602709995 V\n",
       "Eta Ohmic : 0.05818741474966191 V\n",
-      "Loss : 0.5607687573241132 V\n"
+      "Loss : 0.5607687573241132 V\n",
+      "PEM Efficiency : 0.4038341299204402 \n",
+      "Power : 18.58444665893866 W\n"
      ]
     },
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "PEM Efficiency : 0.4038341299204402 \n",
-      "Power : 18.58444665893866 W\n",
       "Power-Stack : 18.58444665893866 W\n",
       "Power-Thermal : 17.70055334106134 W\n",
       "VStack : 0.6299812426758867 V\n",
@@ -6172,13 +6172,7 @@
       "Power-Stack : 23.595548949831908 W\n",
       "Power-Thermal : 26.83445105016809 W\n",
       "VStack : 0.5755011938983392 V\n",
-      "Vcell : 0.5755011938983392 V\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
+      "Vcell : 0.5755011938983392 V\n",
       "###########\n",
       "I : 41.1\n",
       "Enernst : 1.19075 V\n",
@@ -6678,7 +6672,13 @@
       "Enernst : 1.19075 V\n",
       "Eta Activation : 0.5225263538790852 V\n",
       "Eta Concentration : 0.014326871678663006 V\n",
-      "Eta Ohmic : 0.09690480653515815 V\n",
+      "Eta Ohmic : 0.09690480653515815 V\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "Loss : 0.6337580320929063 V\n",
       "PEM Efficiency : 0.357046133273778 \n",
       "Power : 25.008939359028506 W\n",
@@ -8178,13 +8178,7 @@
       "PEM Efficiency : 0.3200219430388025 \n",
       "Power : 28.156810636325996 W\n",
       "Power-Stack : 28.156810636325996 W\n",
-      "Power-Thermal : 41.215189363674 W\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
+      "Power-Thermal : 41.215189363674 W\n",
       "VStack : 0.4992342311405319 V\n",
       "Vcell : 0.4992342311405319 V\n",
       "###########\n",
@@ -8578,7 +8572,13 @@
       "VStack : 0.48278539672234544 V\n",
       "Vcell : 0.48278539672234544 V\n",
       "###########\n",
-      "I : 59.5\n",
+      "I : 59.5\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "Enernst : 1.19075 V\n",
       "Eta Activation : 0.5411720727592413 V\n",
       "Eta Concentration : 0.024514165593142897 V\n",
@@ -10134,13 +10134,7 @@
       "PEM Efficiency : 0.25801990173588574 \n",
       "Power : 28.739288734949902 W\n",
       "Power-Stack : 28.739288734949902 W\n",
-      "Power-Thermal : 59.08271126505011 W\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
+      "Power-Thermal : 59.08271126505011 W\n",
       "VStack : 0.40251104670798177 V\n",
       "Vcell : 0.40251104670798177 V\n",
       "###########\n",
@@ -10189,7 +10183,13 @@
       "Eta Concentration : 0.0466948753710611 V\n",
       "Eta Ohmic : 0.19154751209298052 V\n",
       "Loss : 0.7918592326803244 V\n",
-      "PEM Efficiency : 0.2556992098203048 \n",
+      "PEM Efficiency : 0.2556992098203048 \n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "Power : 28.6403570935527 W\n",
       "Power-Stack : 28.6403570935527 W\n",
       "Power-Thermal : 59.67364290644729 W\n",
@@ -10599,13 +10599,7 @@
       "VStack : 0.3594162255435345 V\n",
       "Vcell : 0.3594162255435345 V\n",
       "###########\n",
-      "Report is generating ...\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
+      "Report is generating ...\n",
       "Done!\n"
      ]
     }
@@ -10704,21 +10698,21 @@
      "output_type": "stream",
      "text": [
       "Requirement already satisfied: matplotlib in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (2.2.2)\n",
-      "Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2.2.0)\n",
       "Requirement already satisfied: pytz in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2018.3)\n",
-      "Requirement already satisfied: cycler>=0.10 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (0.10.0)\n",
       "Requirement already satisfied: numpy>=1.7.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.15.2)\n",
+      "Requirement already satisfied: cycler>=0.10 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (0.10.0)\n",
+      "Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2.2.0)\n",
+      "Requirement already satisfied: six>=1.10 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.11.0)\n",
       "Requirement already satisfied: python-dateutil>=2.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2.6.1)\n",
       "Requirement already satisfied: kiwisolver>=1.0.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.0.1)\n",
-      "Requirement already satisfied: six>=1.10 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.11.0)\n",
       "Requirement already satisfied: setuptools in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from kiwisolver>=1.0.1->matplotlib) (39.2.0)\n"
      ]
     },
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "You are using pip version 19.0.2, however version 19.0.3 is available.\n",
+      "You are using pip version 19.0.2, however version 19.1.1 is available.\n",
       "You should consider upgrading via the 'python -m pip install --upgrade pip' command.\n"
      ]
     }

diff --git a/Documents/Amphlett/Amphlett_Test.html b/Documents/Amphlett/Amphlett_Test.html
@@ -576,6 +576,6 @@ <h2 style="color:#ff7600;">Graphs</h2>
     }
 });
 </script>
-<p style="text-align:center;position:absoloute;border-top:1px solid black;">Generated By <a style="text-decoration:none;color:#ff7600;" href="http://opem.ecsim.ir">OPEM</a> Version 1.0</p>
+<p style="text-align:center;position:absoloute;border-top:1px solid black;">Generated By <a style="text-decoration:none;color:#ff7600;" href="http://opem.ecsim.ir">OPEM</a> Version 1.1</p>
 </body>
 </html>
diff --git a/Documents/Amphlett/Amphlett_Test.opem b/Documents/Amphlett/Amphlett_Test.opem
@@ -4,7 +4,7 @@
 | |_| || |_) ||  __/| | | | | |
  \___/ | .__/  \___||_| |_| |_|
        |_|                     
-Simulation Date : 2019-02-22 18:14:50.082164
+Simulation Date : 2019-06-27 16:12:08.124984
 **********
 Amphlett Model
 

diff --git a/Documents/Chamberline-Kim/Chamberline_Test.html b/Documents/Chamberline-Kim/Chamberline_Test.html
@@ -489,6 +489,6 @@ <h2 style="color:#ff7600;">Graphs</h2>
     }
 });
 </script>
-<p style="text-align:center;position:absoloute;border-top:1px solid black;">Generated By <a style="text-decoration:none;color:#ff7600;" href="http://opem.ecsim.ir">OPEM</a> Version 1.0</p>
+<p style="text-align:center;position:absoloute;border-top:1px solid black;">Generated By <a style="text-decoration:none;color:#ff7600;" href="http://opem.ecsim.ir">OPEM</a> Version 1.1</p>
 </body>
 </html>
diff --git a/Documents/Chamberline-Kim/Chamberline_Test.opem b/Documents/Chamberline-Kim/Chamberline_Test.opem
@@ -4,7 +4,7 @@
 | |_| || |_) ||  __/| | | | | |
  \___/ | .__/  \___||_| |_| |_|
        |_|                     
-Simulation Date : 2019-02-22 18:15:06.881226
+Simulation Date : 2019-06-27 16:12:35.047311
 **********
 Chamberline-Kim Model
 

diff --git a/Documents/Chamberline_Kim.ipynb b/Documents/Chamberline_Kim.ipynb
@@ -11,7 +11,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Version 1.0"
+    "### Version 1.1"
    ]
   },
   {
@@ -2398,7 +2398,13 @@
       "I : 25.3\n",
       "PEM Efficiency : 0.5436247354183059 \n",
       "Power : 21.455781057489702 W\n",
-      "Power-Stack : 21.455781057489702 W\n",
+      "Power-Stack : 21.455781057489702 W\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "Power-Thermal : 9.6632189425103 W\n",
       "VStack : 0.8480545872525573 V\n",
       "Vcell : 0.8480545872525573 V\n",
@@ -2884,13 +2890,7 @@
       "Vcell : 0.7625933754626701 V\n",
       "###########\n",
       "I : 31.4\n",
-      "PEM Efficiency : 0.4877136025324792 \n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
+      "PEM Efficiency : 0.4877136025324792 \n",
       "Power : 23.89016310645096 W\n",
       "Power-Stack : 23.89016310645096 W\n",
       "Power-Thermal : 14.731836893549037 W\n",
@@ -3882,21 +3882,21 @@
      "output_type": "stream",
      "text": [
       "Requirement already satisfied: matplotlib in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (2.2.2)\n",
+      "Requirement already satisfied: pytz in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2018.3)\n",
       "Requirement already satisfied: six>=1.10 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.11.0)\n",
+      "Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2.2.0)\n",
+      "Requirement already satisfied: cycler>=0.10 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (0.10.0)\n",
       "Requirement already satisfied: python-dateutil>=2.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2.6.1)\n",
-      "Requirement already satisfied: kiwisolver>=1.0.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.0.1)\n",
       "Requirement already satisfied: numpy>=1.7.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.15.2)\n",
-      "Requirement already satisfied: cycler>=0.10 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (0.10.0)\n",
-      "Requirement already satisfied: pytz in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2018.3)\n",
-      "Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (2.2.0)\n",
+      "Requirement already satisfied: kiwisolver>=1.0.1 in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from matplotlib) (1.0.1)\n",
       "Requirement already satisfied: setuptools in c:\\users\\sepkjaer\\appdata\\local\\programs\\python\\python35-32\\lib\\site-packages (from kiwisolver>=1.0.1->matplotlib) (39.2.0)\n"
      ]
     },
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "You are using pip version 19.0.2, however version 19.0.3 is available.\n",
+      "You are using pip version 19.0.2, however version 19.1.1 is available.\n",
       "You should consider upgrading via the 'python -m pip install --upgrade pip' command.\n"
      ]
     }

diff --git a/Documents/Larminie-Dicks/Larminiee_Test.html b/Documents/Larminie-Dicks/Larminiee_Test.html
@@ -494,6 +494,6 @@ <h2 style="color:#ff7600;">Graphs</h2>
     }
 });
 </script>
-<p style="text-align:center;position:absoloute;border-top:1px solid black;">Generated By <a style="text-decoration:none;color:#ff7600;" href="http://opem.ecsim.ir">OPEM</a> Version 1.0</p>
+<p style="text-align:center;position:absoloute;border-top:1px solid black;">Generated By <a style="text-decoration:none;color:#ff7600;" href="http://opem.ecsim.ir">OPEM</a> Version 1.1</p>
 </body>
 </html>
diff --git a/Documents/Larminie-Dicks/Larminiee_Test.opem b/Documents/Larminie-Dicks/Larminiee_Test.opem
@@ -4,7 +4,7 @@
 | |_| || |_) ||  __/| | | | | |
  \___/ | .__/  \___||_| |_| |_|
        |_|                     
-Simulation Date : 2019-02-22 18:15:23.916245
+Simulation Date : 2019-06-27 16:12:56.703714
 **********
 Larminie-Dicks Model