Merge pull request #35 from quatrope/dev

Dev
quatrope · Feb 21, 2022 · dc0206e · dc0206e
2 parents faffa29 + e4933c2
commit dc0206e
Show file tree

Hide file tree

Showing 79 changed files with 5,461 additions and 1,011 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -13,4 +13,4 @@ env:
 
 jobs:
   testing:
-    uses: quatrope/scikit-criteria/.github/workflows/tests.yml@991bafd28ebc638429e2fcd2c69d7cb9722209ea
+    uses: quatrope/scikit-criteria/.github/workflows/tests.yml@0cd9099455b6e45659347dc08e6eeec95f876c10
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        tox_env: [py37, py38, py39]
+        tox_env: [py37, py38, py39, py310]
         include:
           - tox_env: style
           - tox_env: docstyle

diff --git a/.gitignore b/.gitignore
@@ -62,4 +62,4 @@ setuptools-*.zip
 .pytest_cache
 .vscode/
 result_images/
-docs/source/_dynamic/README
+docs/source/_dynamic/README.rst
diff --git a/.header-template b/.header-template
@@ -2,4 +2,5 @@
 # -*- coding: utf-8 -*-
 # License: BSD-3 (https://tldrlegal.com/license/bsd-3-clause-license-(revised))
 # Copyright (c) 2016-2021, Cabral, Juan; Luczywo, Nadia
+# Copyright (c) 2022, QuatroPe
 # All rights reserved.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,5 @@
 Copyright (c) 2016-2021, Cabral, Juan; Luczywo, Nadia
+Copyright (c) 2022, QuatroPe
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 <!-- BODY -->
 
-
+[![QuatroPe](https://img.shields.io/badge/QuatroPe-Applications-1c5896)](https://quatrope.github.io/)
 [![Gihub Actions CI](https://github.com/quatrope/scikit-criteria/actions/workflows/CI.yml/badge.svg)](https://github.com/quatrope/scikit-criteria/actions/workflows/CI.yml)
 [![Documentation Status](https://readthedocs.org/projects/scikit-criteria/badge/?version=latest&style=flat)](http://scikit-criteria.readthedocs.io)
 [![PyPI](https://img.shields.io/pypi/v/scikit-criteria)](https://pypi.org/project/scikit-criteria/)

diff --git a/ahp_ext/tuto.ipynb b/ahp_ext/tuto.ipynb
@@ -138,10 +138,10 @@
     }
    ],
    "source": [
-    "# et’s asume we know in our case, that the importance of \n",
-    "# the autonomy is the 50%, the confort only a 5% and \n",
+    "# et’s asume we know in our case, that the importance of\n",
+    "# the autonomy is the 50%, the confort only a 5% and\n",
     "# the price is 45%\n",
-    "weights=[.5, .05, .45]\n",
+    "weights = [0.5, 0.05, 0.45]\n",
     "weights"
    ]
   },
@@ -237,10 +237,7 @@
     }
    ],
    "source": [
-    "mtx = ahp.t(\n",
-    "          [[1],\n",
-    "           [1., 1],\n",
-    "           [1/3.0, 1/6.0, 1]])\n",
+    "mtx = ahp.t([[1], [1.0, 1], [1 / 3.0, 1 / 6.0, 1]])\n",
     "mtx"
    ]
   },
@@ -271,7 +268,7 @@
    "outputs": [],
    "source": [
     "# this validate the data\n",
-    "ahp.validate_ahp_matrix(3, mtx) "
+    "ahp.validate_ahp_matrix(3, mtx)"
    ]
   },
   {
@@ -325,7 +322,7 @@
     }
    ],
    "source": [
-    "ahp.validate_ahp_matrix(3, invalid_mtx) "
+    "ahp.validate_ahp_matrix(3, invalid_mtx)"
    ]
   },
   {
@@ -378,7 +375,7 @@
     }
    ],
    "source": [
-    "ahp.validate_ahp_matrix(3, invalid_mtx) "
+    "ahp.validate_ahp_matrix(3, invalid_mtx)"
    ]
   },
   {
@@ -409,11 +406,7 @@
     }
    ],
    "source": [
-    "crit_vs_crit = ahp.t([\n",
-    "    [1.], \n",
-    "    [1./3., 1.], \n",
-    "    [1./3., 1./2., 1.]\n",
-    "])\n",
+    "crit_vs_crit = ahp.t([[1.0], [1.0 / 3.0, 1.0], [1.0 / 3.0, 1.0 / 2.0, 1.0]])\n",
     "crit_vs_crit"
    ]
   },
