Merge pull request #619 from IN-CORE/release-1.20.0

Release 1.20.0

Author: ywkim312

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 180
+extend-ignore = E203
+exclude = __init__.py

.github/workflows/conda.yaml

@@ -18,7 +18,7 @@ jobs:
         shell: bash -l {0}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: get release info
         id: release_info
@@ -40,7 +40,7 @@ jobs:
           fi
 
       - name: Cache conda
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         env:
           # Increase this value to reset cache if environment.yml has not changed
           CACHE_NUMBER: 0

.github/workflows/doc.yaml

@@ -29,7 +29,7 @@ jobs:
 
     steps:
       # checkout source code
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       # calculate some variables that are used later
       - name: version information
@@ -84,4 +84,4 @@ jobs:
           username: ${{ secrets.HUB_USERNAME }}
           password: ${{ secrets.HUB_PASSWORD }}
           tags: "${{ env.TAGS }}"
-          buildargs: BRANCH,VERSION,BUILDNUMBER,GITSHA1
+          buildargs: BRANCH,VERSION,BUILDNUMBER,GITSHA1

.github/workflows/pypi.yaml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: get release info
         id: release_info
@@ -50,7 +50,7 @@ jobs:
           pip install -r requirements.txt
 
       - name: Cache pip
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           # This path is specific to Ubuntu
           path: ~/.cache/pip
@@ -66,7 +66,7 @@ jobs:
 
       - name: Publish distribution to PyPI
         if: github.event_name == 'release'
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ env.TOKEN }}
           repository_url: ${{ env.REPO_URL }}

.github/workflows/pytests.yml

@@ -19,10 +19,10 @@ jobs:
     name: Python ${{ matrix.vars.python-version }} Test
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Cache conda
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         env:
           # Increase this value to reset cache if environment.yml has not changed
           CACHE_NUMBER: 0

.github/workflows/requirements.yaml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # check all requirements
       - name: requirements check

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+exclude: 'pyincore/analyses/(joplincge|saltlakecge|seasidecge|galvestoncge)/.*|docs/*'

CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+
+## [1.20.0] - 2024-10-24
+
+### Fixed
+- Fixed Sphinx autodoc skipping class methods with custom decorators. [#518](https://github.com/IN-CORE/pyincore/issues/518)
+- Pyomo version fixed to fix indp solver failure [#585](https://github.com/IN-CORE/pyincore/issues/585)
+- Uploaded raster files doesn't respect the order [#614](https://github.com/IN-CORE/pyincore/issues/614)
+- Fixed the pypi publish of the package [#621](https://github.com/IN-CORE/pyincore/issues/621)
+
+### Changed
+- Support Interdependent recovery of residential buildings and households [#606](https://github.com/IN-CORE/pyincore/pull/606)
+- Remove unused insecure IN-CORE client [#581](https://github.com/IN-CORE/pyincore/issues/581)
+- Update GH actions to use the latest version [#623](https://github.com/IN-CORE/pyincore/issues/623)
+
+### Added
+- Apply Black formatter [#589](https://github.com/IN-CORE/pyincore/issues/589)
+- Equity Metric Analysis [#608](https://github.com/IN-CORE/pyincore/issues/608)
+- Internal client connecting to the IN-CORE services [#609](https://github.com/IN-CORE/pyincore/issues/609)
+- MlEnabledCgeJoplin analysis with documentation [#588](https://github.com/IN-CORE/pyincore/issues/588)
+
+
 ## [1.19.0] - 2024-06-12
 
 ### Changed

README.rst

@@ -47,7 +47,8 @@ Please use pip for installing pyincore at your discretion.
 **Prerequisite**
 
 * GDAL C library must be installed to install pyincore. (for Ubuntu, **gdal-bin** and **libgdal-dev**)
-* ipopt executable must be installed to run some analyses such as seaside CGE, joplin CGE, etc. 
+* ipopt executable must be installed to run some analyses such as seaside CGE, joplin CGE, etc.
+* For developers, pre-install must be installed. If not, run `brew install pre-commit` or `pip install pre-commit`.
 
 To install **pyincore** package, run
 

docs/source/conf.py

@@ -20,22 +20,22 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../..'))
-sys.path.insert(0, os.path.abspath('../../pyincore'))
-sys.path.insert(0, os.path.abspath('../../pyincore/analyses'))
-sys.path.insert(0, os.path.abspath('../../tests'))
-sys.path.insert(0, os.path.abspath('../../docs'))
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath("../.."))
+sys.path.insert(0, os.path.abspath("../../pyincore"))
+sys.path.insert(0, os.path.abspath("../../pyincore/analyses"))
+sys.path.insert(0, os.path.abspath("../../tests"))
+sys.path.insert(0, os.path.abspath("../../docs"))
 
 # -- Project information -----------------------------------------------------
 
-project = 'pyIncore'
-author = ''
+project = "pyIncore"
+author = ""
 
 # The short X.Y version
-version = '1.19'
+version = "1.20"
 # The full version, including alpha/beta/rc tags
-release = '1.19.0'
+release = "1.20.0"
 
 # -- General configuration ---------------------------------------------------
 
@@ -46,25 +46,26 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc',
-              'sphinx.ext.intersphinx',
-              # 'sphinx.ext.viewcode',
-              'sphinx_rtd_theme',
-              'sphinx.ext.ifconfig',
-              'sphinx.ext.napoleon',
-              'sphinx.ext.todo'
-              ]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    # 'sphinx.ext.viewcode',
+    "sphinx_rtd_theme",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+]
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = '.rst'
-source_suffix = ['.rst', '.md']
+source_suffix = [".rst", ".md"]
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation.rst
 # for a list of supported languages.
@@ -79,7 +80,7 @@
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # -- Custom configuration ---------------------------------------------------
 
@@ -89,7 +90,7 @@
 # See also:
 # http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autodoc_mock_importshttps://github.com/sphinx-doc/sphinx/issues/4182
 
-autodoc_mock_imports = ['pytest', 'rasterstats']
+autodoc_mock_imports = ["pytest", "rasterstats"]
 
 # This value selects what content will be inserted into the main body of an autoclass directive.
 # The possible values are:
@@ -99,7 +100,7 @@
 # “both”: Both the class ’ and the init method’s docstring are concatenated and inserted.
 # “init”: Only the init method’s docstring is inserted.
 
-autoclass_content = 'both'
+autoclass_content = "both"
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -116,19 +117,19 @@
 #
 # html_theme_options = {}
 html_theme_options = {
-    'canonical_url': '',
-    'analytics_id': '',
-    'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
-    'vcs_pageview_mode': '',
+    "canonical_url": "",
+    "analytics_id": "",
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    "vcs_pageview_mode": "",
     # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -150,7 +151,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pyincoredoc'
+htmlhelp_basename = "pyincoredoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -159,15 +160,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -177,19 +175,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'pyincore.tex', 'pyincore Documentation',
-     'ISDA NCSA', 'manual'),
+    (master_doc, "pyincore.tex", "pyincore Documentation", "ISDA NCSA", "manual"),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pyincore', 'pyincore Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "pyincore", "pyincore Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -201,9 +195,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'pyincore', 'pyincore Documentation',
-     author, 'pyincore', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "pyincore",
+        "pyincore Documentation",
+        author,
+        "pyincore",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.