chore(app): bun-tauri dev/build defaults and FEFF packaging assets

Author: Ameyanagi

.cargo/config.toml

@@ -1,2 +1,5 @@
+[build]
+target-dir = "target"
+
 [target.aarch64-apple-darwin]
 linker = "clang"

Cargo.toml

@@ -26,6 +26,11 @@ license = "MIT OR Apache-2.0"
 [profile.bench]
 debug = true
 
+[profile.dev]
+debug = 1
+incremental = true
+codegen-units = 256
+
 
 [workspace.dependencies]
 easyfft = { version = "0.4.2", features = ["serde"] }

README.md

@@ -4,6 +4,30 @@ xraytsubaki is a Rust-based program that implements the core functionalities of
 
 Currently the main source code is placed under `./crates/xraytsubaki/`.
 
+## Tauri App Dev (Bun Default)
+
+The desktop app lives in `xraytsubaki-app/`.
+
+Recommended dev flow:
+
+```bash
+cd xraytsubaki-app
+bun install
+bun run tauri:dev
+```
+
+Notes:
+- The Tauri/Vite dev server uses `http://localhost:1420` with strict port binding.
+- If port `1420` is already used, stop the previous dev process before rerunning.
+
+npm fallback (if Bun is unavailable):
+
+```bash
+cd xraytsubaki-app
+npm install
+npm run tauri -- dev
+```
+
 ## Project Genesis and Objectives
 
 The inception of this project was triggered when I needed to process over 1000 spectra from in-situ measurements. The data loading and processing in xraylarch were too time-consuming, not to mention also for demeter. The goal was to develop a tool capable of processing data within a reasonable timeframe. While this project does not seek to replace xraylarch, it does aim to provide a phenomenally fast core API for xraylarch's backend to augment its capacity.

xraytsubaki-app/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,36 @@
+# Third-Party Notices
+
+## FEFF85EXAFS (Feff8L)
+
+xraytsubaki may bundle FEFF module executables built from FEFF85EXAFS for EXAFS path generation.
+
+- Upstream project: https://github.com/xraypy/feff85exafs
+- Project organization: https://github.com/xraypy
+- Primary maintainers/contributors: Bruce Ravel (`bruceravel`), Matt Newville (`newville`), and xraypy contributors
+- Upstream note: "Based on or developed using Distribution: FEFF8.5L Copyright (c) [2013] University of Washington"
+
+License text from FEFF85EXAFS (`LICENSE`):
+
+Copyright (c) 2013 - 2015
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+  Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

xraytsubaki-app/package.json

@@ -5,9 +5,12 @@
   "type": "module",
   "scripts": {
     "dev": "vite",
+    "dev:tauri": "vite",
     "build": "tsc -b && vite build",
+    "build:tauri": "tsc -b && vite build",
     "preview": "vite preview",
     "tauri": "tauri",
+    "tauri:dev": "tauri dev",
     "type-check": "tsc --noEmit",
     "lint": "eslint src/",
     "lint:fix": "eslint src/ --fix",

xraytsubaki-app/scripts/bundle_feff85exafs.sh

@@ -0,0 +1,63 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+APP_DIR="$(cd "${SCRIPT_DIR}/.." && pwd)"
+
+os="$(uname -s | tr '[:upper:]' '[:lower:]')"
+case "${os}" in
+  darwin) os="macos" ;;
+  mingw*|msys*|cygwin*) os="windows" ;;
+esac
+
+arch="$(uname -m)"
+case "${arch}" in
+  arm64) arch="aarch64" ;;
+  amd64) arch="x86_64" ;;
+esac
+platform_dir="${os}-${arch}"
+
+resource_dir="${APP_DIR}/src-tauri/resources/feff/${platform_dir}"
+mkdir -p "${resource_dir}"
+
+work_dir="$(mktemp -d "${TMPDIR:-/tmp}/feff85exafs.XXXXXX")"
+cleanup() {
+  rm -rf "${work_dir}"
+}
+trap cleanup EXIT
+
+echo "[bundle-feff] cloning FEFF85EXAFS into ${work_dir}"
+git clone --depth 1 https://github.com/xraypy/feff85exafs.git "${work_dir}/src"
+
+pushd "${work_dir}/src" >/dev/null
+  echo "[bundle-feff] building FEFF85EXAFS (make install)"
+  make install
+popd >/dev/null
+
+bin_dir="${work_dir}/src/local_install/bin"
+modules=(
+  feff8l_rdinp
+  feff8l_pot
+  feff8l_xsph
+  feff8l_pathfinder
+  feff8l_genfmt
+  feff8l_ff2x
+)
+
+exe_suffix=""
+if [[ "${os}" == "windows" ]]; then
+  exe_suffix=".exe"
+fi
+
+for module in "${modules[@]}"; do
+  src_path="${bin_dir}/${module}${exe_suffix}"
+  if [[ ! -f "${src_path}" ]]; then
+    echo "[bundle-feff] missing expected module: ${src_path}" >&2
+    exit 1
+  fi
+  cp -f "${src_path}" "${resource_dir}/${module}${exe_suffix}"
+  chmod +x "${resource_dir}/${module}${exe_suffix}"
+done
+
+echo "[bundle-feff] copied FEFF modules to ${resource_dir}"
+echo "[bundle-feff] keep THIRD_PARTY_NOTICES.md with redistributions"

xraytsubaki-app/src-tauri/resources/feff/README.md

@@ -0,0 +1,24 @@
+# Bundled FEFF Modules
+
+Place FEFF85EXAFS module executables in the platform directory for packaging.
+
+Required module names:
+- `feff8l_rdinp`
+- `feff8l_pot`
+- `feff8l_xsph`
+- `feff8l_pathfinder`
+- `feff8l_genfmt`
+- `feff8l_ff2x`
+
+Windows requires `.exe` suffix for each module.
+
+Platform directories:
+- `macos-aarch64/`
+- `macos-x86_64/`
+- `linux-aarch64/`
+- `linux-x86_64/`
+- `windows-x86_64/`
+
+Build source and attribution:
+- Source: https://github.com/xraypy/feff85exafs
+- Keep `THIRD_PARTY_NOTICES.md` included with distributions.