MARIO

Perform impact analysis using regional input-output tables and models.
https://github.com/it-is-me-mario/mario

Last synced: about 9 hours ago
JSON representation

Repository metadata

Multifunctional Analysis of Regions through Input-Output

• Host: GitHub
• URL: https://github.com/it-is-me-mario/mario
• Owner: it-is-me-mario
• License: gpl-3.0
• Created: 2021-10-27T16:50:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-05T11:06:37.000Z (6 days ago)
• Last Synced: 2024-05-05T20:00:29.791Z (6 days ago)
• Language: Python
• Size: 28.9 MB
• Stars: 31
• Watchers: 0
• Forks: 12
• Open Issues: 29
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

README

        

.. image:: https://img.shields.io/gitter/room/SESAM-Polimi/MARIO

    :target: https://gitter.im/SESAM-Polimi/MARIO

    

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    

.. image:: https://readthedocs.org/projects/mario-suite/badge/?version=latest

    :target: https://mario-suite.readthedocs.io/en/latest/index.html

    :alt: Documentation Status  

    

.. image:: https://badge.fury.io/py/mariopy.svg

    :target: https://badge.fury.io/py/mariopy

    

.. image:: https://raw.githubusercontent.com/SESAM-Polimi/MARIO/767d2c0e9e42ae0b6acf7c3a1cc379d7bcd367fa/doc/source/_static/images/polimi.svg

   :width: 200

   :align: right

   

.. image:: https://zenodo.org/badge/421900437.svg

   :target: https://zenodo.org/badge/latestdoi/421900437

*******

MARIO

*******

Multifunctional Analysis of Regions through Input-Output.  (`Documents `_)

What is it

-----------

**MARIO** is a python package for handling input-output tables and models inspired by `Pymrio  `_ .

MARIO aims to provide a *simple* & *intuitive* API for common IO tasks without

needing in-depth programming knowledge. MARIO supporst automatic parsing of different

structured tables such EXIOBASE, EORA, EUROSTAT in different formats namely:

* Single region 

* Multi region

* Hybrid tables

* Monetary tables

* Input-Output tables

* Supply-Use tables

When databases are not structured, MARIO supports parsing data from xlsx, csv, txt files

or pandas.DataFrames.

More than parsing data, MARIO includes some basic functionalities:

* Aggregation of databases

* SUT to IOT transformation

* Modifying database in terms of adding:

   * New sectors, activities or commodities to the database

   * Adding new extensions to the satellite account

* Scneario and shock analysis

* Backward and forward linkages analysis

* Extracting single region database from multi region databases

* Balance test 

* Productivity test

* Exporting the databases into different formats for scenarios analyzed

* Interactive visualization routines

Requirements

------------

MARIO has been tested on macOS and Windows.

To run MARIO, a couple of things are needed:

#. Being in love with Input-Output :-)

#. The Python programming language, version 3.7 or higher

#. A number of Python adds-on packages

#. For some functionalities a solver may needed (optional)

#. MARIO software itself

Recommended installation method

-------------------------------

The easiest way to make MARIO software working is to use the free

conda package manager which can install the current and future MARIO

depencies in an easy and user friendly way.

To get conda, `download and install "Anaconda Distribution" `_ 

. Between differnet options for running python codes, we strongly suggest, `Spyder `_, 

which is  a free and open source scientific environment written in Python, for Python, and designed by and for scientists,

engineers and data analysts.

You can install mario using pip or from source code. It is suggested to create a new environment by running the following command in the anaconda prompt

.. code-block:: python

   conda create -n mario python=3.8

If you create a new environment for mario, to use it, you need to activate the mario environment each time by writing

the following line in *Anaconda Prompt*

.. code-block:: python

   conda activate mario

Now you can use pip to install mario on your environment as follow:

.. code-block:: python

  pip install mariopy

You can also install from the source code!

           

Quickstart

----------

A simple test for Input-Output Table (IOT) and Supply-Use Table (SUT) is included in mario.

