PyDIET 0.9.3__py3-none-any.whl

pydiet/web_client/images/logo.svg

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="108.1mm" height="127.5mm" version="1.1" viewBox="0 0 408.7 482" xmlns="http://www.w3.org/2000/svg">
+ <g transform="translate(-381.2 -371.7)">
+  <path d="m397.6 853.4-0.626-0.2547v-190.1l1.584-0.608h113.2l1.937 1.037v67.99l-0.304 0.7921-0.304 0.7922h-40.35l-0.3192-1.272-0.3192-1.272 0.0462-12.82 0.0462-12.82-0.4393-0.4393-0.4394-0.4394-32.99 0.2644v107.7l33.8 0.2638 5e-3 -0.6326 5e-3 -0.6327 0.1203-13.67 0.1202-13.67 1.502-0.9493 38.24-0.018 0.787 0.7869 0.787 0.787v68.5l-1.906 1.02-113.5-0.0583-0.626-0.2548zm149.9-0.1624-19.53-0.2593-0.1265-94.6-0.1265-94.6 1.127-1.358 113.3 0.018 2.254 0.604v40.33l-2.254 0.6039-72.17 0.018-1.202 1.202v31.23l1.347 1.118 74.02 0.2569v40.57l-74.02 0.2569-1.347 1.118v72.79l-1.202 1.202-0.5509-0.2327zm130.8 0.1104-19.4-0.1311-0.1278-94.02-0.1278-94.02 0.7307-2.265 40.34 0.2618 0.2585 37.06 0.2585 37.06 0.1171 0.1252 0.1171 0.1251h32.99l0.8103-1.252 0.2504-36.56 0.2504-36.56h40.57v189.8h-40.57l-0.2504-35.81-0.2504-35.81-0.8103-1.252h-32.89l-0.608 1.584v71.42l-2.254 0.3672zm-282.9-206.6-0.6296-1.128-1.311-3.506-4.862-15.02-1.569-6.01-1.507-6.51-1.466-7.011-1.559-10.52-1.277-10.52v-29.55l1.311-11.52 1.474-9.515 1.621-8.013 0.8759-3.756 0.8759-3.756 1.076-3.957 1.076-3.957 3.898-11.62 1.912-5.008 4.25-10.02 5.772-11.52 2.255-4.006 5.102-8.514 7.479-11.02 6.229-8.013 7.728-9.014 8.709-9.014 8.971-8.112 2.934-2.405 3.577-3.083 10.02-7.454 7.011-4.599 4.507-2.872 1.671-1.022 2.836-1.601 13.52-7.102 12.02-5.17 8.013-2.949 10.52-3.347 5.509-1.506 6.01-1.629 4.507-0.2346v275.9l-148.5 0.2537zm231.2 0.4992-0.2377-0.626 0.2565-274.9 4.507 0.2346 6.01 1.629 5.509 1.506 10.52 3.347 8.013 2.953 7.512 3.216 6.51 3.008 3.506 1.688 8.013 4.369 3.736 2.339h0.4499l6.331 4.132 5.509 3.629 10.02 7.435 3.579 3.083 5.436 4.471 16.63 16.56 7.406 9.059 3.506 4.341 3.947 5.631 4.486 6.51 5.479 9.014 3.023 5.509 5.257 10.52 4.168 10.02 1.308 3.005 1.735 5.008 0.8162 2.003 3.034 10.02 2.083 8.514 0.9399 3.506 1.115 5.509 1.42 8.514 1.724 15.52 0.015 13.52 0.0151 13.52-1.324 13.52-1.472 9.014-0.7641 3.756-0.7641 3.756-0.7305 3.255-0.7306 3.255-0.7277 2.632-0.7277 2.632-1.637 5.753-1.483 4.507-1.483 4.507-0.8614 2.003-2.012 4.758h-148.3l-0.2377-0.626z" fill="#234290" stroke-width=".5008"/>
+ </g>
+</svg>

pydiet/web_client/js/dom.js

@@ -0,0 +1,51 @@
+// DOM manipulation routines
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under GPL v3
+
+// Inject HTML in the selected node.
+export function inject_html(selector, html) {
+	parent = document.querySelector(selector)
+	if (parent.firstElementChild) {
+		parent.firstElementChild.remove();
+		parent.innerHTML = "";
+	}
+	parent.insertAdjacentHTML("beforeend", html);
+
+	// Now find scripts inside what was inserted and re-insert them
+	const scripts = parent.querySelectorAll('script');
+	scripts.forEach(oldScript => {
+		// Only re-run scripts that came from our insertion:
+		// (If needed, scope this by inserting into a wrapper element and querying inside it.)
+		const newScript = document.createElement('script');
+
+		// Copy attributes (type, src, nonce, etc.)
+		for (const { name, value } of oldScript.attributes) {
+			newScript.setAttribute(name, value);
+		}
+
+		if (oldScript.src) {
+			// External script
+			newScript.src = oldScript.src;
+			// Optional: preserve async/defer behavior if you set it
+		} else {
+			// Inline script
+			newScript.textContent = oldScript.textContent;
+		}
+
+		oldScript.replaceWith(newScript);
+	});
+}
+
+
+export function inject_node(selector, node) {
+	parent = document.querySelector(selector)
+	if (parent.firstElementChild) {
+		parent.firstElementChild.remove();
+		parent.innerHTML = "";
+	}
+	if (node) {
+		parent.appendChild(node);
+	}
+	return node;
+}
+

pydiet/web_client/js/etc.js

@@ -0,0 +1,63 @@
+// Manage web interface settings
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under GPL v3
+
+import {inject_node} from "./dom";
+import {fetch_data, fetch_html} from "./fetch";
+import {get_filterID, update_filter} from "./instrument";
+import {plot_filter} from "./plot";
+import {etc_url, ui_url} from "./url";
+
+export async function update_etcform(instrument) {
+	fetch_html(
+		"#content-slot",
+		ui_url + "/" + instrument.id + "/etc_form"
+	).then( (result) => { 
+		const etc_form = document.querySelector('#etc-form');
+		update_filters(instrument);
+		etc_form.addEventListener('submit', async function (e){
+			// Prevent default behavior on submit
+			e.preventDefault();
+			const data = new FormData(this),
+				datao = Object.fromEntries(data),
+				upload = (datao.filter_upload && datao.filter_upload.size > 0);
+			fetch_html(
+				'#modal-slot',
+				ui_url + '/' + instrument.id + '/etc_results/query',
+				upload ? {method: 'post', data: data} : {data: data}
+			);
+		});
+	});
+}
+
+
+function update_filters(instrument) {
+	if ((select_filters = document.querySelector("#select-filters"))) {
+		while (select_filters.firstChild) {
+			select_filters.lastChild.remove()
+		}
+		const	instrumentID = instrument.id,
+			filters = instrument.filters.transmissions;
+		let f_default = get_filterID(instrumentID);
+		for (f in filters) {
+			let  option = document.createElement("ion-select-option");
+			option.value = f;
+			filter = filters[f]
+			option.innerHTML = filter.name;
+			select_filters.appendChild(option);
+			// Identify default instrument (or first in the dictionary instead)
+			if (!f_default && (filter.default || !f_default)) {
+				f_default = f;
+			}
+		}
+		option = document.createElement("ion-select-option");
+		option.value = 'upload';
+		option.innerHTML = "upload";
+	    select_filters.appendChild(option);       
+		select_filters.value = f_default;
+		update_filter(instrumentID, f_default);
+	}
+}
+
+
+

pydiet/web_client/js/fetch.js

@@ -0,0 +1,49 @@
+// Fetch HTML components
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under GPL v3
+
+import {inject_html} from "./dom";
+
+
+export async function fetch_data(url) {
+	return await fetch(url, {credentials: "include"})
+		.then( (response) => {
+			// The API call was successful!
+			if (!response.ok) {
+				throw new Error("Unauthorized API endpoint:" + response.url);
+			}
+			return response.json();
+		}).catch( (err) => {
+			// There was an error
+			return false;
+		});
+};
+
+
+export async function fetch_html(selector, url, {method='get', data} = {}) {
+	return await (method=='get' ?
+		fetch(
+			data ? url + '?' + new URLSearchParams(data) : url,
+			{credentials: 'include'}
+		) : fetch(url,
+			{
+				method: 'post',
+				body: data,
+				credentials: "include"})
+	).then( (response) => {
+		// The API call was successful!
+		if (!response.ok) {
+			throw new Error("Unauthorized API endpoint:" + response.url);
+		}
+		return response.text();
+	}).then( (html) => {
+		// Remove possible remaining modal
+		// Insert the HTML string into the current element
+		inject_html(selector, html);
+		return true;
+	}).catch( (err) => {
+		// There was an error
+		return false;
+	});
+};
+

pydiet/web_client/js/instrument.js

@@ -0,0 +1,62 @@
+// Manage instruments
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under MIT
+
+import { loadingController } from '@ionic/core';
+import { etc_url } from "./url";
+import {update_etcform} from "./etc";
+import { fetch_data} from "./fetch";
+
+let	instruments_cache = null;
+
+export async function get_instruments() {
+	if (!instruments_cache) {
+		const	loading =  await loadingController.create({
+			message: 'Loading instruments ...',
+			duration: 10000
+		});
+		loading.present();
+		instruments_cache = fetch_data(etc_url + "/instruments");
+		loading.dismiss();
+	}
+	return instruments_cache;
+}
+
+
+// Get previously stored instrument
+export function get_instrumentID() {
+	return localStorage.getItem('pyDIETDefaultInstrument');
+}
+
+
+// Update stored instrument setting
+export function update_instrument(instrumentID) {
+	get_instruments().then( (instruments) => {
+		instrument = instruments[instrumentID];
+		update_etcform(instrument);
+		// Store new instrument setting in local storage
+		localStorage.setItem('pyDIETDefaultInstrument', instrumentID);
+		return instrumentID;
+	});
+}
+
+
+// Get previously stored filter
+export function get_filterID(instrumentID) {
+	return localStorage.getItem('pyDIETDefaultFilter_' + instrumentID);
+}
+
+
+// Update stored filter setting
+export function update_filter(instrumentID, filterID) {
+	if (filterID) {
+		// Store new filter setting in local storage
+		localStorage.setItem('pyDIETDefaultFilter_' + instrumentID, filterID);
+		return filterID;
+	} else {
+		// Return previously stored filter
+		return get_filterID(instrumentID);
+	}
+}
+
+

pydiet/web_client/js/main.js

@@ -0,0 +1,15 @@
+// Javascript code entry point
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under MIT
+import {get_instruments} from "./instrument"
+import {setup_instrument_settings, setup_theme_settings} from "./settings";
+
+// Set up theme section of settings
+setup_theme_settings();
+
+get_instruments().then( (instruments) => {
+// Set up instrument section of settings
+	setup_instrument_settings(instruments);
+});
+
+

pydiet/web_client/js/plot.js

