Code Monkey home page Code Monkey logo

tsunami-db's Introduction

Web interface for "The New Zealand Palaeo-tsunami Database"

Project information on NIWA's teamwork: https://teamwork.niwa.co.nz/display/NZPTIS

--

Issues

Issues are used for

  • User Stories to specify functional requirements (labels: story, story must, story should, story could, story wont)
  • Tasks to help stay on top of things (label: tasks)
  • Discussion threads to keep all on the same page (label: discussion)
  • Bugs to track any software related bugs and issues (label: bug)

Standard View

GitHub's standard view of issues can be found here

https://github.com/dumparkltd/tsunami-db/issues

Agile View

A more flexible "agile" view, especially for categorising and prioritising user stories, is offered by Waffle.io

https://waffle.io/dumparkltd/tsunami-db

Note: When using Waffle.io for the first time you will have to grant it permission to access your GitHub account

--

Labels

Issues can be assigned to labels that you can find here

https://github.com/dumparkltd/tsunami-db/labels

--

Milestones

Issues can be assigned to milestones that you can find here

https://github.com/dumparkltd/tsunami-db/milestones

--

Deploy

Optimise and bundle

Optimisation and bundling is done using requirejs optimizer (see http://requirejs.org/docs/optimization.html for installing requirejs). Once installed, run from the repository root (branch master or whatever branch/tag you are seeking to deploy) r.js -o app/app.build.js This will generate all files inside a /build folder within the repository (you can changet the target directory here: https://github.com/dumparkltd/tsunami-db/blob/master/app/app.build.js#L4)

The content of the build folder can now be deployed to any webhost or commited to gh-pages (see below)

Commit to gh-pages branch

Unfortunately there is no automated deploy script in place to deploy to GitHub pages. To do so manually, follow these steps

Option A (recommended): assuming you have cloned the repository twice, once for the source branch (master, etc) and once for the target branch (gh-pages)

  1. delete content of target branch
  2. copy content of build folder to target branch
  3. commit changes (git add --all, git commit -m 'update message')
  4. publish changes to target/gh-pages branch (git push origin gh-pages or to force git push -f origin gh-pages:gh-pages)

Option B assuming you have cloned the repository only once

  1. copy content of build folder to a folder outside the repository
  2. switch to target branch (git checkout gh-pages)
  3. delete content of target branch
  4. copy content of folder outside repository to target branch
  5. commit changes (git add --all, git commit -m 'update message')
  6. publish changes to target/gh-pages branch (git push origin gh-pages or to force git push -f origin gh-pages:gh-pages)

tsunami-db's People

Contributors

aarondcole avatar craigstanton avatar dmprk avatar gasparmdq avatar robbinsje avatar tmfrnz avatar

Watchers

 avatar  avatar  avatar

tsunami-db's Issues

User learns about the different attributes

As a user

I want to learn the meaning of the different tsunami data attributes

so I can make sense of them

Notes:

  • could be provided via content API, additional database table, or static configuration file (eg JSON)

User exports scatter plot

As a user

I want to export and download an image of the scatter plot that visualises the filtered tsunami evidence data

so I can use it to embed in documents or share with my peers via email or social media

User learns about source regions and source locations

As a user

I want to learn about the rough geographic locations of source regions even if the exact source location is not known

Notes:

  • this would require an additional GIS layer (likely line data)
  • ideally the column content "source_location" would be converted to a source-location reference referencing a feature in the GIS layer

User selects color attribute for map visualisation

As a user

I want to select a representation attribute

so I can visually distinguish and analyse tsunami data that is visualised on the map

Notes:

  • attributes can be categorical or continuous
  • suitable visualisation options could be size, color, symbol (circle, square)

User selects size attribute for map visualisation

As a user

I want to select a secondary representation attribute

so I can better visually distinguish and analyse tsunami data that is visualised on the map

Notes:

  • attributes can be categorical or continuous
  • suitable visualisation options could be size, color, symbol (circle, square)
  • best practice is not to encode map markers with more than 2 variables

User filters tsunami data by inferred tsunami event

As a user

I want to get a list of all tsunami evidence data that belong to the same tsunami event

so I can assess how a specific tsunami event impacted different locations

Note:

  • the database currently does not include the concept of tsunami event
  • as a work around a subset of evidence data could possibly be identified by setting filters at once, for multiple source related attributes (source_location, sourcecertainty, source_lat. source_lon, source_cause) and age (age_max. age_min, time_scale). These could potentially be set from the single item view "show all data points with same source attributes" (see #10, #11)

Researcher exports tsunami data (csv)

As a data analyst

I want to download the tsunami data (all or subset) in a suitable format (CSV, GEOJSON)

to further process and analyse the data

User visualises tsunami records on map

As a user

I want to visualise the locations of the tsunami evidence data (all or subset) on a map of New Zealand

so I can assess the geographic distribution of known tsunamis

Basemap provides contextual information

As a user

I want the map to provide me with relevant contextual information, such as ocean depths, administrative regions, populated places, ocean and land feature names

so I can better relate to the information presented

Project set-up (GitHub)

Set up project in GitHub and Waffle.io

  • this repository
  • README
  • Waffle.io
  • Labels
  • Milestones
  • Initial tasks (issues)
  • User stories (issues

User prints map

As a user

I want to export and download the map that visualises the filtered tsunami evidence data as an image

so I can use it to embed in documents or share with my peers via email or social media

Inspiration and related resources

Use this thread to post and discuss relevant resources that may serve as an inspiration for ways tsunami data can be visualised or users can interact with data.

User visualises tsunami data as bar chart

As a user

I want to visualise the tsunami evidence data (all or subset) by a specific attribute as a bar chart

to facilitate comparison

Notes:

  • only suitable for numerical attributes (continuous scale)

User can share application

As a user

I want to share a link to the application with my peers via email or social media

so they can explore the database

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.