Skip to content

Commit

Permalink
Adding mailing list link and other links.
Browse files Browse the repository at this point in the history
  • Loading branch information
rwl committed Jul 14, 2011
1 parent 89e6ddb commit 548c9d2
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 6 deletions.
30 changes: 27 additions & 3 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ PYPOWER depends upon:
* Python_ 2.5 or later and
* SciPy_ 0.7 or later.

It can be easy_installed using setuptools_::
It can be installed using setuptools_::

$ easy_install PYPOWER

Alternatively, `download <http://pypi.python.org/pypi/PYPOWER#downloads>`_ and
unpack the tarball and install::

$ tar zxf PYPOWER-4.0.tar.gz
$ tar zxf PYPOWER-4.0.X.tar.gz
$ python setup.py install

Using PYPOWER
Expand All @@ -49,20 +49,39 @@ for the IEEE Reliability Test System and write the solved case to file::

$ opf -c case24_ieee_rts --solvedcase=rtsout.py

For further information please refer to the http://www.pypower.org/ and the
For further information please refer to http://www.pypower.org/ and the
`API documentation`_.

Support
-------

Questions and comments regarding PYPOWER should be directed to the `mailing
list <http://groups.google.com/group/pypower>`_:

[email protected]

License & Copyright
-------------------

Copyright (C) 1996-2011 Power System Engineering Research Center

Copyright (C) 2010-2011 Richard Lincoln

This program is free software: you can redistribute it and/or modify
it under the terms of the `GNU General Public License`_ as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.

Links
-----

* MATPOWER_ from PSERC (Cornell)
* MatDyn_ by Stijn Cole
* PSAT_ by Federico Milano
* OpenDSS_ from EPRI
* GridLAB-D_ from PNNL
* PyCIM_

.. _Python: http://www.python.org
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
.. _SciPy: http://www.scipy.org
Expand All @@ -71,3 +90,8 @@ or (at your option) any later version.
.. _GitHub: http://github.com/rwl/PYPOWER
.. _`GNU General Public License`: http://www.gnu.org/licenses/
.. _`API documentation`: http://www.pypower.org/api
.. _PyCIM: http://www.pycim.org
.. _MatDyn: http://www.esat.kuleuven.be/electa/teaching/matdyn/
.. _PSAT: http://www.uclm.es/area/gsee/web/Federico/psat.htm
.. _OpenDSS: http://sourceforge.net/projects/electricdss/
.. _GridLAB-D: http://sourceforge.net/projects/gridlab-d/
3 changes: 2 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ PYPOWER documentation

Download `PDF <http://www.pypower.org/PYPOWER.pdf>`_

Contents:
Contents:

.. toctree::
:maxdepth: 2
Expand All @@ -14,6 +14,7 @@ Contents:
copyright
install
usage
support

.. only:: html

Expand Down
2 changes: 1 addition & 1 deletion doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ PYPOWER depends upon:
* Python_ 2.5 or later and
* SciPy_ 0.7 or later.

It can be easy_installed using setuptools_::
It can be installed using setuptools_::

$ easy_install PYPOWER

Expand Down
2 changes: 1 addition & 1 deletion doc/intro.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Introduction
============

PYPOWER is a power flow and Optimal Power Flow (OPF) solver. Current features
PYPOWER is a power flow and optimal power flow (OPF) solver. Current features
include:

* DC and AC (Newton's method & Fast Decoupled) power flow and
Expand Down
21 changes: 21 additions & 0 deletions doc/support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Support
-------

Questions and comments regarding PYPOWER should be directed to the `mailing
list <http://groups.google.com/group/pypower>`_:

[email protected]

Users may also wish to refer to the MATPOWER_ mailing list:

http://www.mail-archive.com/[email protected]/

Bugs and patches can be posted on the GitHub_ issue tracker:

http://github.com/rwl/PYPOWER/issues

For all other enquiries please email:

[email protected]

.. include:: ./link_names.txt

0 comments on commit 548c9d2

Please sign in to comment.