README

   1 -----
   2 Pylon
   3 -----
   4
   5 Pylon is a free software package for simulation of electric power systems and
   6 energy markets.  Its purpose is to provide a simple yet powerful tool for
   7 electric power Engineers that is not tied to proprietary software and can be
   8 used and extended easily.
   9
  10 Pylon's features currently include:
  11
  12 * DC and AC (Newton's method & Fast Decoupled) power flow,
  13 * DC and AC optimal power flow,
  14 * State estimation,
  15 * PSS/E, MATPOWER_ and PSAT_ data file parsers, and
  16 * Agent-based market simultaion using reinforcement learning methods.
  17
  18 -----------
  19 Quick start
  20 -----------
  21
  22 With Python_, setuptools_ and SciPy_ installed, run::
  23
  24   # easy_install pylon
  25
  26 Pylon performs an AC power flow and prints a ReStructuredText_ report by
  27 default::
  28
  29   $ pylon data_file.raw
  30
  31 Refer to the documentation for detailed usage information or type::
  32
  33   $ pylon --help
  34
  35 ---------------------
  36 License and Copyright
  37 ---------------------
  38
  39 Copyright (C) 1996-2010 Power System Engineering Research Center (PSERC)
  40 Copyright (C) 2010 Richard Lincoln
  41
  42 Pylon is licensed under the `Apache License`_ version 2.0.
  43
  44 -------
  45 Credits
  46 -------
  47
  48 Pylon is developed by Richard Lincoln (r.w.lincoln@gmail.com).
  49
  50 Pylon is a port of MATPOWER_ to the Python programming language.
  51
  52 Pylon was originally funded by the `EPSRC
  53 <http://www.epsrc.ac.uk/default.htm>`_ through `Grant GR/T28836/01
  54 <http://gow.epsrc.ac.uk/ViewGrant.aspx?GrantRef=GR/T28836/01>`_ for the
  55 SUPERGEN `Highly Distributed Power Systems <http://www.supergen-hdps.org>`_
  56 consortium.
  57
  58 .. _Python: http://www.python.org
  59 .. _Setuptools: http://peak.telecommunity.com/DevCenter/setuptools
  60 .. _SciPy: http://www.scipy.org
  61 .. _MATPOWER: http://www.pserc.cornell.edu/matpower/
  62 .. _PSAT: http://www.power.uwaterloo.ca/~fmilano/psat.htm
  63 .. _ReStructuredText: http://docutils.sf.net/rst.html
  64 .. _`Apache License`: http://www.apache.org/licenses/LICENSE-2.0.html
  65