Implement constraint on available capital

[ypp-sc-tools.main.git] / yarrg / web / docs

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 6f754bff46e258472de8c5d413723ab7fa8eb117..9db9320af0dfd60bea0962cb2019972522807735 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -179,4 +179,22 @@ You can enter the value in the box either as a percentage, or as a
 fraction 1/<em>divisor</em>, eg 1/200 is the same as 0.5%; in each
 case it is taken as the loss for each league of the voyage.
 
+<h3><a name="capital">Available capital</a></h3>
+
+If you don't specify the amount of capital you have available to
+invest in the voyage, the trading plan will assume that your capital
+is unlimited.  If you specify an amount in PoE here, the trading plan
+will never require you to spend more than that amount on commodities.
+
+<p>
+
+The trading plan does not take into account accumulated profits from
+each leg of the journey when applying the available capital
+constraint.  For example, if you specify a journey from A to B to C
+and a capital limit of 10000 PoE, the trading plan will not tell you
+to buy 1000 peas at A for 10 PoE each, sail them to B and sell all of
+them for 20 PoE each, and then buy 2000 beans at B for 10 PoE each and
+sail them to C to sell for 20 PoE each even if such a trade would in
+fact be possible.  In practice this is unlikely to be a problem!
+
 <& footer &>