Skip to content

Field-work app for streamflow calculations and report building

License

Notifications You must be signed in to change notification settings

mijdavis2/upstream

Repository files navigation

UpStream

UpStream is a stream flow calc utility designed for Trout Unlimited, a national non-profit organization whose mission is to "conserve, protect and restore North America's coldwater fisheries and their watersheds".

NOTE: Worked perfect on Windows 8 tablets. Windows 10 introduced some very wonky behavior such as single click submissions lagging and windows keyboard popping up after scrolling. The app still works but is more annoying to use. Currently investigating.

Features:

  • Generate comprehensive stream flow csv reports through a feature rich cross-platform native app.
  • Auto generate data input forms from start bank, end bank, and desired number of stations.
  • Auto-fill dates and times.
  • Calculate discharge on the fly through the app.
  • Store site names and IDs in a pick-list.
  • Pick from multiple flow meters which generate fully formatted equasions in the csv/excel export.
  • Work easy knowing that a temp file is saved on every keystroke - if your device battery dies or the app crashes, you'll never lose data.
  • Email csv reports directly from the app (in beta).

Table of Contents generated with DocToc

Install

Go to the releases page and download the appropriate package:

  • Windows: UpStream Setup [version].exe

    • double click after download to install - ignore any windows store warnings
  • Linux: upstream-[version]-x86_64.AppImage

    • if necessary, chomd +x, then run as any other binary to install

CSV generation

v2.0.0 UPDATE: reports are now semicolon separated to support commas in text fields. Be sure to un-select Comma under Separator Options when importing in excel.

When importing csv files created by Upstream use the following settings:

  • Character set: Unicode (UTF-8)
  • From row: 1
  • Separator Options:
    • Separated by
      • Semicolon
  • Text Delimiter: "

Develop

This project was generated with electron-vue using vue-cli. Documentation about the original structure can be found here.

This project utilizes vuex for state storage and GitHub's primer-css framework as a styling base.

Requirements

  • node == 8.2.1 (version of node used by electron)
  • npm >=5.7.1
# install dependencies
npm install 
# OR
npm ci

# serve with hot reload at localhost:9080
npm run dev

# run unit & end-to-end tests
npm test

# lint all JS/Vue component files in `src/`
npm run lint

Build

npm run build

Publish

npm run publish

License

Software: MIT (c) 2017

Icons: