Welcome to the Aquatic Informatics open source offerings on GitHub. Hopefully this guide can get you pointed in the right direction.
You may have been directed here, and are just looking to download some prepackaged tool or extension for an AQUARIUS product you own. The GitHub web pages are very programmer-centric, and it can be a bit hard to navigate and find the specific files you need.
| AQUARIUS Product | Download link | Documentation | Description |
|---|---|---|---|
| AQUARIUS Time-Series 2017.3+ | ReportRunner.exe | Here | The ReportRunner.exe tool is a command-line tool for running reports on an AQTS system. It can also wait for the report to be rendered by the app server and download the generated PDF or CSV.The ReportRunner.exe tool is also included in the "201X.Y.Reports.zip" archives above. |
| AQUARIUS Time-Series 2021.1+ | 2021.1 R-based report plugins | Operation and Installation | This ZIP archive contains 1 report plugin (the Profile Report), which uses the R runtime to render its output. Use the System Config page to install this plugin, and run the InstallMissingPackages.cmd script with Administrator priveleges to install the required R runtime and package dependencies. |
| AQUARIUS Time-Series 3.x and 20xx | Sample field data files | Here | This page lists a description of each field data file formats supported by AQUARIUS Time-Series. A sample of each file type is provided for download. |
| AQUARIUS Time-Series 3.x | FlowTracker2Converter.exe | Here | Use this GUI tool to convert FlowTracker2 *.ft files into FlowTracker1 *.dis files which can be imported into your AQTS 3.X system. |
| AQUARIUS Time-Series 20xx | FlowTracker2Plugin.plugin | Here | A field data plugin to import FlowTracker2 *.ft discharge measurements. |
| AQUARIUS Time-Series 2019.4+ | TabularCsv.plugin | Here | A user-configurable field data plugin to import nearly any field visit activity from a CSV file. |
| AQUARIUS Time-Series 2018.4+ | JsonFieldData.plugin | Here | A field data plugin to import visits from JSON files. Used by the FieldVisitHotFolderService. |
| AQUARIUS Time-Series 2018.4+ | MultiFile.plugin | Here | A field data plugin to import visits from ZIP archives containing other plugin visit data files. |
| AQUARIUS Time-Series 20xx | SxSPro.plugin | Here | A field data plugin to import discharge summary XML measurements from Teledyne SxS Pro software. |
| AQUARIUS Time-Series 20xx | AquaCalc5000.plugin | Here | A field data plugin to import discharge summary measurements from AquaCalc 5000 CSV files. |
| AQUARIUS Time-Series 202x | QRev.plugin | Here | A field data plugin to import discharge summary XML measurements from USGS QRev software. |
| AQUARIUS Time-Series 2018.4+ | FieldVisitHotFolderService.zip | Here | A Windows service which can monitor a folder for field visit files and upload visits to AQTS. |
| AQUARIUS Time-Series 20xx | UserImporter.exe | Here | A console tool for quickly provisioning users in your AQTS system from a CSV file. |
| AQUARIUS Time-Series 20xx | PointZilla.exe | Here | A console tool for quickly appending points to a time-series. |
| AQUARIUS Time-Series 20xx | TimeSeriesChangeMonitor.exe | Here | A console tool for monitoring how quickly changes in a time-series become available on the Publish API. Use it along side PointZilla to precisely measure the behaviour of your data flow. |
| AQUARIUS Time-Series 20xx | LocationDeleter.exe | Here | A console tool for deleting locations and/or visits and/or time-series during initial system configuration. You obviously won't want to run this on a production system. |
| AQUARIUS Time-Series 20xx | ExcelCsvExtractor.exe | Here | A console tool for extracting sheets from an Excel workbook into individual CSV files. |
| AQUARIUS Time-Series 202x | OGC SOS Proxy | Here | An API proxy for exporting time-series data to an OCG SOS server as sensor observations, suitable for consumption by national aggregation systems like LAWA. |
| AQUARIUS Time-Series 20xx | ProvisioningTool.zip | Here | A console tool for performing bulk provisioning operations of an AQTS system from CSV data. The ZIP archive includes sample CSV files for many types of AQTS entities. |
| AQUARIUS Time-Series 20xx | RatingModelExchange.exe | Here | A console tool for importing and exporting rating models into AQTS 201x systems, supporting both HydroML formats (XML) and a simpler CSV format. |
| AQUARIUS Time-Series 20xx | AttachmentUploader.exe | Here | A console tool for uploading location and field visit attachments into AQTS 201x systems. |
| AQUARIUS Time-Series 3.x and 20xx AQUARIUS WebPortal AQUARIUS Connect |
SystemSizer.exe | Here | A console tool to run on an AQTS, WebPortal, or Connect app server and determine the basic size and configuration of the system. The SystemSizer.log file generated by this tool contains useful information when diagnosing issues with our Support Team. |
For product versions that are no longer officially supported:
| AQUARIUS Product | Download link | Documentation | Description |
|---|---|---|---|
| AQUARIUS Time-Series 20xx | SosExporter.exe | Here | A console tool for exporting time-series data to an OCG SOS server as sensor observations, suitable for consumption by national aggregation systems like LAWA. |
| AQUARIUS Time-Series 2019.2 |
2019.2 Report plugins | Operation and Installation | This ZIP archive contains 12 report plugins and a report plugin installer, to add more reporting features to AQTS 2019.2. Use the Report Plugin Installer tool, included in the ZIP archive, to install these plugins. |
| AQUARIUS Time-Series 2019.1 2018.4 |
2018.4 Report plugins | Operation and Installation | This ZIP archive contains 12 report plugins and a report plugin installer, to add more reporting features to AQTS 2018.4 and AQTS 2019.1. Use the Report Plugin Installer tool, included in the ZIP archive, to install these plugins. Starting with AQTS 2018.4, previous report plugins will be preserved. There is no longer a need to uninstall previous report plugins after upgrading to AQTS 2018.4. |
| AQUARIUS Time-Series 2018.3 | 2018.3 Report plugins | Operation and Installation | This ZIP archive contains 10 report plugins and a report plugin installer, to add more reporting features to AQTS 2018.3. Use the Report Plugin Installer tool, included in the ZIP archive, to install these plugins. Note that all beta report plugins from previous versions must be removed prior to installing the 2018.3 beta report plugins. The Report Plugin Installer tool can be used to uninstall 2018.2 report plugins and install 2018.3 report plugins. |
| AQUARIUS Time-Series 2018.2 | 2018.2 Report plugins | Operation and Installation | This ZIP archive contains 7 report plugins and a report plugin installer, to add more reporting features to AQTS 2018.2. |
We have many software projects that allow you to easily extend or integrate with your AQUARIUS products.
Some are full software projects, with contiuous integration and unit tests, deployed via standard package distribution networks like NuGet or the Maven Central Repository.
Other projects are smaller proof-of-concept examples, which can be a useful starting point or inspiration for your own integrations.
We have two SDK offerings, one for .NET and one for Java. These SDKs provide complete support for all the AQUARIUS products with public APIs (currently AQUARIUS Time-Series and AQUARIUS Samples, but more products will be added soon to these SDKs).
https://github.com/AquaticInformatics/aquarius-sdk-net - The .NET Platform SDK, available via NuGet. https://github.com/AquaticInformatics/aquarius-sdk-java - The Java Platform SDK, available via the Maven Central Repository.
The functionality within each SDK is equivalent, handling the fussy parts of consuming REST APIs robustly:
- Authentication
- Session management
- JSON serialization
- Error handling
- File upload events
- Version checking
With these fussy parts handled for you, your integration code can more succinctly focus on consuming the documented public APIs. Using one of the SDKs greatly improves your team's productivity when writing large integrations.
If you can choose your integration environment, we recommend using the .NET SDK over the Java SDK, simply because the .NET SDK is integrated into a number of AQUARIUS add-on products like AQUARIUS WebPortal, AQUARIUS DAS, AQUARIUS EnviroSCADA, and AQUARIUS Forecast. Since we use the .NET SDK internally for our own products, any issues tend to be noticed and resolved very quickly.
That said, the Java SDK is a fine choice if you prefer to work in Java, and we welcome any suggestions or contributions from the community to improve either SDK.
| Project | Description |
|---|---|
| https://github.com/AquaticInformatics/aquarius-field-data-framework | A field data plugin development framework, so you can write custom plugins to consume your organization's unique field data. The framework is available on NuGet and includes testing and packaging tools. |
| https://github.com/AquaticInformatics/flowtracker2-field-data-plugin | A plugin for parsing SonTek's FlowTracker2 *.ft files. |
| Python integration | A sample API wrapper for AQUARIUS Time-Series. |
| R integration | A fairly rich API wrapper for consuming time-series data in R. |
| https://github.com/AquaticInformatics/examples | Many examples, in many technologies. |
Aquatic Informatics hosts some open source software projects on GitHub at https://github.com/AquaticInformatics. These projects can provide sample code, freely-downloadable tools, and/or extensions compatible with AQUARIUS products.
You can use them at your own risk, according to each project's open source license terms, which are clearly disclosed on the home page of each open source repository. These offerings are not part of the official released packages and therefore are not supported under the regular Service and Maintenance Agreement.
Our Support Team tries their best to help you but if you have questions/issues, it is recommended that you raise an issue on the project's Issues page. Our GitHub projects are managed by our Applications Engineering Team and they will get back to you.
Each open source repository is governed by a code of conduct, derived from the from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4.
The basic summary is "don't be a jerk" and everything should be fine.