X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?a=blobdiff_plain;f=yarrg%2Fweb%2Fdocs;h=9feaa6b651d02f6d60aa068ee3e004eb19f5cd81;hb=6302552bfa5844eddb7c26386c9995733f0a5174;hp=cbb1c0dd2a30dea8055aef2fae6d78c4b27d7954;hpb=e088a29c1c037880074b5893831e6701273396d6;p=ypp-sc-tools.db-live.git diff --git a/yarrg/web/docs b/yarrg/web/docs index cbb1c0d..9feaa6b 100755 --- a/yarrg/web/docs +++ b/yarrg/web/docs @@ -33,17 +33,17 @@ %doc> -
+
If you specify only one island or one archipelago, the site shows only arbitrage trades. If you want single-hop trades within an @@ -101,7 +101,7 @@ After getting the results, you can untick various trades individually, and select `Update' to get a new plan. The unticked trades will be excluded from the voyage plan (if any) and also from the totals. -
-So you should specify your vessel capacity. Currently you must -specify the actual mass and volume, as two numbers each with units. -The system understands the units t (tonnes), kg, l and kl -(kilolitres). There should be a space between the two limits, and no -space before the unit. +So you should specify your vessel capacity. You can enter things +like: +
+ +More formally: +
+ capacity-string := [ first-term term* ] + term := ('+' | '-' | 'plus' | 'minus') (value+ | number'%') + value := mass | volume + | integer commodity-name-or-abbreviation + mass := number ('t' | 'kg') + volume := number ('kl' | 'l') + first-term := mass | volume | mass volume | volume mass + | ship-name-or-abbreviation ++ +If the first term specifies only one of mass or volume, all the +subsequent terms may only adjust that same value. -
-Trades whose margin is less than the expected loss are never selected. -For example, if you select 1% loss per league, and plan a voyage of 5 -leagues, then any trade with a margin of less than 5.15% would be -completely excluded (5.15% not 5% because the loss works like compound -interest). Theoretically very profitable trades which are close to -the expected break-even point because of the distance can also be -rejected by the optimiser in favour of shorter distance trades with -theoretically smaller margins. +Trades whose margin is less than the expected loss are never included +in the suggested plan. For example, if you select 1% loss per league, +and plan a voyage of 5 leagues, then any trade with a margin of less +than 5.15% would be completely excluded (5.15% not 5% because the loss +works like compound interest). Theoretically very profitable trades +which are close to the expected break-even point because of the +distance can also be rejected by the optimiser in favour of shorter +distance trades with theoretically smaller margins, if it's not +possible to do both.
-As a guide: you may expect to lose between 0.1% and 1% per league. -0.1% would correspond, for example, to losing one fight to brigands -every ten 10-league voyages. +As a guide: you may expect to lose between 0.01% and 1% per league. +For example 0.1% would correspond to losing one fight to brigands (who +take 10% if they win) for every 100 leagues sailed.
You can enter the value in the box either as a percentage, or as a -fraction 1/divisor, eg 1/200 is the same as 0.5%; in each +fraction 1/divisor, eg 1/2000 is the same as 0.05%; in each case it is taken as the loss for each league of the voyage. +
+ +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 &>