@@ -0,0 +1,88 @@
+// Manage web interface settings
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under GPL v3
+
+import Chart from 'chart.js/auto';
+import zoomPlugin from 'chartjs-plugin-zoom';
+
+Chart.register(zoomPlugin);
+
+export function plot_filter(filter, atmosphere, canvas, wave_min, wave_max) {
+	const fwave = filter.wave.value,
+		fresponse = filter.response.value,
+		awave = atmosphere.wave.value,
+		aresponse = atmosphere.response.value,
+		unit = filter.wave.unit,
+		chart = new Chart(
+			canvas,
+			{
+				type: 'line',
+				data: {
+					datasets:	[
+						{
+							label: 'Atmosphere',
+							data: awave.map((x, i) => ({ x, y: aresponse[i] })),
+							fill: true
+						},
+						{
+							label: 'Instrument',
+							data: fwave.map((x, i) => ({ x, y: fresponse[i] })),
+							fill: true
+						}
+					]
+				},
+				options: {
+					pointRadius: 0,
+					maintainAspectRatio: false,
+					interaction: {
+						mode: 'nearest',
+						intersect: true
+					},
+					scales: {
+						x: {
+							type: 'linear',
+							title: {
+								display: true,
+								text: 'Wavelength [' + unit + ']'
+							},
+							min: filter.wave_range.value[0],
+							max: filter.wave_range.value[1]
+
+						},
+						y: {
+							title: {
+								display: true,
+								text: 'Transmission',
+							},
+							min: 0.,
+							max: 1.
+						}
+					},
+					plugins: {
+						title: {
+							display: false,
+							text: filter.name + ' filter',
+						},
+						legend: {display: false},
+						zoom: {
+							zoom: {
+								wheel: {enabled: true},
+								pinch: {enabled: true},
+								drag: {enabled: true, modifierKey: 'shift'},
+								scaleMode: 'xy',
+								mode: 'xy'},
+							pan: {enabled: true, scaleMode: 'xy'},
+							limits: {
+								x: {min: 'original', max: 'original'},
+								y: {min: 'original', max: 'original'}
+							}
+						}
+					}
+				}
+			}
+		);
+};
+
+
+window.plot_filter = plot_filter;
+

pydiet/web_client/js/settings.js

@@ -0,0 +1,57 @@
+// Manage web interface settings
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under GPL v3
+import {get_instrumentID, update_instrument} from "./instrument";
+import {get_theme, update_theme, themes, theme_icons} from "./theme";
+
+// Manage theme changes
+export function setup_theme_settings() {
+	const theme_segment = document.querySelector("#theme-segment");
+	if ((theme_segment)) {
+		for (var t in themes) {
+			let	button = document.createElement("ion-segment-button"),
+				icon = document.createElement("ion-icon"),
+				label = document.createElement("ion-label");
+			button.value = themes[t].toLowerCase();
+			label.innerHTML = themes[t];
+			button.appendChild(label);
+			icon.name = theme_icons[t];
+			button.appendChild(icon);
+			theme_segment.appendChild(button);
+		}
+		const theme = theme_segment.value = get_theme();
+		update_theme(theme);
+		theme_segment.addEventListener('ionChange', (event) => {
+			update_theme(event.detail.value);
+		});
+	}
+}
+
+// Manage instrument changes
+export function setup_instrument_settings(instruments) {
+	if ((instrument_segment = document.querySelector("#instrument-segment"))) {
+		let i_default = get_instrumentID();
+		for (i in instruments) {
+			let button = document.createElement("ion-segment-button"),
+				icon = document.createElement("ion-icon"),
+				label = document.createElement("ion-label");
+			button.value = i;
+			instrument = instruments[i]
+			label.innerHTML = instrument.name;
+			button.appendChild(label);
+			icon.name = "videocam";
+			button.appendChild(icon);
+			instrument_segment.appendChild(button);
+			// Identify default instrument (or first in the dictionary instead)
+			if (!i_default && (instrument.default || !i_default)) {
+				i_default = i;
+			}
+		}
+		instrument_segment.value = i_default;
+		update_instrument(i_default);
+		instrument_segment.addEventListener('ionChange', (event) => {
+			update_instrument(event.detail.value);
+		});
+	}
+}
+

pydiet/web_client/js/theme.js

@@ -0,0 +1,43 @@
+// Manage web interface settings
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under MIT
+
+export const	themes = ["Light", "Dark", "Auto"],
+	theme_icons = ["sunny", "moon", "contrast"];
+
+
+// Use matchMedia to check the user preference for dark/light themes
+const prefersdark = window.matchMedia('(prefers-color-scheme: dark)');
+
+// Add or remove the "dark" class based on if the media query matches
+function toggle_dark_theme(isdark) {
+	document.body.classList.toggle('dark', isdark);
+}
+
+
+// Get previously stored theme
+export function get_theme() {
+	return localStorage.getItem('pyDIETDefaultTheme');
+}
+
+
+// Add or remove the "dark" class based on if the media query matches
+export function update_theme(theme) {
+	if (theme) {
+		// Store new theme choice in local storage
+		localStorage.setItem('pyDIETDefaultTheme', theme);
+	} else {
+		// Get previously stored theme
+		theme = get_theme();
+	}
+	// Toggle theme if necessary
+	toggle_dark_theme(
+		(typeof(theme) === "string" && theme.includes("dark"))
+		|| (
+			!(typeof(theme) === "string" && theme.includes("light"))
+			&& prefersdark.matches
+		)
+	);
+}
+
+

