This is the documentation repository for the HIEv / DIVER automated research data captures application. HIEv / DIVER consists of a number of source code repositories, the primary repo is dc21.
DIVER (Data Is Vital for Empirical Research) is a research data capture and sharing application. HIEv / DIVER has extensive APIs and tools that enable automated data capture, analysis and publishing. HIEv / DIVER was originally developed by Intersect Australia for the Hawkesbury Institute for the Environment at the Western Sydney Unversity as part of ANDS Data Capture Project [DC21] (https://projects.ands.org.au/id/DC21) in 2012/2013.
HIEv / DIVER is a Ruby on Rails application for the management of environmental data, predominantly time-series from Campbell Scientific Loggers, but also for NETCDF, NCML format data and any general purpose data.
If you are contemplating an automated data capture project, or would just like more information about HIE / DIVER, please email enquiries@intersect.org.au.
If you need support for your HIEv / DIVER instance, please email help@intersect.org.au.
The HIEv / DIVER code is licensed under the GNU GPL v3 license - see LICENSE.txt.
Contact Intersect to determine which versions are currently supported.
| Version | Date | Repo Links | Version Documents | Summary |
|---|---|---|---|---|
| 2.4 | Sep 2016 | App, Doc, RESTful API uploader, EyeTracker Packager, Python Wrapper | Release Notes, User Manual | Added new metadata fields Creator and Contributors for file upload and package creation. Plus bug fixes. |
| 2.3.3 | April 2017 | App, Doc, RESTful API uploader, EyeTracker Packager, Python Wrapper | Release Notes, User Manual | APIs for creating and publishing packages, File Edit API, enriched RIF-CS support. |
| 2.2 | Jun 2015 | App, Doc, RESTful API uploader, EyeTracker Packager, Python Wrapper | User Manual | NETCDF support and Python Wrapper |
| 2.1.02 | Jun 2014 | App, Doc, RESTful API uploader, EyeTracker Packager | Release Notes, User Manual | Access Control |
| 2.0.01 | Dec 2013 | App, Doc, RESTful API uploader, EyeTracker Packager | DocFiles.zip | Org Structure and Tags |
| 1.9.04 | Mar 2012 | App, Doc, RESTful API uploader, | DocFiles.zip | Packaging and Publishing |
- Product Overview
- Cucumber Features - these are automated acceptance tests that express (in plain English) the requirements of the system. Apart from the User Manual and Release Notes, this is a great place to start if you want to get an understanding of what the system does. There's a number of different ways to access them:
- Browse on Github.
- Clone the repository and browse in your preferred tool.
- Overview Diagram
- Deployment Guide - instructions on how to install the web application and do subsequent updates.
- Setting Up Automated Load From PC - how to automatically send files to DC21 from a PC
- Loading external template files - how to tell the web application to read an external template file for README.html without redeploying
- Developers Guide - useful information for future developers of the application.
- Development Environment Setup - instructions for setting up a dev environment.
- Domain Model - overview of the domain concepts in the system.
- RIFCS Mapping - details of the RIFCS records produced by the system.
- File Upload API - details of the API for automatically uploading/downloading files
- File Update API - details of the API for updating metadata of data files (version 2.3 onwards)
- Org Structure List API - details of the API to extract the DIVER organisational structure (version 2.2 onwards)
- Search API - details of the API for scripting search
- Package Create API - details of the API for creating packages (version 2.3 onwards)
- Package Publish API - details of the API for publishing packages (version 2.3 onwards)
- Variable List API - details of the API to extract DIVER column mappings and variables (version 2.2 onwards)
- RSpec tests - the RSpec examples express the detailed requirements so are a good place to start getting an understanding of what the system does. There's a number of different ways to access them:
- Browse on Github.
- Clone the repository and browse in your preferred tool.
DIVER software development has been funded by the Australian National Data Service (ANDS, http://ands.org.au), Western Sydney University, Macquarie University and Intersect. ANDS is supported by the Australian Government through the National Collaborative Research Infrastructure Strategy Program (NCRIS) and the Education Investment Fund (EIF) Super Science Initiative.