flash-sim 0.0.1__tar.gz

flash_sim-0.0.1/.gitignore

@@ -0,0 +1,216 @@
+
+# ==============================
+# flash-sim specific
+# ==============================
+temp_delete/
+
+# ==============================
+# Ignore all extensionless files
+# ==============================
+*
+!*.*
+!*/
+
+# Exception: allow no-extension source files
+!.gitignore
+!.env.example
+!Makefile
+!Dockerfile
+!LICENSE
+!README
+!NOTICE
+!scripts/git-hooks/*
+!scripts/*.sh
+# 场景自生成的 FLASH 配置 (ConfigGenerator 产物, 发布包必需)
+!**/sim_input*/Config
+
+# ==============================
+# 大文件/媒体排除 (必须在 !*.* 之后, 否则被反忽略覆盖)
+# ==============================
+*.pdf
+*.png
+*.pptx
+*.ppt
+*.avi
+*.mp4
+*.h5
+*.hdf5
+
+# ================================================================
+# My Projects (内部工作区, 不发布)
+# ================================================================
+.workbuddy/
+.codebuddy/
+
+
+# ================================================================
+# FLASH CENTER — 禁止再分发 (FLASH License Agreement §3)
+# ================================================================
+# 依据 FLASH License Agreement §3:
+# "Users of the FLASH Code are not free to re-distribute the FLASH
+#  Code, or any of its components, outside the Center."
+#
+# ⚠ 此区块必须放在 !*.* 之后，确保目录排除规则覆盖通用反排除。
+# ⚠ 以下所有文件/目录均为 FLASH 版权材料、运行产物或内部文件，
+#    严禁通过 Git 分发到 Gitee / GitHub 等公开平台。
+# ================================================================
+
+# --- FLASH 源码包 & 编译依赖 (任意层级) ---
+**/FLASH4.8/
+**/FLASH4.8.tar.gz
+**/hdf5-1.8.12.tar.gz
+**/hypre-2.9.0b.tar.gz
+**/mpich-3.2.tar.gz
+
+# --- FLASH SimulationMain 官方示例源码 ---
+**/SimulationMain/
+
+# --- FLASH 官方 LaserSlab 示例 (源码/表格/配置, 含根目录与 scenarios 下) ---
+**/flash_demo/LaserSlab/
+**/LaserSlabPAR.xlsx
+
+# --- FLASH 分发的 EOS/不透明度表 ---
+# IONMIX4 格式 .cn4/.cnr/.imx/.ses 表均来自 FLASH 分发, 禁止再分发。
+# 用户自研生成的 Z*.cn4 表由文件末尾例外保留。
+*.cn4
+*.cnr
+*.imx
+*.imx.gz
+*.ses
+*.epsi
+
+# --- FLASH 参考源码 (从 FLASH4.8 源码树复制的 refs/ref_f90s) ---
+**/ref_f90s/
+**/refs/
+**/abjt_03.f
+**/abjt_03
+
+# --- IONMIX 源码 / MultiEOS 数据 (FLASH 分发组件) ---
+#**/ionmix/
+**/MultiEOS/
+
+# --- FLASH 官方文档 (用户手册 4.8 等) ---
+docs/flash4_ug_4p8.md
+docs/flash4_ug_4p8_temp.txt
+**/para_doc/
+
+# --- FLASH 协议文件 (本地参考, 不随包分发; docs/ 下协议文本除外) ---
+license_agreement_FLASH.txt
+
+# --- HDF5 输出 (FLASH checkpoint/plot) ---
+*_hdf5_chk_*
+*_hdf5_plt_cnt_*
+
+# --- Demo / 场景运行产物 (含 FLASH 二进制与 HDF5) ---
+**/demo_hpc/demo_task/
+**/demo_local/demo_task/
+**/demo_task/
+**/runs/
+**/outputfiles/
+**/output/
+**/inputfiles/
+**/temp/
+flash_demo/new_struture/
+flash/scenarios/flash_demo/new_struture/
+
+# --- 临时调试目录 (勿提交) ---
+**/wsl_tmp/
+runs_*/
+test/scenarios/runs_*/
+**/run_tools/runs_*/
+test/temp_delete/
+test/grid_rede/
+test/grid_rede_backup_v9/
+test/grid_rede_copy_main/
+test/newpara/flash_input/
+test/newpara/flash_profile/
+test/newpara/output/
+test/hdf5ploter_easy/output/
+
+# --- 旧副本 / 备份目录 ---
+scenarios - 副本/
+flash/input_gen/gen_eos_op_copy/
+input_gen/gen_eos_op_copy/
+output_processors_copy/
+
+# --- 备份/副本文件 ---
+*.bak
+* (*).F90
+Makefile (*)
+Config (*)
+
+
+# ==============================
+# Python
+# ==============================
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+
+# ==============================
+# IDEs
+# ==============================
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+
+# ==============================
+# 自研 EOS 表保留 (Z*.cn4 = ionmix 自生成, 发布包必需)
+# ==============================
+# 全局排除 Z*.cn4 (默认不发布), 例外保留以下两类:
+#   - Gen_eos_op_data/  自生成表目录
+#   - sim_input*/       场景输入目录
+!**/Gen_eos_op_data/**/Z*.cn4
+!**/sim_input*/Z*.cn4
+
+# ==============================
+# Credentials (never commit)
+# ==============================
+credentials.enc
+.env
+
+# ==============================
+# OS files
+# ==============================
+.DS_Store
+Thumbs.db
+flash_work/
+
+# Physics docs (本地知识库, 不推送)
+/physics/
+
+# ================================================================
+# PRIVATE — 用户自定义私有库 (不推送到 Gitee)
+# ================================================================
+# 以下为用户个人自定义的特殊场景/配置, 仅本地使用, 不随包分享。
+# 如需分享, 请移除对应条目并重新提交。
+# ================================================================
+
+# 私有场景: grad_dens_sandwich (HE-CH-Si-CH-HE 渐变密度 CH)
+scenarios/collision_compression/grad_dens_sandwich/
+flash/scenarios/collision_compression/grad_dens_sandwich/
+
+# 私有场景: thin_layer_sandwich (Al/CH/He 与 Si/CH/He 三层靶)
+scenarios/collision_compression/thin_layer_sandwich/
+flash/scenarios/collision_compression/thin_layer_sandwich/