pydiet/web_client/js/url.js

@@ -0,0 +1,12 @@
+// Root URLs for APIs 
+// Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+// Licensed under GPL v3
+
+const root_path = document.querySelector('#root_path').content;
+
+
+export const root_url = root_path,	// Root URL
+	etc_url = root_url + "/api",
+	ui_url = root_url + "/ui",		// Root URL for UI components
+	ui_auth_url = ui_url + "/auth";
+

pydiet/web_client/jsdoc.json

@@ -0,0 +1,20 @@
+{
+	"opts": {
+		"destination": "doc",
+		"pedantic": true,
+		"private": true,
+		"recurse": true,
+		"template": "./node_modules/tidy-jsdoc"
+	},
+	"templates": {
+		"cleverLinks": true,
+		"monospaceLinks": false
+    },
+	"plugins": [
+		"plugins/markdown"
+	],
+	"metadata": {
+		"title": "PyDIET web client"
+	}
+}
+

pydiet/web_client/package.json

@@ -0,0 +1,83 @@
+{
+	"name": "PyDIET",
+	"version": "0.1.0",
+	"description": "CFHT's Direct Imaging Exposure Time calculator",
+	"homepage": "https://github.com/astromatic/pydiet",
+	"author": "Emmanuel Bertin (CEA/CFHT/CNRS/UParisSaclay)",
+	"contributors": [
+		"Emmanuel Bertin <bertin@cfht.hawaii.edu> (https://github.com/ebertin)"
+	],
+	"license": "MIT",
+	"keywords": [
+		"astronomy",
+		"CFHT",
+		"calculator",
+		"imaging"
+	],
+	"private": true,
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/astromatic/pydiet.git"
+	},
+	"bugs": {
+		"url": "https://github.com/astromatic/pydiet/issues"
+	},
+	"dependencies": {
+		"@ionic/core": "^8.0",
+		"npm": "^10.8.1",
+		"tidy-jsdoc": "^1.4.1"
+	},
+	"devDependencies": {
+		"chart.js": "=4.3.0",
+		"chartjs-plugin-zoom": "^2.0.1",
+		"esbuild": "^0.14.53",
+		"eslint": "^8.23.1",
+		"jsdoc": "^4.0"
+	},
+	"main": "dist/visiomatic.js",
+	"scripts": {
+		"build": "esbuild js/main.js --bundle --minify --outfile=dist/pydiet.js --watch",
+		"build-pretty": "esbuild js/main.js --bundle --outfile=dist/pydiet.js --watch",
+		"docs": "jsdoc -c jsdoc.json js",
+		"lint": "eslint js",
+		"test": "npm run unit"
+	},
+	"eslintConfig": {
+		"ignorePatterns": [
+			"dist"
+		],
+		"parserOptions": {
+			"ecmaVersion": "latest",
+			"sourceType": "module"
+		},
+		"env": {
+			"node": true,
+			"es6": true
+		},
+		"rules": {
+			"curly": "error",
+			"indent": [
+				"error",
+				"tab"
+			],
+			"key-spacing": "off",
+			"linebreak-style": [
+				"off",
+				"unix"
+			],
+			"no-mixed-spaces-and-tabs": [
+				"error",
+				"smart-tabs"
+			],
+			"no-unused-expressions": [
+				"error"
+			],
+			"spaced-comment": "error",
+			"strict": "off",
+			"wrap-iife": "off",
+			"no-invalid-this": "off",
+			"prefer-object-has-own": "error",
+			"prefer-spread": "off"
+		}
+	}
+}