fly-ruler 0.1.0__tar.gz

fly_ruler-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 windlx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE 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
+AUTHORS OR COPYRIGHT HOLDERS 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.

fly_ruler-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: fly-ruler
+Version: 0.1.0
+Requires-Dist: casadi>=3.8.1
+Requires-Dist: filelock>=4.0.8
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: numpy>=2.5.3
+Requires-Dist: polars>=1.44.2
+Requires-Dist: pydantic>=2.13.5
+Requires-Dist: pybind11>=3.1.0
+Requires-Dist: rich>=15.0.0
+Requires-Dist: scipy>=1.18.1
+Requires-Dist: typer>=0.27.2
+Requires-Dist: jax>=0.11.2 ; extra == 'all'
+Requires-Dist: jax>=0.11.2 ; extra == 'jax'
+Requires-Dist: jax[cuda12]>=0.11.2 ; extra == 'jax-cuda12'
+Requires-Dist: jax[cuda13]>=0.11.2 ; extra == 'jax-cuda13'
+Provides-Extra: all
+Provides-Extra: jax
+Provides-Extra: jax-cuda12
+Provides-Extra: jax-cuda13
+License-File: LICENSE
+Summary: FlyRuler aircraft modeling and simulation core and standard library
+Author: windlx
+License-Expression: MIT
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Issues, https://github.com/WindLX/FlyRuler/issues
+Project-URL: Source, https://github.com/WindLX/FlyRuler
+
+# fly-ruler
+
+飞行器建模、编译、仿真与分析的 Python 包，包含 `fly_ruler_core`、`fly_ruler_std` 和原生 Rust 扩展。保留类型声明、`py.typed` 与代码生成模板。
+
+Graph 与 Plot 是同版本的独立二进制工具，通过 GitHub Release 的安装脚本安装；Python wheel 不包含它们。使用与维护说明见主仓文档：[core](../../docs/guide/components/core.md)、[std](../../docs/guide/components/std.md)、[Graph](../../docs/guide/components/graph.md)与[Plot](../../docs/guide/components/plot.md)。
+
+示例是主要教学入口：先看 [`examples/mainline/hybrid_system.py`](examples/mainline/hybrid_system.py) 的十步闭环，再按主题读 [`examples/core/`](examples/core/) 与 [`examples/std/`](examples/std/)。每个脚本都在模块 docstring 与行内注释里写清运行方式、参数含义和预期结果；目录总览见 [`examples/README.md`](examples/README.md)，`just test-examples` 会把它们按目录跑一遍。
+
+源码开发运行 `just setup-dev`，随后 `just check`、`just test`；`just build` 直接用 Maturin 构建本机 wheel。Linux 发行由版本 tag 流水线在 manylinux 2.28 中构建；Graph/Plot 在各自目录执行 `just build`。
+
+版本号只由 `just set-version X.Y.Z` 统一写入 Python 包、Rust crate、两个锁文件、Graph/Plot 前端配置与两个 README 的安装示例；`just version` 只读盘点这些来源，`just check` 会校验它们一致。发布步骤见主仓 [`RELEASING.md`](../../RELEASING.md)。
+

fly_ruler-0.1.0/README.md

@@ -0,0 +1,11 @@
+# fly-ruler
+
+飞行器建模、编译、仿真与分析的 Python 包，包含 `fly_ruler_core`、`fly_ruler_std` 和原生 Rust 扩展。保留类型声明、`py.typed` 与代码生成模板。
+
+Graph 与 Plot 是同版本的独立二进制工具，通过 GitHub Release 的安装脚本安装；Python wheel 不包含它们。使用与维护说明见主仓文档：[core](../../docs/guide/components/core.md)、[std](../../docs/guide/components/std.md)、[Graph](../../docs/guide/components/graph.md)与[Plot](../../docs/guide/components/plot.md)。
+
+示例是主要教学入口：先看 [`examples/mainline/hybrid_system.py`](examples/mainline/hybrid_system.py) 的十步闭环，再按主题读 [`examples/core/`](examples/core/) 与 [`examples/std/`](examples/std/)。每个脚本都在模块 docstring 与行内注释里写清运行方式、参数含义和预期结果；目录总览见 [`examples/README.md`](examples/README.md)，`just test-examples` 会把它们按目录跑一遍。
+
+源码开发运行 `just setup-dev`，随后 `just check`、`just test`；`just build` 直接用 Maturin 构建本机 wheel。Linux 发行由版本 tag 流水线在 manylinux 2.28 中构建；Graph/Plot 在各自目录执行 `just build`。
+
+版本号只由 `just set-version X.Y.Z` 统一写入 Python 包、Rust crate、两个锁文件、Graph/Plot 前端配置与两个 README 的安装示例；`just version` 只读盘点这些来源，`just check` 会校验它们一致。发布步骤见主仓 [`RELEASING.md`](../../RELEASING.md)。

fly_ruler-0.1.0/pyproject.toml

@@ -0,0 +1,83 @@
+[project]
+name = "fly-ruler"
+version = "0.1.0"
+description = "FlyRuler aircraft modeling and simulation core and standard library"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{name = "windlx"}]
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "casadi>=3.8.1",
+    "filelock>=4.0.8",
+    "jinja2>=3.1.6",
+    "numpy>=2.5.3",
+    "polars>=1.44.2",
+    "pydantic>=2.13.5",
+    "pybind11>=3.1.0",
+    "rich>=15.0.0",
+    "scipy>=1.18.1",
+    "typer>=0.27.2",
+]
+
+[project.urls]
+Source = "https://github.com/WindLX/FlyRuler"
+Issues = "https://github.com/WindLX/FlyRuler/issues"
+
+[project.optional-dependencies]
+jax = ["jax>=0.11.2"]
+jax-cuda12 = ["jax[cuda12]>=0.11.2"]
+jax-cuda13 = ["jax[cuda13]>=0.11.2"]
+all = ["jax>=0.11.2"]
+
+[build-system]
+requires = ["maturin>=1.15.0,<2.0"]
+build-backend = "maturin"
+
+[tool.maturin]
+manifest-path = "rust/Cargo.toml"
+module-name = "fly_ruler_core._core"
+python-source = "python"
+python-packages = ["fly_ruler_core", "fly_ruler_std"]
+exclude = [
+    "graph/**",
+    "plot/**",
+    "scripts/**",
+    "tests/**",
+    "examples/**",
+    "build/**",
+    "third-party/**",
+    "python/**/AGENTS.md",
+    "python/**/__pycache__/**",
+    "python/**/*.pyc",
+]
+include = [
+    "python/fly_ruler_core/**/*.jinja2",
+    "python/**/*.pyi",
+    "python/fly_ruler_core/py.typed",
+    "python/fly_ruler_std/py.typed",
+]
+
+[tool.uv]
+cache-keys = [
+    { file = "pyproject.toml" },
+    { file = "rust/**/*.rs" },
+    { file = "rust/Cargo.toml" },
+    { file = "rust/Cargo.lock" },
+    { file = ".cargo/config.toml" },
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "SIM"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.pytest.ini_options]
+testpaths = ["tests/core", "tests/std", "tests/release"]
+python_files = ["test_*.py"]
+addopts = "-ra -q"

fly_ruler-0.1.0/python/fly_ruler_core/__init__.py

@@ -0,0 +1,123 @@
+"""FlyRuler Core：飞行器建模与仿真的 Rust 内核与 Python 绑定。
+
+Signal-first 公共 API：`@fr.block` / `@fr.system` 加表达式 IR，经
+`PyIrBuilder` 由 `Compiler.compile()` 编译为后端模型。
+"""
+
+from . import backends, targets
+from ._core import (
+    PyBlockHandle as BlockHandle,
+)
+from ._core import (
+    PyIrBuilder,
+)
+from ._core import (
+    PySignal as Signal,
+)
+from ._core import (
+    PySubsystemHandle as SubsystemHandle,
+)
+from .api import (
+    BlockDefinition,
+    SystemDefinition,
+    block,
+    connect,
+    constrain,
+    dstate,
+    dynamics,
+    effects,
+    export,
+    input,
+    jacobian,
+    next_step,
+    output,
+    param,
+    state,
+    system,
+)
+from .api.math_namespace import math
+from .api.resource_namespace import resource
+from .artifacts import Artifact, ArtifactCachePolicy, ArtifactFile
+from .backend_spec import Backend
+from .basic import Dimension, DType, ManifoldType, SO3Integrator, SO3Representation
+from .compiler import Compiler, CompilerSpec
+from .jax_runtime import JaxRuntimePolicy, configure_jax_runtime
+from .progress import (
+    CompilationEvent,
+    CompilationReport,
+    CompilationVerbosity,
+)
+from .runtime import (
+    BatchModel,
+    BatchVariableView,
+    BuildValue,
+    CasadiArray,
+    CasadiModel,
+    CompiledModel,
+    JaxArray,
+    NativeModel,
+    NumpyArray,
+    RuntimeInput,
+    VariableInfo,
+    VariableView,
+)
+
+__all__ = [
+    # 类型别名
+    "Dimension",
+    "DType",
+    "ManifoldType",
+    "SO3Representation",
+    "SO3Integrator",
+    # 编译器
+    "CompilerSpec",
+    "Compiler",
+    "CompiledModel",
+    "CasadiModel",
+    "NativeModel",
+    "BatchModel",
+    "BatchVariableView",
+    "Backend",
+    "Artifact",
+    "ArtifactFile",
+    "ArtifactCachePolicy",
+    "CompilationEvent",
+    "CompilationReport",
+    "CompilationVerbosity",
+    "JaxRuntimePolicy",
+    "configure_jax_runtime",
+    "backends",
+    "targets",
+    # 构建器
+    "PyIrBuilder",
+    # 信号优先的公开 API
+    "Signal",
+    "BlockHandle",
+    "BlockDefinition",
+    "SubsystemHandle",
+    "SystemDefinition",
+    "block",
+    "system",
+    "input",
+    "jacobian",
+    "state",
+    "dstate",
+    "param",
+    "output",
+    "effects",
+    "dynamics",
+    "next_step",
+    "constrain",
+    "export",
+    "connect",
+    "math",
+    "resource",
+    # 类型
+    "NumpyArray",
+    "JaxArray",
+    "CasadiArray",
+    "BuildValue",
+    "RuntimeInput",
+    "VariableInfo",
+    "VariableView",
+]