==================================================
otoole: OSeMOSYS tools for energy work
==================================================
.. image:: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467/status.svg
:target: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467
:alt: JOSS status
.. image:: https://img.shields.io/pypi/v/otoole.svg
:target: https://pypi.org/project/otoole/
:alt: PyPI
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style
.. image:: https://img.shields.io/badge/python-3.9_|_3.10_|_3.11|_3.12-blue.svg
:target: https://crate.io/packages/otoole/
:alt: Python Version
.. image:: https://img.shields.io/badge/License-MIT-green.svg
:target: https://opensource.org/licenses/MIT
:alt: License
|
.. image:: https://coveralls.io/repos/github/OSeMOSYS/otoole/badge.svg?branch=master&kill_cache=1
:target: https://coveralls.io/github/OSeMOSYS/otoole?branch=master
:alt: Code Coverage
.. image:: https://github.com/OSeMOSYS/otoole/actions/workflows/python.yaml/badge.svg?branch=master
:target: https://github.com/OSeMOSYS/otoole/actions/workflows/python.yaml
:alt: GitHub CI
.. image:: https://readthedocs.org/projects/otoole/badge/?version=latest
:target: https://otoole.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Description
===========
OSeMOSYS tools for energy work, or otoole, is a Python package
to support the users of OSeMOSYS. The aim of the package is to provide commonly
used pre- and post-processing steps for OSeMOSYS.
**otoole** aims to support different ways of storing input data and results,
including csv files and Excel workbooks, as well as different implementations
of the OSeMOSYS model. This improves interoperability of analyses and
generally makes life a little bit easier.
.. image:: docs/_static/workflow.png
Installation
============
``otoole`` can be installed through ``pip``::
pip install otoole
For instructions of the use of the tool, run the command line help function::
otoole --help
Documentation
=============
Detailed documentation of otoole, including examples, can be found here:
https://otoole.readthedocs.io/en/latest/
Contributing
============
New ideas and bugs `should be submitted <https://github.com/OSeMOSYS/otoole/issues/new>`_
to the repository issue tracker. Please do contribute by discussing and developing these
ideas further.
To contribute directly to the code and documentation development, please see
the `contribution guidelines <https://otoole.readthedocs.io/en/latest/contributing.html>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/OSeMOSYS/otoole",
"name": "otoole",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Will Usher",
"author_email": "wusher@kth.se",
"download_url": "https://files.pythonhosted.org/packages/b3/6c/4fb1a6a66fb9b4c658f6c36f239a57c6f384a68b62e8d0067846edbb6677/otoole-1.1.5.tar.gz",
"platform": "any",
"description": "==================================================\notoole: OSeMOSYS tools for energy work\n==================================================\n\n.. image:: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467/status.svg\n :target: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467\n :alt: JOSS status\n\n.. image:: https://img.shields.io/pypi/v/otoole.svg\n :target: https://pypi.org/project/otoole/\n :alt: PyPI\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style\n\n.. image:: https://img.shields.io/badge/python-3.9_|_3.10_|_3.11|_3.12-blue.svg\n :target: https://crate.io/packages/otoole/\n :alt: Python Version\n\n.. image:: https://img.shields.io/badge/License-MIT-green.svg\n :target: https://opensource.org/licenses/MIT\n :alt: License\n\n|\n\n.. image:: https://coveralls.io/repos/github/OSeMOSYS/otoole/badge.svg?branch=master&kill_cache=1\n :target: https://coveralls.io/github/OSeMOSYS/otoole?branch=master\n :alt: Code Coverage\n\n.. image:: https://github.com/OSeMOSYS/otoole/actions/workflows/python.yaml/badge.svg?branch=master\n :target: https://github.com/OSeMOSYS/otoole/actions/workflows/python.yaml\n :alt: GitHub CI\n\n.. image:: https://readthedocs.org/projects/otoole/badge/?version=latest\n :target: https://otoole.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nDescription\n===========\n\nOSeMOSYS tools for energy work, or otoole, is a Python package\nto support the users of OSeMOSYS. The aim of the package is to provide commonly\nused pre- and post-processing steps for OSeMOSYS.\n\n**otoole** aims to support different ways of storing input data and results,\nincluding csv files and Excel workbooks, as well as different implementations\nof the OSeMOSYS model. This improves interoperability of analyses and\ngenerally makes life a little bit easier.\n\n.. image:: docs/_static/workflow.png\n\nInstallation\n============\n\n``otoole`` can be installed through ``pip``::\n\n pip install otoole\n\nFor instructions of the use of the tool, run the command line help function::\n\n otoole --help\n\nDocumentation\n=============\nDetailed documentation of otoole, including examples, can be found here:\nhttps://otoole.readthedocs.io/en/latest/\n\nContributing\n============\n\nNew ideas and bugs `should be submitted <https://github.com/OSeMOSYS/otoole/issues/new>`_\nto the repository issue tracker. Please do contribute by discussing and developing these\nideas further.\n\nTo contribute directly to the code and documentation development, please see\nthe `contribution guidelines <https://otoole.readthedocs.io/en/latest/contributing.html>`_.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python toolkit to support use of OSeMOSYS",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://otoole.readthedocs.io/en/latest/?badge=latest",
"Homepage": "https://github.com/OSeMOSYS/otoole"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7aee61218b39ea00232615ecb42891406f028a437d532fcac6ff6074d7f0a0fa",
"md5": "291ab58c6215d3dbe871f6b813e90e11",
"sha256": "a1980fb9d95d464b155820abfeed96aad4b2c60fdca188aab50333938f54e83f"
},
"downloads": -1,
"filename": "otoole-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "291ab58c6215d3dbe871f6b813e90e11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 46116,
"upload_time": "2024-11-15T22:23:51",
"upload_time_iso_8601": "2024-11-15T22:23:51.792307Z",
"url": "https://files.pythonhosted.org/packages/7a/ee/61218b39ea00232615ecb42891406f028a437d532fcac6ff6074d7f0a0fa/otoole-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b36c4fb1a6a66fb9b4c658f6c36f239a57c6f384a68b62e8d0067846edbb6677",
"md5": "7224ca12f1d3d10ebeaa81ce5655e710",
"sha256": "d959700667ece14562931c105a767f37a2934a3a6cf113f1b709fc60ba9e14ee"
},
"downloads": -1,
"filename": "otoole-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "7224ca12f1d3d10ebeaa81ce5655e710",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1094576,
"upload_time": "2024-11-15T22:23:53",
"upload_time_iso_8601": "2024-11-15T22:23:53.536802Z",
"url": "https://files.pythonhosted.org/packages/b3/6c/4fb1a6a66fb9b4c658f6c36f239a57c6f384a68b62e8d0067846edbb6677/otoole-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 22:23:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OSeMOSYS",
"github_project": "otoole",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "otoole"
}
JSON
