README.md

   1 Munter.py
   2 =========
   3
   4 Helps you speed up your tour and trip planning.
   5
   6 Disclaimer
   7 ----------
   8
   9 The time calculations produced by this program are not guaranteed to be
  10 accurate. Any harm or hazard encountered due to blindly trusting these
  11 estimates is your own fault.
  12
  13 Installation
  14 ------------
  15
  16 If you use pip, then simply `pip install munter.py`.
  17
  18 If you don't use pip, then download the source code and unpack it into
  19 its own directory. You can invoke it directly via `python munter.py
  20 [options]`.
  21
  22 How to use it
  23 -------------
  24
  25 For detailed information, see:
  26
  27 `./munter.py --help`
  28
  29 The program supports both imperial and metric, and has four "travel
  30 modes" at this time: uphill, flat, downhill, bushwhacking. It also
  31 supports a simple fitness modifier: slow, average, fast.
  32
  33 By default, the output will be the time in hours and minutes of the
  34 specified leg. If you prefer, you can use the `-p` switch to get a
  35 "prettier" output.
  36
  37 ### Use as a library
  38
  39 You can also use Munter.py programmatically from Python, like so:
  40
  41 `import munter`
  42 `est = munter.time_calc(distance=3.2, elevation=2300, fitness='slow')`
  43
  44 This will store a value like "3.64914" in the `est` variable.
  45
  46 Workflow
  47 --------
  48
  49 My workflow involves planning my tour using tools like ArcGIS or CalTopo. Then,
  50 I take the stats between each leg (distance, vertical gain/loss) of the tour
  51 and run them through Munter.py and record its output to my field
  52 notebook.
  53
  54 The rudimentary "GUI" can be directly transferred to e.g. the format used by
  55 SnowPit Technologies' "Avalanche Field Notebook" or your own personal format
  56 (e.g. RitR No. 471).
  57
  58 Future plans
  59 ------------
  60
  61 * GTK mode
  62 * Use as a Python library from within another project
  63 * Lint it (e.g. therapist)
  64 * Sphinx/autodoc?
  65
  66 Version History
  67 ---------------
  68
  69 - 2.1.0 (Jun 2020)
  70
  71   Implement fitness modifier. Make some text changes and other
  72   miscellaneous and minor improvements.
  73
  74 - 2.0.1 (Jun 2020)
  75
  76   README improvement.
  77
  78 - 2.0.0 (Jun 2020)
  79
  80   Package for distribution as a standalone program (and library).
  81
  82 - 1.0.2 (Jun 2020)
  83
  84   A few small bugfixes.
  85
  86 - 1.0.1 (Jun 2020)
  87
  88   Add LICENSE and README.
  89
  90 - 1.0.0 (Jun 2020)
  91
  92   First released version. Includes sensible defaults and a rudimentary CLI
  93   "GUI".
  94
  95 - pre-1.0.0 (Mar 2017)
  96
  97   In use privately/internally since 2017.