From e9777712e6eb204256fa04de48ff6a3dd615c5c7 Mon Sep 17 00:00:00 2001
From: Victor Zverovich <victor.zverovich@gmail.com>
Date: Mon, 12 Aug 2013 17:01:33 -0700
Subject: [PATCH] Add README for jacop

---
 solvers/jacop/README | 80 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 solvers/jacop/README

diff --git a/solvers/jacop/README b/solvers/jacop/README
new file mode 100644
index 000000000..4f2ebd8c7
--- /dev/null
+++ b/solvers/jacop/README
@@ -0,0 +1,80 @@
+The solver "jacop" uses JaCoP (http://jacop.osolpro.com/) to solve
+constraint programming problems.  Normally the jacop solver is
+invoked by AMPL's solve command, which gives the invocation
+
+     jacop stub -AMPL
+
+in which stub.nl is an AMPL generic output file (possibly written
+by "ampl -obstub" or "ampl -ogstub").  After solving the problem,
+the solver writes a stub.sol file for use by ampl's solve and solution
+commands.  When you run ampl, this all happens automatically if you
+give the AMPL commands
+
+     option solver jacop;
+     solve;
+
+You can control the solver by setting the environment variable
+jacop_options appropriately (either by using ampl's option command,
+or by using the shell's set and export commands before you invoke ampl).
+You can put one or more (white-space separated) phrases in
+$jacop_options.  A few of the phrases are single words:
+
+     Phrase       Meaning
+
+     version      Report version details before solving the problem.
+
+Others are name-value pairs, possibly separated by '=', as in
+
+     wantsol 1
+or
+     wantsol=1
+or
+     wantsol = 1
+
+any of which make the jacop driver write .sol file in a stand-alone
+invocation (no -AMPL on the command line).
+
+The following command prints the full list of options with descriptions:
+
+     jacop -=
+
+-----------------------
+solve_result_num values
+=======================
+
+Here is a table of solve_result_num values that "jacop" can return
+to an AMPL session, along with the text that appears in the associated
+solve_message.
+
+        Value   Message
+
+          0     optimal solution
+        100     feasible solution
+        200     infeasible problem
+        600     interrupted
+
+-------------------
+
+If you invoke "jacop stub -AMPL" or "jacop stub", you can also
+supply additional command-line arguments of the form name=value.
+Such arguments override specifications in $jacop_options.  Example:
+
+     ampl -obfoo foo.model foo.data
+     nohup jacop -s foo 2>>err&
+
+to solve a problem whose solution will take a while; after it finishes,
+
+     ampl foo.model foo.data -
+     solution foo.sol;
+     display ... /* things involving the computed solution */;
+
+(Here, - denotes standard input, and ampl reads the "solution..."
+and "display..." lines.)
+
+*************************
+
+If you have questions about or find bugs with this stuff,
+please contact:
+
+     Victor Zverovich
+     viz@ampl.com