Prior Release Notes

Last Updated: December 2017

Information about prior releases is shown here.

Release 2.0.0

Powered by Miniconda Environment

  • Tethys Platform is now installed in a Miniconda environment.

  • Using the Miniconda includes Conda, an open source Python package management system

  • Conda can be used to install Python dependencies as well as system dependencies

  • Installing packages like GDAL or NetCDF4 are as easy as conda install gdal

  • Conda is cross platform: it works on Windows, Linux, and MacOS

See: Miniconda and Conda

Cross Platform Support

  • Develop natively on Windows, Mac, or Linux!

  • No more virtual machines.

  • Be careful with your paths.

See: Installation

Installation Scripts

  • Completely automated installation of Tethys

  • Scripts provided for Mac, Linux, and Windows.

See: Installation

Python 3

  • Experimental Python 3 Support in 2.0.0

  • Tethys Dataset Services is not completely Python 3 compatible

  • Use --python-version 3 option on the installation script

  • Python 2 support will be dropped in version 2.1

See: Installation

Templating API

  • Leaner, updated theme for app base template.

  • New header_buttons block for adding custom buttons to app header.

See: App Templating API

App Settings

  • Developers can create App Settings, which are configured in the admin interface of the Tethys Portal.

  • Types of settings that can be created include Custom Settings, Persistent Store Settings, Dataset Service Settings, Spatial Dataset Service Settings, and Web Processing Service Settings.

  • The way Tethys Services are allocated to apps is now done through App Settings.

  • All apps using the Persistent Stores APIs, Dataset Services APIs, or Web Processing Services APIs prior to version 2.0.0 will need to be refactored to use the new App settings approach.

See: App Settings API

Commandline Interface

  • Added tethys list command that lists installed apps.

  • Completely overhauled scaffold command that works cross-platform.

  • New options for scaffold command that allow automatically accepting the defaults and overwriting project if it already exists.

See: list and scaffold <name>


  • Brand new Getting Started Tutorial

  • Demonstration of most Tethys SDK APIs

See: Getting Started


  • New way to call them

  • New load dependencies Method

  • Updated select_gizmo to allow Select2 options to be passed in.

See: Template Gizmos API

Map View

  • Updated OpenLayers libraries to version 4.0

  • Fixes to make MapView compatible with Internet Explorer

  • Can configure styling of MVDraw overlay layer

  • New editable attribute for MVLayers to lock layers from being edited

  • Added data attribute to MVLayer to allow passing custom attributes with layers for use in custom JavaScript

  • A basemap switcher tool is now enabled on the map with the capability to configure multiple basemaps, including turning the basemap off.

  • Added the ability to customize some styles of vector MVLayers.

See: Map View

Esri Map View

  • New map Gizmo that uses ArcGIS for JavaScript API.

See: ESRI Map

Plotly View and Bokeh View Gizmos

  • True open source options for plotting in Tethys

See: Bokeh View and Plotly View

DataTable View Gizmos

  • Interactive table gizmo based on Data Tables.

See: DataTable View


  • Sessions will now timeout and log user out after period of inactivity.

  • When user closes browser, they are automatically logged out now.

  • Expiration times can be configured in settings.

See: Tethys Platform Settings

HydroShare OAuth Backend and Helper Function

  • Refactor default HydroShare OAuth backend; Token refresh is available; Add backends for HydroShare-beta and HydroShare-playground.

  • Include hs_restclient library in requirements.txt; Provide a helper function to help initialize the hs object based on HydroShare social account.

  • Update python-social-auth to 0.2.21.

See: Social Authentication


  • Fixed issue where tethys uninstall <app> command was not uninstalling fully.

Release 1.4.0

App Permissions

  • There is now a formalized mechanism for creating permissions for apps.

  • It includes a permission_required decorator for controllers and a has_permission method for checking permissions within controllers.

Tags for Apps

  • Apps can be assigned tags via the "tags" property in

  • App tags can be overriden by portal admins using the Installed Apps settings in the admin portal.

  • If there are more than 5 app tiles in the apps library, a list of buttons, one for each tag, will be displayed at the top of the Apps Library page.

  • Clicking on one of the tag buttons, will filter the list of displayed apps to only those with the selected tag.

Terms and Conditions Management

  • Portal Admins can now manage and enforce portal-wide terms and conditions and other legal documents.

  • Documents are added via the admin interface of the portal.

  • Documents can be versioned and dates at which they become active can be set.

  • Once the date passes, all users will be prompted to accept the terms of the new documents.


Tethys Docker CLI

  • Modified behaviour of "-c" option to accept a list of containers names so that commands can be performed on subsets of the containers

  • Improved behaviour of "start" and "stop" commands such that they will start/stop all installed containers if some are not installed

  • Improved behaviour of the "remove" command to skip containers that are not installed

Select2 Gizmo

MapView Gizmo

  • New JavaScript API endpoints for the MapView.

  • Use the TETHYS_MAP_VIEW.getSelectInteraction() method to have more control over items that are selected.

  • MVLayer Select Features now supports selection of vector layers in addition to the WMS Layers.

  • Added support for images in the legend including support for GeoServer GetLegendGraphic requests.

PlotView Gizmo

  • New JavaScript API endpoints for initializing PlotViews dynamically.

Workflow Job Type

  • New Condor Workflow provides a way to run a group of jobs (which can have hierarchical relationships) as a single job.

  • The hierarchical relationships are defined as parent-child relationships between jobs.

  • As part of this addition the original Condor Job type was refactored and, while backwards compatibility is maintained in version 1.4, several aspects of how job templates are defined have been deprecated.

Testing Framework

  • New Tethys CLI command to run tests on Tethys and apps.

  • Tethys SDK now provides a TethysTestCase to streamlines app testing.

  • Persistent stores is supported in testing.

  • Tethys App Scaffold now includes testing module with example test code.


  • Installation Instructions for Ubuntu 16.04

Bug Fixes

  • Fixed an issue with URL mapping that was masking true errors with contollers (see: Issue #177)

  • Fixed an issue with syncstores that use the string version of the path to the intializer function (see: Issue #185)

  • Fixed an issue with syncstores that would cause it to fail the first time (see: Issue #194)

Release 1.3.0

Tethys Portal

  • Open account signup disabled by default

  • New setting in that allows open signup to be enabled

Map View

  • Feature selection enabled for ImageWMS layers

  • Clicking on features highlights them when enabled

  • Callback functions can be defined in JavaScript to trap on the feature selection change event

  • Custom styles can be applied to highlighted features

  • Basemap can be disabled

  • Layer attributes can be set in MVLayer (e.g. visibility and opacity)

  • Updated to use OpenLayers 3.10.1

Plot View

  • D3 plotting implemented as a free alternative to Highcharts for line plot, pie plot, scatter plot, bar plot, and timeseries plot.

Spatial Dataset Services

  • Upgraded gsconfig dependency to version 1.0.0

  • Provide two new methods on the geoserver engine to create SQL views and simplify the process of linking PostGIS databases with GeoServer.

App Feedback

  • Places button on all app pages that activates a feedback form

  • Sends app-users comments to specified developer emails

  • Includes user and app specific information


  • Handoff Manager now available, which can be used from controllers to handoff from one app to another on the same Tethys portal (without having to use the REST API)

  • The way handoff handler controllers are specified was changed to be consistent with other controllers

Jobs Table Gizmo

  • The refresh interval for job status and runtime is configurable

Social Authentication

  • Support for HydroShare added

Dynamic Persistent Stores

  • Persistent stores can now be created dynamically (at runtime)

  • Helper methods to list persistent stores for the app and check whether a store exists.

App Descriptions

  • Apps now feature optional descriptions.

  • An information icon appears on the app icon when descriptions are available.

  • When the information icon is clicked on the description is shown.


  • Missing initial value parameter was added to the select and select2 gizmos.

  • Addressed several cases of mixed content warnings when running behind HTTPS.

  • The disconnect social account buttons are now disabled if your account doesn't have a password or there is only one social account associated with the account.

  • Fixed issues with some of the documentation not being generated.

  • Fixed styling issues that made the Message Box gizmo unusable.

  • Normalized references to controllers, persistent store initializers, and handoff handler functions.

  • Various docs typos were fixed.

Release 1.2.0

Social Authentication

  • Social login supported

  • Google, LinkedIn, and Facebook

  • HydroShare coming soon

  • New controls on User Profile page to manage social accounts

D3 Plotting Gizmos

  • D3 alternatives for all the HighCharts plot views

  • Use the same plot objects to define both types of charts

  • Simplified and generalized the mechanism for declaring plot views

Job Manager Gizmo

  • New Gizmo that will show the status of jobs running with the Job Manager


  • SDK methods for creating and managing workspaces for apps

  • List files and directories in workspace directory

  • Clear and remove files and directories in workspace


  • Use handoff to launch one app from another

  • Pass arguments via GET parameters that can be used to retrieve data from the sender app

Video Tutorials

  • New video tutorials have been created

  • The videos highlight working with different software suite elements

  • CKAN, GeoServer, PostGIS

  • Advanced user input forms

  • Advanced Mapping and Plotting Gizmos

New Location for Tethys SDK

  • Tethys SDK methods centralized to a new convenient package: tethys_sdk

Persistent Stores Changes

  • Moved the get_persistent_stores_engine() method to the TethysAppBase class.

  • To call the method import your app class and call it on the class.

  • The old get_persistent_stores_engine() method has been flagged for deprecation.

Command Line Interface

  • New management commands including createsuperuser, collectworkspaces, and collectall

  • Modified behavior of syncdb management command, which now makes and then applies migrations.

Release 1.1.0


  • Options objects for configuring gizmos

  • Many improvements to Map View

    • Improved layer support including GeoJSON, KML, WMS services, and ArcGIS REST services

    • Added a mechanism for creating legends

    • Added drawing capabilities

    • Upgraded to OpenLayers version 3.5.0

  • New objects for simplifying Highcharts plot creation

    • HighChartsLinePlot

    • HighChartsScatterPlot

    • HighChartsPolarPlot

    • HighChartsPiePlot

    • HighChartsBarPlot

    • HighChartsTimeSeries

    • HighChartsAreaRange

  • Added the ability to draw a box on Google Map View

Tethys Portal Features

  • Reset forgotten passwords

  • Bypass the home page and redirect to apps library

  • Rename the apps library page title

  • The two mobile menus were combined into a single mobile menu

  • Dataset Services and Web Processing Services admin settings combined into a single category called Tethys Services

  • Added "Powered by Tethys Platform" attribution to footer

Job Manager

  • Provides a unified interface for all apps to create submit and monitor computing jobs

  • Abstracts the CondorPy module to provide a higher-level interface with computing jobs

  • Allows definition of job templates in the module of apps projects

Documentation Updates

  • Added documentation about the Software Suite and the relationship between each software component and the APIs in the SDK is provided

  • Documentation for manual download and installation of Docker images

  • Added system requirements to documentation

Bug Fixes

  • Naming new app projects during scaffolding is more robust

  • Fixed bugs with fetch climate Gizmo

  • Addressed issue caused by usernames that included periods (.) and other characters

  • Made header more responsive to long names to prevent header from wrapping and obscuring controls

  • Fixed bug with tethys gen apache command

  • Addressed bug that occurred when naming WPS services with uppercase letters


  • Added parameter of UrlMap that can be used to specify custom regular expressions for URL search patterns

  • Added validation to service engines

  • Custom collectstatic command that automatically symbolically links the public/static directories of Tethys apps to the static directory

  • Added "list" methods for dataset services and web processing services to allow app developers to list all available services registered on the Tethys Portal instance