flash_sim-0.0.1/LICENSE

@@ -0,0 +1,386 @@
+flash-sim License
+=================
+
+This file describes the license terms for the flash-sim Python package.
+The flash-sim package consists of two categories of intellectual property,
+each governed by separate license terms:
+
+  PART A — flash-sim Python Code (our original work)
+  PART B — FLASH Simulation Engine and Derivative Components (third-party)
+
+The official FLASH License Agreement (binding on all FLASH users) is
+reproduced in `docs/license_agreement.txt` and is available online at
+https://flash.rochester.edu. flash-sim is distributed in compliance with
+that agreement; please read it before use.
+
+
+======================================================================
+PART A — flash-sim Python Code (Apache License 2.0)
+======================================================================
+
+The Python source code constituting the flash-sim wrapper, tooling, and
+workflow automation (all .py files in the flash/, input_gen/,
+output_processors/, flash_run/, scenarios/, _core/, config/, utils/,
+scripts/, flash_demo/, physics/, projects/, and test/ directories, EXCEPT
+where explicitly noted otherwise) is original work copyright (c) 2026
+PhySimX Contributors, and is licensed under the Apache License, Version 2.0
+(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.
+
+The full text of the Apache License 2.0 follows at the end of this document.
+
+
+======================================================================
+PART B — FLASH Simulation Engine and Derivative Components
+======================================================================
+
+flash-sim is an independently developed Python interface and workflow toolkit
+for the FLASH radiation-hydrodynamics simulation code. flash-sim is NOT the
+FLASH code itself, and is NOT affiliated with, endorsed by, or sponsored by
+the Flash Center for Computational Science.
+
+FLASH (the simulation engine) is developed and maintained by the Flash Center
+for Computational Science at the University of Rochester. The FLASH code is
+governed by its own License Agreement, which ALL users must accept at:
+
+    https://flash.rochester.edu
+
+======================================================================
+IMPORTANT — What this package does NOT include
+======================================================================
+
+This package DOES NOT include, and therefore does NOT re-distribute:
+
+  - The FLASH source code, compiled binaries, or source tarballs
+  - The FLASH SimulationMain example problems (including LaserSlab)
+  - The FLASH-distributed EOS/opacity tables (e.g. *.cn4 / *.cnr / *.imx)
+  - The FLASH user manual and other FLASH-distributed documentation
+  - The IONMIX source code or the MultiEOS data files
+
+None of the above may be re-distributed by individual FLASH users under
+Section 3 of the FLASH License Agreement. Users of flash-sim MUST obtain
+all of the above independently from the Flash Center's official website
+(https://flash.rochester.edu) and accept the FLASH License Agreement
+before using flash-sim with a FLASH installation.
+
+======================================================================
+Derivative Works — Modified FLASH Example Files (FLASH Agreement §4)
+======================================================================
+
+Certain scenario input files under `scenarios/`, `input_gen/*/refs/`, and
+related directories are derivative works of FLASH example problem files
+(e.g. `Simulation_data.F90`, `Simulation_init.F90`,
+`Simulation_initBlock.F90`, `Grid_markRefineDerefine.F90`), modified by
+PhySimX Contributors for new physics setups.
+
+In compliance with Section 4 of the FLASH License Agreement:
+
+  (a) Each such file retains a prominent header notice identifying the
+      FLASH source file it derives from and stating that the file has been
+      modified by PhySimX Contributors. [§4(a) — modifications declared]
+  (b) This product includes software developed by and/or derived from the
+      Flash Center for Computational Science
+      (https://flash.rochester.edu) to which the U.S. Government retains
+      certain rights. [§4(b) — acknowledgment displayed]
+  (c) The FLASH Code header section describing the origins of the FLASH
+      Code and its components remains intact in all modified files.
+      [§4(c) — header preserved]
+
+Users re-distributing or further modifying these derivative files must
+retain the same notices and acknowledgment.
+
+======================================================================
+FLASH Center Required Attribution
+======================================================================
+
+As required by Section 4(b) of the FLASH License Agreement, any software
+that includes or is derived from the FLASH Code must display the following
+acknowledgement:
+
+  "This product includes software developed by and/or derived from the
+   Flash Center for Computational Science (https://flash.rochester.edu)
+   to which the U.S. Government retains certain rights."
+
+As required by the FLASH License Agreement, all publications resulting from
+the use of the FLASH Code must acknowledge the Flash Center:
+
+  "The software used in this work was developed in part by the DOE NNSA-
+   and DOE Office of Science-supported Flash Center for Computational
+   Science at the University of Chicago and the University of Rochester."
+
+Users should also cite the relevant FLASH reference papers listed at:
+  https://flash.rochester.edu/site/publications/flash_pubs.shtml
+
+======================================================================
+Commercial Use Warning
+======================================================================
+
+Per Section 5 of the FLASH License Agreement, commercial use of the FLASH
+Code requires prior written approval from the Director of the Flash Center.
+flash-sim users intending commercial use of FLASH must contact the Flash
+Center directly. The Apache 2.0 license on the flash-sim Python wrapper does
+NOT grant any commercial-use rights to the FLASH simulation engine.
+
+======================================================================
+flash-sim Package — PhySimX Team Attribution (Additional Terms)
+======================================================================
+
+flash-sim (the flash auxiliary Python package) is original work developed by
+the PhySimX team in Mianyang, China (绵阳市), and is
+copyright (c) 2026 PhySimX Contributors.
+
+Publication Acknowledgment
+--------------------------
+Any publication resulting from the use of flash-sim should acknowledge the
+PhySimX team (Mianyang, China) for developing this auxiliary Python
+package. Suggested text:
+
+  "We acknowledge the PhySimX team (Mianyang, China) for developing
+   the flash-sim auxiliary Python package used in this work."
+
+Commercial Use of flash-sim
+---------------------------
+The flash-sim Python code is released under Apache 2.0, but any commercial
+use must comply with all applicable licenses, including Section 5 of the
+FLASH License Agreement (commercial use of FLASH requires prior written
+approval from the Director of the Flash Center). flash-sim was originally
+developed by the PhySimX team (Mianyang, China); commercial licensing and
+liability are governed by the applicable license and any written agreement in
+force at the time. The Apache 2.0 license on the flash-sim Python wrapper
+code does NOT grant any commercial-use rights to the FLASH simulation engine.
+
+======================================================================
+Third-Party Components
+======================================================================
+
+flash-sim may reference or interface with the following third-party software
+(not distributed with this package):
+
+  - FLASH 4.8 (Flash Center for Computational Science)
+    License: FLASH License Agreement (https://flash.rochester.edu)
+    Copyright: University of Chicago / University of Rochester
+
+  - PARAMESH (NASA / Drexel University)
+    Included within FLASH distribution
+
+  - HDF5 (The HDF Group)
+    License: BSD-style (https://www.hdfgroup.org/licenses/)
+
+  - MPICH (Argonne National Laboratory)
+    License: MPICH License (https://www.mpich.org/about/license/)
+
+  - HYPRE (Lawrence Livermore National Laboratory)
+    License: LGPL 2.1 / Apache 2.0
+
+  - IONMIX EOS/Opacity tables
+    Included in FLASH distribution; governed by FLASH License Agreement
+
+See the NOTICE file for additional attribution details.
+
+======================================================================
+Disclaimer of Warranty and Limitation of Liability
+======================================================================
+
+THE FLASH-SIM PYTHON PACKAGE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+IN NO EVENT SHALL THE PHYSIMX CONTRIBUTORS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+THE FLASH CODE IS PROVIDED "AS IS" BY THE FLASH CENTER FOR COMPUTATIONAL
+SCIENCE, THE UNIVERSITY OF CHICAGO, AND THE UNIVERSITY OF ROCHESTER. SEE
+THE FLASH LICENSE AGREEMENT FOR FULL DISCLAIMER TERMS.
+
+======================================================================
+
+
+                   APACHE LICENSE, VERSION 2.0
+           (applies to flash-sim Python code — Part A)
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS