Metadata-Version: 2.1
Name: clewsy
Version: 0.2
Summary: clewsy - A set of tools for building CLEWs models.
Home-page: https://github.com/OSeMOSYS/clewsy
Author: Taco Niet
Author-email: Taco_Niet@sfu.ca
License: mit
Project-URL: Documentation, https://github.com/OSeMOSYS/clewsy
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/x-rst; charset=UTF-8
Requires-Dist: pyyaml
Requires-Dist: pymongo
Requires-Dist: colorama
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'

=================================================
clewsy : A set of tools for building CLEWs models
=================================================

Welcome to CLEWsy - the Climate, Land, Energy and Water systems modelling framework tools repository.  The command line scripts in this repository provide tools for building CLEWs models using OSeMOSYS.

Description
===========

**clewsy** is a Python package which provides a command-line interface for building CLEWs models using OSeMOSYS.

Dependencies
------------

*clewsy* requires a number of dependencies, but these should be installed automatically when installing *clewsy*.

Installation
============

Install **clewsy** using pip::

    pip install clewsy


To upgrade **clewsy** using pip::

    pip install clewsy --upgrade

Usage
=====

For instructions of the use of the tool, run the command line

help function::

    clewsy --help

Contributing
============

New ideas and bugs `should be submitted: <https://github.com/OSeMOSYS/clewsy/issues/new>`_ to the repository Issue Tracker.

Referncing
==========

When using **clewsy** for publications and reports, please cite:
*T. Niet and A. Shivakumar (2020):  clewsy:  Script for building CLEWs models.*

Note
====

This project has been set up using PyScaffold 3.2.3. For details and usage
information on PyScaffold see https://pyscaffold.org/.


