Skip to content

Main content

River Flow Percentile and Ensemble Range Source Code

Browse the implementation files for River Flow Percentile and Ensemble Range.
tool.ts typescript
import { parseFiniteNumberList } from '../../parse/numeric-dataset/tool';
import { parseFiniteNumber } from '../../parse/number/tool';

const quantile = (
	values: number[],
	probability: number
): number => {
	const sorted = [...values].sort((a, b) => a - b);
	const position = (sorted.length - 1) * probability;
	const lower = Math.floor(position);
	const fraction = position - lower;
	return (
		sorted[lower] +
		(sorted[Math.min(lower + 1, sorted.length - 1)] -
			sorted[lower]) *
			fraction
	);
};

export const analyzeRiverFlowPercentiles = (
	currentInput: unknown,
	historicalInput: unknown,
	ensembleInput: unknown
): string => {
	const current = parseFiniteNumber(currentInput);
	const historical = parseFiniteNumberList(historicalInput);
	const ensemble = parseFiniteNumberList(ensembleInput);
	if (
		current === null ||
		current < 0 ||
		!historical ||
		!ensemble ||
		historical.some((value) => value < 0) ||
		ensemble.some((value) => value < 0)
	)
		return '';
	const percentileRank =
		(historical.filter((value) => value <= current).length /
			historical.length) *
		100;
	return JSON.stringify(
		{
			current,
			ensemble: {
				maximum: Math.max(...ensemble),
				minimum: Math.min(...ensemble),
				p10: quantile(ensemble, 0.1),
				p50: quantile(ensemble, 0.5),
				p90: quantile(ensemble, 0.9)
			},
			historical: {
				currentPercentile: Number(
					percentileRank.toPrecision(8)
				),
				p10: quantile(historical, 0.1),
				p50: quantile(historical, 0.5),
				p90: quantile(historical, 0.9)
			}
		},
		null,
		2
	);
};

export const Tool: TypeTool = {
	name: 'River Flow Percentile and Ensemble Range',
	slug: 'hydrology/river-flow-percentiles',
	intro:
		'Compare current river flow with historical percentiles and summarize an ensemble forecast range.',
	tool: analyzeRiverFlowPercentiles,
	i: [
		{
			example: '150',
			label: 'Current Flow',
			placeholder: 'Current discharge',
			type: 'number'
		},
		{
			example: '80,100,120,140,160,180,200',
			label: 'Historical Flows',
			placeholder: 'Historical comparison values',
			render: 'textarea',
			type: 'text'
		},
		{
			example: '130,145,155,170,190',
			label: 'Ensemble Members',
			placeholder: 'Forecast ensemble values',
			render: 'textarea',
			type: 'text'
		}
	],
	o: [
		{
			example: '{ "ensemble": { "p50": 155 } }',
			label: 'Flow Context',
			placeholder: 'Percentiles will appear here...',
			render: 'textarea',
			type: 'text'
		}
	]
};
export default Tool;

Description

Browse the implementation files for River Flow Percentile and Ensemble Range.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools