Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving the documentation #77

Open
mohammadamint opened this issue Oct 19, 2023 · 1 comment
Open

Improving the documentation #77

mohammadamint opened this issue Oct 19, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@mohammadamint
Copy link
Collaborator

mario documentation needs some improvements both in terms of structure of the documentation and content. Regarding the content, a more comprehensive background for input-output modeling is needed, and the examples needs to be improved to cover the hidden capabilities of mario.

@mohammadamint mohammadamint added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 19, 2023
@mohammadamint
Copy link
Collaborator Author

List of examples to be added:

  1. one example per parser:
  • Exiobases:

  • - hybrid (Lore)

  • - monetary (Lore)

  • EORA (Lore)

  • FIGARO (Amin)

  • EUROSTAT (Amin)

  • Custom Parsers: excel, txt, pd.DataFrames (Lore)

  • pymrio (Amin)

  1. Standard operations:
  • aggregation (Nico)
  • add sector (Lore)
  • backward-forward linkages (Nico)
  • matrix calculation (Nico)
  • saving models (xlsx,txt, to_pymrio) (Amin)
  • shock function (Amin)
  1. Fancy functions:
  • isard_to_chennery (Lore)
  • sut_to_iot (Lore)
  • settings (Amin)
  • add_extensions (Lore)
  1. bonus (model gallery)

  2. change the DOI to our paper (and add description on how to cite) (Amin)

  3. add mario logo to the top and bring others down (Amin)

  4. Collaboration guidline (Amin)

  5. Social media (Amin)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants