search

makhidkarun / traveller_pyroute

Traveller trade route generator
MIT License
14 stars 5 forks source link
python

readme

PyRoute for Traveller

PyRoute is a trade route generation program for Traveller. PyRoute has been ported to python3, there is a branch with the python2 version (no longer maintained). The released version requires Python 3.9+ (or PyPy 7.3).

The data for the maps comes from Traveller Map based upon the Traveller 5th edition second survey data plus many of the fan created sectors from around the Internet and across the years. Traveller Map presents the sector data in a consistent format, making the input processing considerably easier.

The trade rules are from GURPS Traveller: Far trader. These rules are based on a gravity trade model. Each world is given a weight called the World Trade Number (WTN) calculated from population, starport, and other factors. For each pair of worlds a Bilateral Trade Number (BTN) generated based upon the two WTNs and adjusted for distance and other factors.

The routes followed for trade are created by the shortest path algorithms from NetworkX, a library for managing graphs. You will need version 2.1 or later for the Unicode handling.

The final output, the map of trade routes, is created by ReportLab.

You can install the required libraries using pip:

pip install -r requirements.txt

The map generation requires several fonts not normally installed in the system:

apt-get install fonts-dejavu fonts-liberation fonts-freefont-ttf fonts-ancient-scripts fonts-symbola

To find the numpy package directory:

pip3 show numpy

To support the back-end map generation stuff:

pushd ./
cd {NUMPY_PACKAGE_DIR}/
cp __init__.cython-30.pxd numpy.pxd
popd

The back-end map-generation stuff needs compiling with:

pushd ./
cd {PACKAGE_ROOT}/PyRoute/Pathfinding/
python3 setup.py build_ext --inplace
popd

For the math and layout of hex maps, I recommend the Hexagonal Grids page which contains every item you will need to draw and manage hexagon maps.I recommend all the articles on the Red Blob Games site.

The original version of this program, nroute.c, was written by Anthony Jackson.

Running the program

$ python PyRoute/route.py --help
usage: route.py [-h] [--borders {none,range,allygen,erode}] [--ally-match {collapse,separate}]
                [--routes {trade,comm,xroute,owned,none,trade-mp}] [--min-btn BTN] [--min-route-btn ROUTE_BTN]
                [--max-jump {1,2,3,4,5,6,7,8,9,10}] [--pop-code {fixed,scaled,benford}] [--route-reuse ROUTE_REUSE]
                [--ru-calc {scaled,negative}] [--speculative-version {CT,T5,None}] [--mp-threads MP_THREADS]
                [--output OUTPUT] [--owned-worlds | --no-owned-worlds] [--trade | --no-trade] [--maps | --no-maps]
                [--subsector-maps | --no-subsector-maps] [--min-ally-count ALLY_COUNT] [--json-data] [--input INPUT]
                [--sectors SECTORS] [--debug | --no-debug] [--version] [--log-level LOG_LEVEL]
                [sector ...]

Traveller trade route generator.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --log-level LOG_LEVEL

Allegiance:
  Alter processing of allegiances

  --borders {none,range,allygen,erode}
                        Allegiance border generation, default [range]
  --ally-match {collapse,separate}
                        Allegiance matching for borders, default [collapse]

Routes:
  Route generation options

  --routes {trade,comm,xroute,owned,none,trade-mp}
                        Route type to be generated, default [trade]
  --min-btn BTN         Minimum BTN used for route calculation, default [13]
  --min-route-btn ROUTE_BTN
                        Minimum btn for drawing on the map, default [8]
  --max-jump {1,2,3,4,5,6,7,8,9,10}
                        Maximum jump distance for trade routes, default [4]
  --pop-code {fixed,scaled,benford}
                        Interpretation of the population modifier code, default [scaled]
  --route-reuse ROUTE_REUSE
                        Scale for reusing routes during route generation
  --ru-calc {scaled,negative}
                        RU calculation, default [scaled]
  --speculative-version {CT,T5,None}
                        version of the speculative trade calculations, default [CT]
  --mp-threads MP_THREADS
                        Number of processes to use for trade-mp processing, default 7

Output:
  Output options

  --output OUTPUT       output directory for maps, statistics
  --owned-worlds, --no-owned-worlds
                        Generate the owned worlds report, used for review purposes (default: False)
  --trade, --no-trade   Generate trade data with route information (default: True)
  --maps, --no-maps     Generate sector level trade maps (default: True)
  --subsector-maps, --no-subsector-maps
                        Generate subsector level maps (default: True)
  --min-ally-count ALLY_COUNT
                        Minimum number of worlds in an allegiance for output, default [10]
  --json-data           Dump internal data structures as json for later further processing

Input:
  Source of data options

  --input INPUT         input directory for sectors
  --sectors SECTORS     file with list of sector names to process
  sector                T5SS sector file(s) to process

Debug:
  Debugging flags

  --debug, --no-debug   Turn on trade-route debugging (default: False)

The default values are scaled for the standards set by the Traveller world generation used in the T5 Second Survey and, by extension, the values used by most of the Traveller world generation systems. The parameters are present to allow generating routes in areas where the worlds don't conform to Imperial standards.

borders select the algorithm used to draw the borders between various allegiances. none sets no borders on the map. range (the default) uses the border generation from the nroute.c code. allygen is based upon the allygen code created by J. Greely. erode is based upon the border system from TravellerMap.

