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.

Sign up for GitHub

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

Update readme #206

Merged
merged 3 commits into from
Nov 3, 2023
Merged

Update readme #206

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
806a3f7
add contributing guidelines link
trevorb1 Oct 24, 2023
f9eca92
update readme
trevorb1 Nov 3, 2023
f3eb56b
badge formatting
trevorb1 Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 33 additions & 13 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,46 @@
otoole: OSeMOSYS tools for energy work
==================================================

.. image:: https://coveralls.io/repos/github/OSeMOSYS/otoole/badge.svg?branch=master&kill_cache=1
:target: https://coveralls.io/github/OSeMOSYS/otoole?branch=master
.. image:: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467/status.svg
:target: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467
:alt: JOSS status

.. image:: https://readthedocs.org/projects/otoole/badge/?version=latest
:target: https://otoole.readthedocs.io/en/latest/?badge=latest
:alt: Documentation 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://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467/status.svg
:target: https://joss.theoj.org/papers/e93a191ae795b171beff782a68fdc467
:alt: JOSS status
.. image:: https://img.shields.io/badge/python-3.9_|_3.10_|_3.11-blue.svg
:target: https://crate.io/packages/otoole/
:alt: Python Version

A Python toolkit to support use of OSeMOSYS
.. 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
which provides a command-line interface for users of OSeMOSYS. The aim of the
package is to provide commonly used pre- and post-processing steps for OSeMOSYS.
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
Expand Down Expand Up @@ -53,5 +71,7 @@ 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 documentation of code development, please see
the contribution guidelines document.
ideas further.

To contribute directly to the code and documentation development, please see
the `contribution guidelines <https://otoole.readthedocs.io/en/latest/contributing.html>`_.