Updated DDY and EPW files from energyplus web page, ci-skip functiona…

…lity. (#160) * Updated DDY and EPW files from energyplus web page - fixes #137 * Solved label bug in feature request issue template * Skip pull request ci-checks when string is present in commit message #161 * Updated Sinergym version from 1.7.5 to 1.7.6 [ci skip] * Updated tests with new EPW names and DDY parameters * Added note box with ci skip functionality in Sinergym workflow documentation * trying solve issue #159 * trying solve issue #159 again
ugr-sail · Feb 15, 2022 · 14bbc82 · 14bbc82
1 parent 011c941
commit 14bbc82
Show file tree

Hide file tree

Showing 20 changed files with 11,215 additions and 18,434 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -2,7 +2,7 @@
 name: "Feature request \U0001F680"
 about: Suggest an idea for this project
 title: "[Feature]:"
-labels: Feature Request
+labels: Feature request
 assignees: ''
 
 ---
@@ -33,5 +33,5 @@ Add any other context or screenshots about the feature request here.
 
 - [ ] I have checked that there is no similar [issue](https://github.com/jajimer/sinergym/issues) in the repo (**required**)
 
-:pencil: Please, don't forget to include more labels besides `Feature Request` if it is necessary.
+:pencil: Please, don't forget to include more labels besides `Feature request` if it is necessary.
 <!--- This Template is an edited version of the one from https://github.com/DLR-RM/stable-baselines3 -->
diff --git a/.github/workflows/create_pr.yml b/.github/workflows/create_pr.yml
@@ -4,6 +4,8 @@ on: pull_request
 jobs:
 
   format-check:
+    # Skip CI if [ci skip] in the commit message
+    if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -39,6 +41,8 @@ jobs:
       #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   type-check:
+    # Skip CI if [ci skip] in the commit message
+    if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -56,6 +60,8 @@ jobs:
         run: pytype -d import-error sinergym/
 
   documentation-check:
+    # Skip CI if [ci skip] in the commit message
+    if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -86,6 +92,8 @@ jobs:
         run: "cd docs && sphinx-build -M spelling source build -W"
 
   tests:
+    # Skip CI if [ci skip] in the commit message
+    if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
     name: build container and execute pytest
     runs-on: ubuntu-latest
     steps:

diff --git a/.github/workflows/create_release.yml b/.github/workflows/create_release.yml
@@ -56,8 +56,12 @@ jobs:
       #       version:
       #         - 'sinergym/version.txt'
 
+      - name: Preparing dist directory
+        if: ${{ env.PYPI_USER != '' && env.PYPI_API_TOKEN != '' }}
+        run: python setup.py sdist
+
       - name: Publish a Python distribution to PyPi
-        if: ${{ env.PYPI_USER != '' && env.PYPI_API_TOKEN != '' }} && steps.verify-version-update.outputs.version == 'true'
+        if: ${{ env.PYPI_USER != '' && env.PYPI_API_TOKEN != '' }}
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: ${{ env.PYPI_USER }}

diff --git a/docs/source/pages/github-actions.rst b/docs/source/pages/github-actions.rst
@@ -34,6 +34,8 @@ Pull Request
 - **Testing**: There is another action which builds a remote container using *Dockerfile* and executes pytest inner.
 - **Repository security**: There is a workflow which compare differences in workflows and tests from source to base. It execute that functionality only in forked repositories in order to prevent malicious software in workflow or ignore tests. Event is *pull_request_target*, this means workflow is checkout from base repository (our main branch) and it cannot be manipulate by third-parties.
 
+.. note:: These checks can be skipped in a specific commit writing `[ci skip]` string in commit message. For more information, see issue `#161 <https://github.com/jajimer/sinergym/issues/161>`__.
+
 ************************************
 Push main (or merge a pull request)
 ************************************

diff --git a/sinergym/__init__.py b/sinergym/__init__.py
@@ -29,7 +29,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': True,
@@ -44,7 +44,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': True,
@@ -57,7 +57,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': True,
@@ -70,7 +70,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': True,
@@ -86,7 +86,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': True,
@@ -103,7 +103,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': True,
@@ -120,7 +120,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': False,
@@ -135,7 +135,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': False,
@@ -148,7 +148,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': False,
@@ -161,7 +161,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': False,
@@ -177,7 +177,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': False,
@@ -194,7 +194,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '5ZoneAutoDXVAV.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesDXVAV.cfg',
         'spaces_file': '5ZoneAutoDXVAV_spaces.cfg',
         'discrete_actions': False,
@@ -212,7 +212,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': True,
@@ -227,7 +227,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': False,
@@ -242,7 +242,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': True,
@@ -258,7 +258,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_AZ_Tucson-Davis-Monthan.AFB.722745_TMY3.epw',
+        'weather_file': 'USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': False,
@@ -274,7 +274,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': True,
@@ -287,7 +287,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': False,
@@ -300,7 +300,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': True,
@@ -317,7 +317,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': '2ZoneDataCenterHVAC_wEconomizer.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesDataCenter.cfg',
         'spaces_file': '2ZoneDataCenterHVAC_wEconomizer_spaces.cfg',
         'discrete_actions': False,
@@ -336,7 +336,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': True,
@@ -349,7 +349,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': True,
@@ -366,7 +366,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': False,
@@ -379,7 +379,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_NY_New.York-Kennedy.Intl.AP.744860_TMY3.epw',
+        'weather_file': 'USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': False,
@@ -396,7 +396,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': True,
@@ -409,7 +409,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': True,
@@ -426,7 +426,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': False,
@@ -439,7 +439,7 @@
     entry_point='sinergym.envs:EplusEnv',
     kwargs={
         'idf_file': 'IW_Mullion.idf',
-        'weather_file': 'USA_WA_Port.Angeles-Fairchild.Intl.AP.727885_TMY3.epw',
+        'weather_file': 'USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw',
         'variables_file': 'variablesIW.cfg',
         'spaces_file': 'IW_Mullion_spaces.cfg',
         'discrete_actions': False,