To use the IOT test, call

.. code-block:: python

   import mario

   test_iot = mario.load_test('IOT')

and to use the SUT test, call

.. code-block:: python

   test_sut = mario.load_test('SUT')

To see the configurations of the data, you can print them:

.. code-block:: python

   print(test_iot)

   print(test_sut)

To see specific sets of the tables like regions or value added,

get_index function can be used:

.. code-block:: python

   print(test_iot.get_index('Region'))

   print(test_sut.get_index('Factor of production'))

To visualize some data, various plot functions can be used:

.. code-block:: python

   test_iot.plot_matrix(....)

Specific modifications on the database can be done, such as

SUT to IOT transformation:

.. code-block:: python

   reformed_iot = test.to_iot(method='B')

The changes can be tracked by metadata. The history can be checked by calling:

.. code-block:: python

   reformed_iot.meta_history

The new database can be saved into excel,txt or csv file:

.. code-block:: python

   reformed_iot.to_excel(path='a folder//database.xlsx')

.. _RST pckgs:

Python module requirements

--------------------------

Some of the key packages the mario relies on are:

* `Pandas  `_ 

* `Numpy  `_ 

* `Plotly  `_ 

* `Tabulate  `_ 

* `Pymrio  `_ 

* `Cvxpy  `_ (Optional in this version)

Testing MARIO

-------------

The current version of Mario has achieved a test coverage of 49%. This coverage includes a comprehensive 100% assessment of the fundamental mathematical engine. 

Additional tests are currently in active development to enhance the package's reliability. 

Mario utilizes `pytest `_  as its primary tool for conducting unit tests. For a more detailed analysis of the test coverage pertaining to mario's unit tests, 

you can execute the following command:

.. code-block:: python

   pytest --cov=mario tests/ 

.. note::

   * This project is under active development. 

   * More examples will be uploaded through time to the gellery.

   * More parsers will be added to the next version.

   * The next version will cover some optimization models within the IO framework

   * For more tutorials on mario, check out our `Input-Output analysis and modelling with MARIO Course  `_ 

License

-------

.. image:: https://www.gnu.org/graphics/gplv3-or-later.png

    :target: https://www.gnu.org/licenses/gpl-3.0.en.html

This work is licensed under a `GNU GENERAL PUBLIC LICENSE `_
      

---

Owner metadata

• Name: MARIO
• Login: it-is-me-mario
• Email:
• Kind: organization
• Description: Multifunctional Analysis of Regions through Input-Output
• Website: https://mario-suite.readthedocs.io/en/latest/index.html
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/121170888?v=4
• Repositories: 1
• Last ynced at: 2023-03-09T21:42:06.052Z
• Profile URL: https://github.com/it-is-me-mario

---

GitHub Events

Total

• Create event: 24
• Release event: 3
• Issues event: 30
• Watch event: 31
• Delete event: 16
• Issue comment event: 15
• Push event: 69
• Pull request review comment event: 14
• Pull request review event: 18
• Pull request event: 43
• Fork event: 9

Last Year

• Create event: 12
• Delete event: 4
• Fork event: 9
• Issue comment event: 5
• Issues event: 20
• Pull request event: 19
• Pull request review comment event: 14
• Pull request review event: 16
• Push event: 29
• Release event: 2
• Watch event: 20

---

Committers metadata

Last synced: 1 day ago

Name	Email	Commits
Mohammad Amin Tahavori	5****t	165
Lorenzo Rinaldi	4****i	11
Nicolò Golinucci	n****i@g****m	9
LorenzoRinaldi	l****1@g****m	8
Lorenzo Rinaldi	l****3@g****m	5
Nicolò Golinucci	5****d	2
Amedeo Felice Alberio	a****a@f****m	1

Committer domains:

• fb.com: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/it-is-me-mario/mario

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 115 last-month
• Total dependent packages: 1
• Total dependent repositories: 1
• Total versions: 4
• Total maintainers: 2

---

Dependencies

Score: 10.819378204388943