Permalink
Browse files

Added README.rst to repository.

This file will appear on the GitHub homepage for this project, nicely
formatted since it is in reStructuredText format.
  • Loading branch information...
1 parent 7d3ab0e commit f20cdeda16186ed9c583e3032904a808870f9d60 @jwallen jwallen committed Feb 5, 2011
Showing with 92 additions and 0 deletions.
  1. +92 −0 README.rst
View
@@ -0,0 +1,92 @@
+******************************************************************************
+PyDQED - A Python wrapper for the DQED constrained nonlinear optimization code
+******************************************************************************
+
+Introduction
+============
+
+PyDQED provides a means for Python code to utilize DQED, a bounded, constrained
+nonlinear optimization code. DQED is
+`publicly <http://people.sc.fsu.edu/~jburkardt/f_src/dqed/dqed.html>`_
+`available <http://www.netlib.org/opt/dqed.f>`_, and is distributed with PyDQED.
+PyDQED provides a Python extension type for DQED, which in turn provides a
+Pythonic means of setting the solver options, providing residual and jacobian
+functions, and running the solver.
+
+License
+=======
+
+Copyright (c) 2011 by Joshua W. Allen (jwallen@mit.edu).
+
+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.
+
+Dependencies
+============
+
+PyDQED has been tested on Python versions 2.5 and 2.6. It may or may not work
+for other Python versions.
+
+There are several Python dependencies that you must install before installing
+PyDQED:
+
+* `Python <http://www.python.org/>`_ (versions 2.5.x and 2.6.x are known to work)
+
+* `NumPy <http://numpy.scipy.org/>`_ (version 1.3.0 or later is recommended)
+
+* `Cython <http://www.cython.org/>`_ (version 0.12.1 or later is recommended)
+
+In addition, you will also need a Fortran compiler and a C compiler that
+produce object files that can interoperate. The ``gfortran`` and ``gcc``
+compiles from the GNU Compiler Collection are known to work. On Windows the
+`MinGW <http://www.mingw.org/>`_ compiler collection provides these compilers.
+
+The code for DQED has been provided with the PyDQED package. The license for
+DQED is different than that of the PyDQED wrapper code. **You are responsible
+for knowing and abiding by all licenses associated with DQED as well as with
+PyDQED.**
+
+Installation
+============
+
+Windows
+-------
+
+The provided batch script will compile DQED and the PyDQED wrapper code. This
+script presumes that you have the 32-bit version of the MinGW C and Fortran
+compilers installed. Once you have run the batch script, you can install PyDQED
+into your Python packages if you desire by running the following command from
+the base package directory:
+
+ > python setup.py install
+
+Linux
+-----
+
+A Makefile has been provided that can be used to compile DQED and the PyDQED
+wrapper code. To use, invoke the following command from the base package
+directory::
+
+ $ make
+
+This command will build PyDQED in-place, rather than installing it to your
+Python package directory. If you wish to formally install PyDQED, run the
+following command from the base package directory after the ``make`` command
+(you may need root privileges for this)::
+
+ # python setup.py install

0 comments on commit f20cded

Please sign in to comment.