@@ -450,16 +443,9 @@
    ],
    "source": [
     "alt_vs_alt_by_crit = [\n",
-    "    ahp.t([[1.], \n",
-    "           [1./5., 1.], \n",
-    "           [1./3., 3., 1.]]),\n",
-    "    ahp.t([\n",
-    "        [1.], \n",
-    "        [9., 1.], \n",
-    "        [3., 1./5., 1.]]),\n",
-    "    ahp.t([[1.], \n",
-    "           [1/2., 1.], \n",
-    "           [5., 7., 1.]]),\n",
+    "    ahp.t([[1.0], [1.0 / 5.0, 1.0], [1.0 / 3.0, 3.0, 1.0]]),\n",
+    "    ahp.t([[1.0], [9.0, 1.0], [3.0, 1.0 / 5.0, 1.0]]),\n",
+    "    ahp.t([[1.0], [1 / 2.0, 1.0], [5.0, 7.0, 1.0]]),\n",
     "]\n",
     "\n",
     "alt_vs_alt_by_crit"

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,6 +2,8 @@ Sphinx
 sphinx_rtd_theme
 
 nbsphinx
+sphinx_copybutton
+
 ipykernel
 ipython
 

diff --git a/docs/source/api/core/dominance.rst b/docs/source/api/core/dominance.rst
@@ -0,0 +1,7 @@
+``skcriteria.core.dominance`` module
+====================================
+
+.. automodule:: skcriteria.core.dominance
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/core/stats.rst b/docs/source/api/core/stats.rst
@@ -0,0 +1,7 @@
+``skcriteria.core.stats`` module
+================================
+
+.. automodule:: skcriteria.core.stats
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/madm/_base.rst b/docs/source/api/madm/_base.rst
@@ -0,0 +1,7 @@
+``skcriteria.madm._base`` module
+==================================
+
+.. automodule:: skcriteria.madm._base
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/preprocessing/filters.rst b/docs/source/api/preprocessing/filters.rst
@@ -0,0 +1,7 @@
+``skcriteria.preprocessing.filters`` module
+=============================================
+
+.. automodule:: skcriteria.preprocessing.filters
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api/utils/accabc.rst b/docs/source/api/utils/accabc.rst
@@ -0,0 +1,7 @@
+``skcriteria.utils.accabc`` module
+==================================
+
+.. automodule:: skcriteria.utils.accabc
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -57,8 +57,13 @@
     "sphinx.ext.autosummary",
     "nbsphinx",
     "sphinxcontrib.bibtex",
+    "sphinx_copybutton"
 ]
+# =============================================================================
+# EXTRA CONF
+# =============================================================================
 
+autodoc_member_order = "bysource"
 
 # =============================================================================
 # BIB TEX
@@ -241,7 +246,7 @@
     readme_md = fp.read().split("<!-- BODY -->")[-1]
 
 
-README_RST_PATH = CURRENT_PATH / "_dynamic" / "README"
+README_RST_PATH = CURRENT_PATH / "_dynamic" / "README.rst"
 
 
 with open(README_RST_PATH, "w") as fp:

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -16,7 +16,7 @@
 |
 
 .. Here we render the README.md of the repository as a main page
-.. include:: _dynamic/README
+.. include:: _dynamic/README.rst
 
 
 Contents

diff --git a/docs/source/refs.bib b/docs/source/refs.bib
@@ -119,4 +119,17 @@ @article{diakoulaki1995determining
   pages     = {763--770},
   year      = {1995},
   publisher = {Elsevier}
+}
+
+% tutorial
+
+@article{simon1955behavioral,
+  title     = {A behavioral model of rational choice},
+  author    = {Simon, Herbert A},
+  journal   = {The quarterly journal of economics},
+  volume    = {69},
+  number    = {1},
+  pages     = {99--118},
+  year      = {1955},
+  publisher = {MIT Press}
 }
diff --git a/docs/source/tutorial/index.rst b/docs/source/tutorial/index.rst
@@ -7,10 +7,10 @@ scikit-criteria
 Contents:
 
 .. toctree::
-   :maxdepth: 2
-   :glob:
+   :maxdepth: 1
 
-   *
+   quickstart.ipynb
+   sufdom.ipynb
 
 
 

diff --git a/docs/source/tutorial/quickstart.ipynb b/docs/source/tutorial/quickstart.ipynb
@@ -1574,6 +1574,13 @@
     "As can be seen for this case both scalings give the same results"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "----"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 35,
@@ -1617,7 +1624,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.10"
   }
  },
  "nbformat": 4,