Upload 14 files

LICENSE

@@ -1,17 +1,7 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
+Apache License 2.0
 
-Copyright 2026 MegaNet SciML Studio contributors
+Copyright 2026 contributors
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Licensed under the Apache License, Version 2.0.
+You may obtain a copy of the License at:
+https://www.apache.org/licenses/LICENSE-2.0

MODEL_SCOPE.md

@@ -1,25 +1,25 @@
-# Model scope
+# Область применимости модели
 
-## What is implemented
+## Реализовано
 
-- Exact channel-network mass and pressure conservation.
-- Balanced tree specialization for very large outlet counts.
-- Generalized-Newtonian rheology options implemented in the network workflow.
-- Local XPINN for repeated smooth contractions.
-- Independent local quality gate before XPINN corrections enter the network.
-- Uncertainty analysis for fabrication tolerances and blockage scenarios.
-- Two-phase supply-network branch for droplet-array / mixed architectures.
-- Reduced physics-informed T-junction droplet closure.
-- Optional DeepCFD-derived local operator in research mode.
-- Constrained inverse design.
+- точное сохранение массы и давления в сети каналов;
+- специализированный расчёт больших древовидных сетей;
+- варианты реологии обобщённо-ньютоновских жидкостей;
+- локальный XPINN для повторяющихся плавных сужений;
+- независимый физический допуск перед включением PINN-поправки;
+- анализ технологического разброса и сценариев частичной закупорки;
+- отдельная питающая сеть дисперсной фазы для капельных архитектур;
+- physics-informed замыкание Т-образного генератора капель;
+- опциональный локальный оператор DeepCFD в исследовательском режиме;
+- обратное проектирование с ограничениями.
 
-## What remains outside this MVP
+## За пределами текущего MVP
 
-- Full 3D resolved-interface multiphase simulation of the complete chip.
-- General coalescence and complex breakup / jetting physics.
-- Deformable walls / fluid-structure interaction.
-- General viscoelastic memory models.
-- Chemical reaction networks.
-- User-specific experimental calibration.
+- полный трёхмерный расчёт свободной границы для всего чипа;
+- сложная коалесценция и разрушение капель/струй;
+- взаимодействие жидкости с деформируемыми стенками;
+- общие модели вязкоупругой памяти;
+- химические реакционные сети;
+- калибровка по пользовательским экспериментальным данным.
 
-For these regimes, use domain-specific high-fidelity simulation or experiments.
+Для таких задач необходимы специализированные высокоточные расчёты и/или экспериментальная проверка.

README.md

@@ -2,8 +2,8 @@
 license: apache-2.0
 library_name: pytorch
 language:
-- en
 - ru
+- en
 tags:
 - scientific-machine-learning
 - sciml
@@ -11,128 +11,122 @@ tags:
 - xpinn
 - microfluidics
 - microfluidic-design
-- computational-fluid-dynamics
 - inverse-design
 - uncertainty-quantification
-- physics-informed-machine-learning
 ---
 
-# MegaNet SciML Studio V16.1
+# Модель проектирования микрофлюидных чипов V16.1
 
-**Hybrid physics-informed model for design and analysis of large-scale microfluidic systems.**
+Исследовательский MVP для расчёта и проектирования крупных микрофлюидных систем.  
+Модель сочетает точный сетевой расчёт, локальные PINN/XPINN-модули, анализ неопределённости и обратное проектирование.
 
-MegaNet SciML Studio combines exact network-scale conservation with local
-physics-informed neural models and optional high-fidelity CFD-derived closures.
-The repository is a **research/MVP code model**, not a hosted inference endpoint.
+В репозитории есть **два варианта запуска одной и той же модели**.
 
-## Main capabilities
+## Быстрый выбор
 
-- exact hydraulic solution of large microfluidic channel networks;
-- specialized balanced-tree calculations up to **65,536 outlets**;
-- local contraction **XPINN** with an independent physics quality gate;
-- two-phase supply-network workflow for droplet-generator arrays;
-- reduced two-phase physics-informed closure for T-junction droplet prediction;
-- manufacturing-tolerance and blockage uncertainty analysis;
-- inverse design / constrained geometry optimization;
-- optional research workflow using the public **DeepCFD** benchmark;
-- Colab/Jupyter graphical interface.
+### `colab/` — Google Colab
 
-## Calculation modes
+Подходит для демонстрации и работы без настройки локального Python-окружения.
 
-### Fast
-Exact network hydraulics without PINN/DeepCFD corrections.
+Основной файл:
 
-### PINN — recommended
-1. Build the real chip/network.
-2. Solve the complete network with the exact hydraulic solver.
-3. Identify a representative repeated contraction.
-4. Train and independently audit the local XPINN.
-5. Transfer only an accepted local resistance correction to matching elements.
-6. Re-solve the complete network exactly.
-7. Compute uncertainty, derived physics and design outputs.
+`colab/microfluidic_sciml_v16_1.ipynb`
 
-### Research — PINN + DeepCFD
-Adds an external validation / local-operator layer using the DeepCFD benchmark
-before running the same exact-network + local-XPINN workflow.
+Откройте notebook в Google Colab и выполните основную ячейку.
 
-## Run in Google Colab
+### `local/` — локальный запуск / VS Code
 
-Recommended file:
+Подходит, если модель должна работать на компьютере пользователя.
 
-`microfluidic_meganet_pinn_colab_v16_1.ipynb`
+```bash
+cd local
+python -m venv .venv
+pip install -r requirements.txt
+python app.py
+```
 
-Upload it to Google Colab and run the main cell. The notebook installs missing
-Python dependencies in Colab when necessary.
+После запуска интерфейс откроется в браузере по адресу:
 
-The Python source can also be executed in Colab:
+`http://127.0.0.1:8866`
 
-```python
-%run /content/microfluidic_meganet_pinn_colab_v16_1.py
-```
+## Что рассчитывает модель
 
-## Repository contents
+- гидравлику крупных сетей микроканалов;
+- распределение расходов и давления;
+- локальные числа Рейнольдса и напряжение сдвига;
+- влияние технологических допусков и частичных закупорок;
+- локальные потери в сложных элементах;
+- параметры генерации капель для соответствующих архитектур;
+- варианты геометрии при обратном проектировании.
 
-- `microfluidic_meganet_pinn_colab_v16_1.ipynb` — primary runnable Colab interface
-- `microfluidic_meganet_pinn_colab_v16_1.py` — complete source
-- `requirements.txt` — Python dependencies
-- `MODEL_SCOPE.md` — scientific scope and limitations
-- `HF_UPLOAD_STEPS.md` — browser upload instructions
+Для специализированной древовидной архитектуры поддерживается расчёт до **65 536 выходов**.
 
-## Scientific architecture
+## Архитектура расчёта
 
 ```text
-chip geometry / operating conditions
-                ↓
-       exact network solver
-                ↓
-  local geometry / physics detection
-                ��
-   verified local PINN / XPINN
-                ↓
-   exact re-solve of full network
-                ↓
-uncertainty + derived physics + design
-                ↓
- local CFD only for difficult/OOD cases
+геометрия и режим работы чипа
+            ↓
+точный сетевой расчёт
+            ↓
+поиск локально сложных элементов
+            ↓
+проверенный PINN / XPINN
+            ↓
+повторный точный расчёт всей сети
+            ↓
+неопределённость и проектирование
+            ↓
+локальный CFD только для сложных / OOD-случаев
 ```
 
-The neural components are deliberately **not** used to replace global mass and
-pressure conservation.
+Глобальный баланс массы и давления не передаётся нейронной сети: он решается детерминированным сетевым решателем. PINN используется как локальное физическое уточнение.
+
+## Режимы
+
+### Быстрый
+
+Точный сетевой расчёт без PINN и DeepCFD.
+
+### С локальным уточнением PINN — рекомендуется
+
+1. Строится реальная геометрия чипа.
+2. Выполняется предварительный точный расчёт всей сети.
+3. Выбирается характерное повторяющееся сужение.
+4. Для него обучается локальный XPINN.
+5. PINN сравнивается с независимым эталоном.
+6. Только прошедшая допуск поправка переносится на сходные элементы.
+7. Вся сеть пересчитывается точным решателем.
+8. Рассчитываются неопределённость и показатели проектирования.
+
+### Расширенный — PINN + DeepCFD
+
+К рекомендованному контуру добавляются открытая проверка и локальный оператор на данных DeepCFD. Этот режим тяжелее и предназначен прежде всего для исследовательской проверки многоуровневого расчёта.
+
+## Варианты архитектуры чипа
 
-## Open references used by the MVP
+- распределительная сеть;
+- перфузионный чип;
+- массив генераторов капель;
+- гибридная архитектура.
 
-The code contains or retrieves pinned/open reference material for validation and
-local closures, including:
+## Что является PINN в этой модели
 
-- DeepCFD benchmark — Zenodo DOI `10.5281/zenodo.3665511`
-- DAFD 3.0 — publication DOI `10.1038/s41467-023-44068-3`
+PINN не используется как универсальная замена CFD.
 
-Additional public reference DOIs are recorded directly in the source code.
+Основной PDE-PINN/XPINN решает локальную задачу для повторяющегося сужения. После независимой проверки локальная поправка включается в сетевой расчёт.
 
-## Scope
+Для Т-образных генераторов предусмотрено отдельное physics-informed замыкание двухфазной задачи.
 
-The current MVP focuses on laminar Newtonian / generalized-Newtonian flow in
-microfluidic networks, optional hydraulic transients, local contraction PINN
-corrections and repeated T-junction droplet generators within the validated
-feature range.
+## Проверка и открытые эталоны
 
-It is not intended to replace resolved-interface CFD for complex breakup,
-coalescence, strongly out-of-domain wetting, wall deformation or other physics
-outside the implemented closures.
+В коде предусмотрены внутренние тесты физических балансов и внешний набор проверок. В исследовательском режиме могут использоваться открытые данные DeepCFD и DAFD.
 
-## Intended use
+Ссылки и DOI соответствующих источников закреплены непосредственно в исходном коде.
 
-This repository is intended for:
-- scientific demonstration;
-- hypothesis and architecture screening;
-- rapid design-space exploration;
-- preparation of candidate chip geometries for subsequent high-fidelity
-  simulation and/or experimental validation.
+## Ограничения
 
-It should not be treated as a validated manufacturing or clinical design tool
-without domain-specific verification.
+Текущая версия предназначена для ламинарных микрофлюидных систем и не заменяет полноценный трёхмерный CFD для сложного разрушения интерфейса, коалесценции, сильно выходящих за область применимости режимов смачивания, деформируемых стенок и других не включённых физических эффектов.
 
-## License
+Модель следует рассматривать как исследовательский MVP и инструмент предварительного проектирования, а не как готовый производственный расчётный пакет.
 
-Apache License 2.0 applies to the repository code. External datasets and
-benchmarks remain subject to their own terms and citations.
+Подробнее: [`MODEL_SCOPE.md`](MODEL_SCOPE.md).

REPOSITORY_LAYOUT.md

@@ -0,0 +1,22 @@
+# Структура репозитория
+
+```text
+README.md
+LICENSE
+MODEL_SCOPE.md
+colab/
+  README.md
+  microfluidic_sciml_v16_1.ipynb
+  microfluidic_sciml_v16_1.py
+local/
+  README.md
+  requirements.txt
+  app.py
+  app.ipynb
+  microfluidic_sciml_v16_1.py
+  run_windows.bat
+  run_mac_linux.sh
+```
+
+`colab/` — запуск в Google Colab.  
+`local/` — запуск локально, в том числе из VS Code.

colab/README.md

@@ -0,0 +1,11 @@
+# Версия для Google Colab
+
+Самый простой вариант запуска модели.
+
+## Как запустить
+
+1. Откройте `microfluidic_sciml_v16_1.ipynb` в Google Colab.
+2. Выполните основную ячейку.
+3. Интерфейс модели появится прямо в notebook.
+
+Файл `microfluidic_sciml_v16_1.py` содержит полный исходный код вычислительного ядра и интерфейса.

local/README.md

@@ -0,0 +1,49 @@
+# Локальная версия / VS Code
+
+Эта версия запускает модель на компьютере пользователя как небольшое локальное веб-приложение.
+
+Рекомендуется Python **3.11 или 3.12**.
+
+## Windows / VS Code
+
+Откройте терминал в папке `local`:
+
+```powershell
+python -m venv .venv
+.venv\Scripts\activate
+python -m pip install --upgrade pip
+pip install -r requirements.txt
+python app.py
+```
+
+После запуска браузер автоматически откроет:
+
+`http://127.0.0.1:8866`
+
+Для остановки нажмите `Ctrl+C` в терминале.
+
+## macOS / Linux
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+pip install -r requirements.txt
+python app.py
+```
+
+## Как устроен локальный запуск
+
+`app.py` запускает локальный Voilà-сервер. Он открывает служебный `app.ipynb`, который подключает вычислительное ядро `microfluidic_sciml_v16_1.py` и показывает интерфейс модели как отдельную веб-страницу.
+
+Все расчёты выполняются локально на компьютере пользователя.
+
+## Результаты
+
+Экспортируемые файлы сохраняются в папке:
+
+`local/model_outputs/`
+
+## Расширенный режим
+
+Режим `PINN + DeepCFD` требует доступа в интернет для загрузки открытого набора DeepCFD и заметно больше времени. Для обычного локального использования рекомендуется режим с локальным уточнением PINN.

local/app.ipynb

@@ -0,0 +1,41 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "2de1b354",
+   "metadata": {},
+   "source": [
+    "# Модель проектирования микрофлюидных чипов V16.1 — локальный запуск\n",
+    "\n",
+    "Служебная оболочка для Voilà. Для обычного запуска используйте `python app.py`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8023cbc2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"MEGANET_PINN_NO_AUTOLAUNCH\"] = \"1\"\n",
+    "\n",
+    "from microfluidic_sciml_v16_1 import launch\n",
+    "\n",
+    "MICROFLUIDIC_MODEL = launch(show_startup=True)\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

local/app.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+"""
+Модель проектирования микрофлюидных чипов V16.1 — локальный запуск.
+
+Команда:
+    python app.py
+"""
+from __future__ import annotations
+
+import importlib.util
+import os
+from pathlib import Path
+import subprocess
+import sys
+import threading
+import time
+import urllib.request
+import webbrowser
+
+APP_DIR = Path(__file__).resolve().parent
+NOTEBOOK = APP_DIR / "app.ipynb"
+OUTPUT_DIR = APP_DIR / "model_outputs"
+
+HOST = os.environ.get("MICROFLUIDIC_HOST", "127.0.0.1")
+PORT = int(os.environ.get("MICROFLUIDIC_PORT", "8866"))
+URL = f"http://{HOST}:{PORT}/"
+
+def _check_dependencies() -> None:
+    required = {
+        "voila": "voila",
+        "ipywidgets": "ipywidgets",
+        "numpy": "numpy",
+        "pandas": "pandas",
+        "matplotlib": "matplotlib",
+        "scipy": "scipy",
+        "sklearn": "scikit-learn",
+        "torch": "torch",
+        "requests": "requests",
+        "openpyxl": "openpyxl",
+    }
+    missing = [pip_name for module, pip_name in required.items()
+               if importlib.util.find_spec(module) is None]
+    if missing:
+        print("\nНе установлены зависимости:", ", ".join(missing))
+        print("Сначала выполните:")
+        print(f'  "{sys.executable}" -m pip install -r "{APP_DIR / "requirements.txt"}"' )
+        raise SystemExit(1)
+
+def _open_browser_when_ready(timeout: float = 60.0) -> None:
+    deadline = time.time() + timeout
+    while time.time() < deadline:
+        try:
+            with urllib.request.urlopen(URL, timeout=1.0):
+                webbrowser.open(URL)
+                return
+        except Exception:
+            time.sleep(0.4)
+    webbrowser.open(URL)
+
+def main() -> None:
+    _check_dependencies()
+    OUTPUT_DIR.mkdir(parents=True, exist_ok=True)
+
+    env = os.environ.copy()
+    env["MEGANET_PINN_OUTPUT_DIR"] = str(OUTPUT_DIR)
+    env["PYTHONUNBUFFERED"] = "1"
+
+    print("Модель проектирования микрофлюидных чипов V16.1")
+    print(f"Интерфейс откроется в браузере: {URL}")
+    print("Для остановки нажмите Ctrl+C.\n")
+
+    threading.Thread(target=_open_browser_when_ready, daemon=True).start()
+
+    cmd = [
+        sys.executable, "-m", "voila", str(NOTEBOOK),
+        "--no-browser",
+        f"--Voila.ip={HOST}",
+        f"--Voila.port={PORT}",
+        "--Voila.theme=light",
+        "--Voila.show_tracebacks=True",
+    ]
+
+    try:
+        subprocess.run(cmd, cwd=str(APP_DIR), env=env, check=True)
+    except KeyboardInterrupt:
+        print("\nМодель остановлена.")
+    except subprocess.CalledProcessError as exc:
+        print(f"\nVoilà завершился с кодом {exc.returncode}.")
+        raise SystemExit(exc.returncode)
+
+if __name__ == "__main__":
+    main()

local/requirements.txt

@@ -0,0 +1,11 @@
+voila>=0.5,<0.6
+ipywidgets>=8.1,<9
+jupyterlab_widgets>=3.0,<4
+numpy>=1.26,<3
+pandas>=2.2,<3
+matplotlib>=3.8,<4
+scipy>=1.12,<2
+scikit-learn>=1.4,<2
+torch>=2.2,<3
+requests>=2.31,<3
+openpyxl>=3.1,<4

local/run_mac_linux.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -e
+if [ ! -d ".venv" ]; then
+  python3 -m venv .venv
+fi
+source .venv/bin/activate
+python -m pip install --upgrade pip
+pip install -r requirements.txt
+python app.py

local/run_windows.bat

@@ -0,0 +1,9 @@
+@echo off
+if not exist .venv (
+  python -m venv .venv
+)
+call .venv\Scripts\activate
+python -m pip install --upgrade pip
+pip install -r requirements.txt
+python app.py
+pause