ally-match determine how the more detailed T5 allegiance codes are either grouped or separated to determine where borders are drawn.

The min-btn argument sets the minimum BTN, trade levels between worlds. Where the calculated trade between two worlds is below this threshold the routes are ignored. This serves as an optimization to avoid calculating trade between two worlds which won't add much to the overall trade. The default value (13) works well for the Imperium, but for areas where worlds are less populous, or have lower TLs overall, setting this lower allow generating more routes.

The min-route-btn defines the minimum BTN drawn on the map. The default (8) is scaled for the Imperial standard. For poorer areas, setting this lower will include routes for more worlds. The min-route-btn and min-btn work together to produce a better map. For optimal results set min-btn to min-route-btn * 2 - 1 (15 for the default settings).

max-jump selects the maximum distance used for trade route generation. Changing this can be based on jump drive availability. For lower TL areas or eras, setting this to 2 or 3 makes the rules reflect an earlier era. For an area where the stars are spread, set to 5 or 6 to include routes across the gaps.

min-ally-count controls which allegiance codes are output in the alleg_summary.wiki file. The value is the minimum number of worlds in an empire to be includes in the output. The default is 10 worlds. For a map with many small empires setting this to 0 to include all of them in the output file.

pop-code controls the interpretation of the population modifier. fixed is the standard Traveller interpretation of the code. benford re-distributes, using a random number generator, the existing population codes to match Benford's Law. This produces a more accurate population distribution, and reduces the population by about 30%. scaled treats the value as a index into a scaled array of values, attempting to produce the same results as the benford population multiplier, but without the random generation.

owned-worlds is used by the T5 Second Survey team to verify the owned (Government type 6) worlds have a valid controlling world government. When enabled it produces an owned-worlds.txt report. This report lists each owned world, the current listed owner (if any), and a list of candidate worlds

The routes option select the route processing for drawing on the map. The trade option drawn the trade routes as described above. The comm option drawn a communications network, connecting the most important worlds, capitals, naval depots, and scout way stations within the various empires. xroute is a second option to draw a communications route for the Imperial sectors. none produces maps with no routes drawn. The last option is useful for producing the statistical output without the longer route production time.

The trade-mp option for the routes option generates the routes like the trade option does, but does so using multiple external processes for the longer route processing. This allows better performance for the lengthy route generation process, a 50% improvement has been seen in some testing. There are some things to be aware of before using this option:

  1. The routes generated by the trade-mp will be different, though equally valid, from the set generated by the trade option
  2. The processes are CPU bound. If you set the --mp-threads to a value larger than the default may result in the processes waiting for the cpu and taking longer than you expect.
  3. The extra processes can take significant memory. The Imperial sectors during processing takes 1GB of active RAM, where the MP version can take 8GB or more. If you run out of free memory your OS will start swapping to disk and this can be slower than just a single threaded process.

The route-reuse option affects the trade route generation. As routes are generated from larger WTN worlds to smaller WTN worlds, the system prefers to use an already established (probably large) route even if it is slightly longer (in both parsecs and number of jumps). The default value is 10, and is an arbitrary value. Setting this lower results in more main routes with a few spiky connectors. Setting it higher results in many nearby (almost overlapping) routes. Setting it to 30 or above results in every short distance route being individually mapped.

Input format

PyRoute assumes the input files are the generated raw data files from Traveller Map. The raw data format is described here. PyRoute requires the header information, especially the sector name, location, subsectors list, and the Alleg information. The parser is not especially robust and will fail or produce unexpected results if the data is incorrectly formatted.

Output files

There are four types of output files:

1) The PDF maps. The data on the maps, including the interpretations of the trade line colors is kept in the Trade map key. PyRoute generates one map per sector based upon the input files.

1) The raw route data. Two files called stars.txt and ranges.txt are the output of the two internal data structures PyRoute uses to generate the trade map. ranges.txt is the list of trade partner pairs. This is the list driving the route generation process. The stars.txt is the list of all possible routes of max-jump distances between each star. This list is trimmed of the longer, or unused routes. This list holds the final trade route information.

1) The wiki summary formatted for putting into the Traveller wiki in the Trade map summary page, and consisting of the following files:

1) The per sector generated data. PyRoute generates a fair amount of data including the trade information, economic data, passenger information, and armed forces numbers for each world. These files captures all of this data for each world, output in a similar format to the sector files.

1) As an option you can output the input data and generated statistics in json format. This contains the data as loaded from the source sector files, and the analysis done by the different internal processes.

Performance

The process takes between O(n^2) and O(n^3) processing time, meaning the more stars (and hence routes), the longer the process takes. Experimentation has shown:

Map Borders

PyRoute has four border generation algorithms, with one option for selection of allies.

ally-match option determines if similar allied groups are grouped as one empire, or separated into their component parts. The T5 Second Survey Allegiance codes are 4 characters. This allows identifying sub-groups within a larger empire. For example the Third Imperium (original code Im) now has different codes for each domain (for example, ImDe for the Domain of Deneb). Setting ally-match to collapse considered the worlds in the Domain of Deneb and the Domain of Vland to be in the same empire. Setting ally-match to separate determines these to be different empires and draws a border between the two domains.

The four systems for determining how borders are drawn are: