otoole

otoole: OSeMOSYS Tools for Energy Work - Published in JOSS (2023)

https://github.com/osemosys/otoole

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 1 DOI reference(s) in JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
2 of 5 committers (40.0%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

energy energy-system energy-system-modelling osemosys

Scientific Fields

Sociology Social Sciences - 87% confidence

Last synced: 4 months ago · JSON representation ·

Repository

OSeMOSYS Tools for Energy

Basic Info

Host: GitHub
Owner: OSeMOSYS
License: mit
Language: Python
Default Branch: master
Homepage: https://otoole.readthedocs.io
Size: 3.13 MB

Statistics

Stars: 27
Watchers: 7
Forks: 20
Open Issues: 47
Releases: 20

Topics

energy energy-system energy-system-modelling osemosys

Created over 6 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog Contributing License Citation Authors Zenodo

README.rst

==================================================
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 `_
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 `_.

Owner

Name: OSeMOSYS
Login: OSeMOSYS
Kind: organization
Email: osemosys@gmail.com

Website: http://www.osemosys.org/
Repositories: 11
Profile: https://github.com/OSeMOSYS

Open-source Energy Modelling System

JOSS Publication

otoole: OSeMOSYS Tools for Energy Work

Published

December 20, 2023

DOI

10.21105/joss.05511

Volume 8, Issue 92, Page 5511

Authors

Trevor Barnes

School of Sustainable Energy Engineering, Simon Fraser University, Vancouver, Canada

Will Usher

Energy Technology, KTH Royal Institute of Technology, Stockholm, Sweden

Editor

Frauke Wiese

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Barnes
  given-names: Trevor
  orcid: "https://orcid.org/0000-0003-2458-2968"
- family-names: Usher
  given-names: Will
  orcid: "https://orcid.org/0000-0001-9367-1791"
contact:
- family-names: Barnes
  given-names: Trevor
  orcid: "https://orcid.org/0000-0003-2458-2968"
doi: 10.5281/zenodo.10360538
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Barnes
    given-names: Trevor
    orcid: "https://orcid.org/0000-0003-2458-2968"
  - family-names: Usher
    given-names: Will
    orcid: "https://orcid.org/0000-0001-9367-1791"
  date-published: 2023-12-20
  doi: 10.21105/joss.05511
  issn: 2475-9066
  issue: 92
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5511
  title: "otoole: OSeMOSYS Tools for Energy Work"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05511"
  volume: 8
title: "otoole: OSeMOSYS Tools for Energy Work"

GitHub Events

Total

Create event: 7
Release event: 4
Issues event: 6
Watch event: 3
Delete event: 7
Issue comment event: 6
Push event: 11
Pull request event: 8
Fork event: 2

Last Year

Create event: 7
Release event: 4
Issues event: 6
Watch event: 3
Delete event: 7
Issue comment event: 6
Push event: 11
Pull request event: 8
Fork event: 2

Committers

Last synced: 5 months ago

All Time

Total Commits: 622
Total Committers: 5
Avg Commits per committer: 124.4
Development Distribution Score (DDS): 0.412

Past Year

Commits: 45
Committers: 2
Avg Commits per committer: 22.5
Development Distribution Score (DDS): 0.022

Top Committers

Name	Email	Commits
Will Usher	w**r@k**e	366
trevorb1	t**s@s**a	253
chrwm	d**e@p**e	1
HauHe	3****e	1
AgnesBelt	b**o@k**e	1

Committer Domains (Top 20 + Academic)

kth.se: 2 posteo.de: 1 sfu.ca: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 86
Total pull requests: 79
Average time to close issues: 11 months
Average time to close pull requests: 24 days
Total issue authors: 8
Total pull request authors: 4
Average comments per issue: 1.48
Average comments per pull request: 1.01
Merged pull requests: 74
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 4
Pull requests: 9
Average time to close issues: 12 days
Average time to close pull requests: about 15 hours
Issue authors: 1
Pull request authors: 1
Average comments per issue: 0.5
Average comments per pull request: 0.44
Merged pull requests: 9
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

willu47 (37)
trevorb1 (26)
HauHe (10)
vignesh1987 (5)
wogandavid (3)
Timon-R (2)
EmiFej (2)
H3yfinn (1)

Pull Request Authors

trevorb1 (61)
willu47 (28)
AgnesBelt (2)
chrwm (1)

Top Labels

Issue Labels

bug (40) enhancement (17) documentation (5) bounty (1) excel (1) performance (1) question (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 696 last-month

Total dependent packages: 0
Total dependent repositories: 4
Total versions: 58
Total maintainers: 2

pypi.org: otoole

A Python toolkit to support use of OSeMOSYS

Homepage: https://github.com/OSeMOSYS/otoole
Documentation: https://otoole.readthedocs.io/en/latest/?badge=latest
License: MIT
Latest release: 1.1.5
published about 1 year ago

Versions: 58
Dependent Packages: 0
Dependent Repositories: 4
Downloads: 696 Last month

Rankings

Dependent packages count: 7.3%

Dependent repos count: 7.6%

Forks count: 9.1%

Average: 10.4%

Downloads: 13.2%

Stargazers count: 14.9%

Maintainers (2)

willu47 trevorb1

Last synced: 4 months ago

Dependencies

requirements.txt pypi

amply *
datapackage *
flatten_dict *
importlib_resources *
networkx *
openpyxl *
pandas *
pandas_datapackage_reader *
pydot *
pyyaml *
xlrd *

.github/workflows/citation.yaml actions

actions/checkout v2 composite
citation-file-format/cffconvert-github-action 2.0.0 composite

.github/workflows/python-publish.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite

.github/workflows/python.yaml actions

actions/checkout v3 composite
actions/setup-python v4 composite

docs/requirements.txt pypi

Jinja2 <3.1
amply >=0.1.4
docutils <0.18
flatten_dict *
networkx *
openpyxl *
pandas >=1.1,<2.1
pydantic >=2
pydot *
pyyaml *
sphinx >=3.2.1
sphinx-book-theme *
urllib3 <2
xlrd *

pyproject.toml pypi

setup.py pypi

src/otoole/preprocess/setup.py pypi

otoole

Science Score: 100.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

JOSS Publication

otoole: OSeMOSYS Tools for Energy Work

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: otoole

Rankings

Maintainers (2)

Dependencies