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.
  31
  32 By default, the output will be the time in hours and minutes of the
  33 specified leg. If you prefer, you can use the `-p` switch to get a
  34 "prettier" output.
  35
  36 ### Use as a library
  37
  38 You can also use Munter.py programmatically from Python, like so:
  39
  40 `import munter`
  41 `est = munter.time_calc(3.2, 2300, 'uphill', 'imperial')`
  42
  43 This will store a value like "3.04095" in the `est` variable.
  44
  45 Workflow
  46 --------
  47
  48 My workflow involves planning my tour using tools like ArcGIS or CalTopo. Then,
  49 I take the stats between each leg (distance, vertical gain/loss) of the tour
  50 and run them through Munter.py and record its output to my field
  51 notebook.
  52
  53 The rudimentary "GUI" can be directly transferred to e.g. the format used by
  54 SnowPit Technologies' "Avalanche Field Notebook" or your own personal format
  55 (e.g. RitR No. 471).
  56
  57 Future plans
  58 ------------
  59
  60 * Personal "fitness" switch (to help fine tune your estimates based on
  61                                                          your personal fitness level as observed
  62                                                          over time)
  63 * GTK mode
  64 * Use as a Python library from within another project
  65 * Lint it (e.g. therapist)
  66 * Pip?
  67 * Sphinx/autodoc?
  68
  69 Version History
  70 ---------------
  71
  72 - 2.0.1 (Jun 2020)
  73
  74   README improvement.
  75
  76 - 2.0.0 (Jun 2020)
  77
  78   Packaged for distribution as a standalone program (and library).
  79
  80 - 1.0.2 (Jun 2020)
  81
  82   A few small bugfixes.
  83
  84 - 1.0.1 (Jun 2020)
  85
  86   Add LICENSE and README.
  87
  88 - 1.0.0 (Jun 2020)
  89
  90   First released version. Includes sensible defaults and a rudimentary CLI
  91   "GUI".
  92
  93 - pre-1.0.0 (Mar 2017)
  94
  95   In use privately/internally since 2017.