Metadata-Version: 2.1
Name: mcda
Version: 0.7.0
Summary: Package for Multi Criteria Decision Analysis
Author-email: Nicolas Duminy <nicolas.duminy@imt-atlantique.fr>, Patrick Meyer <patrick.meyer@imt-atlantique.fr>
License: Copyright IMT Atlantique, 2021
        
        Project leaders:
          Patrick Meyer <patrick.meyer@imt-atlantique.fr>
          Nicolas Duminy <nicolas.duminy@imt-atlantique.fr>
        
        This software is an all-in-one package for Multi-Criteria Decision Analysis.
        
        This software is licensed under the European Union Public Licence (EUPL) v1.2.
        
        The English version and the French version of this licence are in the
        directory LICENCE.  The EUPL is available in 22 official languages of the
        European Union; for more informations, please check its website:
        https://joinup.ec.europa.eu/page/eupl-text-11-12
        
Project-URL: Homepage, https://py-mcda.readthedocs.io
Project-URL: Source, https://gitlab.com/decide.imt-atlantique/pymcda
Project-URL: Issues, https://gitlab.com/decide.imt-atlantique/pymcda/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pulp
Requires-Dist: scikit-learn
Requires-Dist: pandas
Requires-Dist: Deprecated
Requires-Dist: typing-extensions ; python_version < "3.11"
Provides-Extra: all
Requires-Dist: mcda[plot] ; extra == 'all'
Provides-Extra: plot
Requires-Dist: graphviz ; extra == 'plot'
Requires-Dist: matplotlib ; extra == 'plot'

Package for Multi-Criteria Decision Analysis named `mcda` (**Beta**).


# Package description

This package is used as a basis to represent Multi-Criteria Decision Aiding (MCDA) problems as well as solve them.
It also contains relatively low-level plotting functions to visualize a MCDA problem and its solution.

It is released on PyPI as [mcda](https://pypi.org/project/mcda/).

Its documentation is available [here](https://py-mcda.readthedocs.io/).


# Requirements

To be able to plot relations and outranking graphs, this package requires that `graphviz` be installed.
On Debian/Ubuntu this is done with:

```bash
sudo apt-get install graphviz
```


# Installation

If you want to simply use this package, simply install it from [PyPI](https://pypi.org/project/mcda/):

```bash
pip install mcda
```

**Note:**

This package can be installed with different optional dependencies to unlock full features:

* plot: unlock plotting utilities
* all: include all the above optional dependencies

If you want all optional dependencies for instance, do:

```bash
pip install "mcda[all]"
```

Once you installed our package, you can have a look at our [notebooks](https://py-mcda.readthedocs.io/en/latest/notebooks.html) section which contains examples on how to use our package.

If you want to contribute to this package development, we recommend you to read the next section.


# Contributors

This package is growing continuously and contributions are welcomed.
Contributions can come in the form of new features, bug fixes, documentation improvements
or any combination thereof.
It can also simply come in the form of issues describing the idea for a new feature, a bug encountered, etc.

If you want to contribute to this package, please read the [guidelines](https://py-mcda.readthedocs.io/en/latest/contributing.html).
If you have any new ideas or have found bugs, feel free to [create an issue](https://gitlab.com/decide.imt-atlantique/pymcda/-/issues/new>).
Finally, any contribution must be proposed for integration as a [Merge Request](https://gitlab.com/decide.imt-atlantique/pymcda/-/merge_requests/new).


# License

This software is licensed under the [European Union Public Licence (EUPL) v1.2](https://joinup.ec.europa.eu/page/eupl-text-11-12).
For more information see [LICENSE](https://gitlab.com/decide.imt-atlantique/pymcda/-/blob/master/LICENSE).


# Citations

@todo write section
