About minpower
================

**Minpower** is an :ref:`open source<license>` toolkit for :doc:`students<students>` and :doc:`researchers<researchers>` in power systems. It is designed to make working with :doc:`ED <economic-dispatch>`, :doc:`OPF <optimal-power-flow>`, and :doc:`UC <unit-commitment>` problems :doc:`simple and intuitive<why-minpower>`. The goal is to foster :doc:`collaboration<collaborate>` with other :doc:`researchers<researchers>` and to make learning easier for :doc:`students<students>`.


**Minpower** is currently :ref:`under development <development>`.
 

.. _authors:

Authors and Collaborators
---------------------------



..  image::  ./_static/adam.jpg
    :target: http://adamgreenhall.com
    :width: 80 px
    :align: left


..  container:: halfwidth

    `Adam Greenhall <http://adamgreenhall.com>`_ started minpower
    in early 2011 because he needed a good tool for his PhD research
    on demand response and for teaching students at `U. of Washington <http://ee.washington.edu>`_.

.. comment
    ..  image:: ./_static/sandia.gif
        :target: https://software.sandia.gov/trac/coopr
        :width: 80 px
        :align: left
    ..  container:: halfwidth

        `Sandia National Labs <https://software.sandia.gov/trac/coopr>`_ makes the ``coopr`` package which is the engine for the optimization that goes on in minpower. 


.. _development:

Development
------------

..  image:: ./_static/github.jpg
    :target: http://github.com/adamgreenhall/minpower
    :alt: github logo
    :width: 80 px
    :align: left

..  container:: halfwidth
    
    **Minpower** is actively and openly developed on `github <http://github.com/adamgreenhall/minpower>`_, a social code 
    hosting site that allows for collaboration by many people and change tracking. 

Development is simple:
    
    #. Get on github and `fork minpower <http://github.com/adamgreenhall/minpower>`_
    #. Make it better
    #. Test it out (use  :mod:`tests.testall` and :mod:`tests.testall_integration`)
    #. Make a `pull request <https://github.com/adamgreenhall/minpower/pulls>`_ to get your version in

.. _license:

License
---------

**Minpower** is distributed under the `MIT license <http://www.opensource.org/licenses/mit-license>`_. This basically means:

Copyright 2011 by Adam Greenhall and contributors, minpowertoolkit.com

Redistribution and use with or without modification, are ok provided that: redistributions of code must retain the copyright above, this list of conditions, and the disclaimer below.

If you use **Minpower** in published research, please cite minpowertoolkit.com. If you use this code and modify it for the better, please share your improvements. But you are not required to. 



The full fine print: 

..  container:: license
    
    Copyright 2011 by Adam Greenhall and contributors, minpowertoolkit.com
    
    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
    
    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
    
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.