You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f66318a
Browse filesBrowse the repository at this point in the historyBrowse files
docs: supported platforms are Linux x86_64 and arm64 from 1.8.0 (#545)
Engine 1.8.0 is built, tested and published for Linux only (x86_64 and
arm64); no macOS archive is published and CI runs no macOS jobs. Documentation
only.
- README.md: state the supported platforms once, drop the macOS deployment
target and the macOS CI claim, drop "Same on Linux and macOS", make the
Linux compile line the primary one and keep the macOS/Clang flags as a note.
- CONTRIBUTING.md, docs/pages/getting-started.md, docs/pages/install.md: the
same wording; install.md says releases up to 1.7.0 also carry a macOS archive.
- CHANGELOG.md: a "Supported platforms" bullet in the 1.8.0 compatibility
section, one clause in the section introduction and the 1.8.0 CI leg wording.
Two sentences leave on purpose, both introduced by b2a578c ("docs: make every
README and doc page true before the release (DOCS-ENGINE) (#300)"): the README
sentence that began "The compile line is macOS/Clang's: on Linux link
-Wl,--whole-archive /usr/local/lib/libpineforge.a -Wl,--no-whole-archive, and
drop -fbracket-depth" (the Linux line is now the main example and the macOS
flags a note), and the getting-started requirement "libstdc++ from GCC 11, or
libc++ 14; on macOS a deployment target of 13.3" (macOS is no longer a
supported target).
History of earlier releases and neutral build notes are unchanged. Supersedes
#530, which carried the same tree.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,15 @@ version number follows semantic versioning over the surfaces the
11
11
paired with [pineforge-codegen 1.8.0](https://github.com/pineforge-4pass/pineforge-codegen-oss/releases/tag/v1.8.0).
12
12
A minor release. It speeds up the `run_json` wrapper (the wrapper only, not the
13
13
engine), adds one unused storage building block to the library, states where
14
-
scratch files are placed, and carries release-gate and CI changes. The C ABI
15
-
(`PF_ABI_VERSION` 4) and the run-failure code catalog are unchanged (0 codes
16
-
added, changed or removed since 1.7.0). The report keys are unchanged except
17
-
for two additive diagnostics keys, described below.
14
+
scratch files are placed, carries release-gate and CI changes, and stops
15
+
building and publishing macOS. The C ABI (`PF_ABI_VERSION` 4) and the
16
+
run-failure code catalog are unchanged (0 codes added, changed or removed
17
+
since 1.7.0). The report keys are unchanged except for two additive
18
+
diagnostics keys, described below.
18
19
19
20
### Compatibility and migration
20
21
22
+
-**Supported platforms: Linux x86_64 and arm64.** From 1.8.0 the engine is built, tested and published for Linux only: the release carries `pineforge-v1.8.0-linux-x86_64.tar.gz` and `pineforge-v1.8.0-linux-aarch64.tar.gz` (each with a `.sha256`) and no macOS archive, and CI no longer runs macOS jobs. A macOS build is neither tested nor supported.
21
23
- Pairs with codegen 1.8.0 exactly. Regenerate strategy C++ with codegen 1.8.0
22
24
and relink every strategy library against the 1.8.0 headers and
23
25
`libpineforge.a`, as for every pair change; replacing the archive alone does
@@ -164,8 +166,8 @@ for two additive diagnostics keys, described below.
164
166
pending flat-memory work, and the gate fails on a new container site.
165
167
-**Release gate reads the post-merge run (#526).** The release gate
166
168
(`scripts/ci_release_gate.py`) now also requires a green, non-skipped
167
-
`ci-post` run of the commit being released, with all four build legs
168
-
(`ubuntu-24.04`and `macos-26`, Debug and Release) successful. Until now it
169
+
`ci-post` run of the commit being released, with all Linux x86_64
170
+
and arm64 build legs (Release and Debug) successful. Until now it
169
171
read only the `pineforge/verify` and `pineforge/parity` statuses. When the
170
172
release commit is documentation-only it checks the nearest earlier commit that
171
173
is not (at most 20 documentation-only commits), and every skipped
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ The separate PineForge compiler, [`pineforge-codegen`](https://github.com/pinefo
32
32
-**Proven, not promised.** All <!-- pf:scoreboard.graded|int -->7,989<!-- /pf --> graded probes — <!-- pf:inventory.corpusScripts|int -->309<!-- /pf --> open reference strategies, <!-- pf:inventory.communityScripts|int -->680<!-- /pf --> community-shared scripts and <!-- pf:inventory.probeScripts|int -->61<!-- /pf --> probe scripts the maintainers wrote, on <!-- pf:scoreboard.lanes|int -->18<!-- /pf --> market/timeframe lanes — grade against TradingView's own trade lists: **<!-- pf:scoreboard.excellent|int -->7,983<!-- /pf --> excellent, <!-- pf:scoreboard.strong|int -->6<!-- /pf --> strong, <!-- pf:scoreboard.belowStrong|int -->0<!-- /pf --> below strong**. The graded probes' TradingView trade lists hold <!-- pf:inventory.tvTrades|int -->4,776,328<!-- /pf --> trades; <!-- pf:scoreboard.anomaliesExcluded|int -->17<!-- /pf --> probes with TradingView-side defects are excluded.
33
33
-**Open runtime.** The engine and native live runner are Apache-2.0. The separately distributed [PineForge compiler](https://github.com/pineforge-4pass/pineforge-codegen-oss/blob/main/LICENSE) is source-available under the PineForge Source License 1.2 from its release 1.3.0 (release 1.2.0 keeps the PineForge Source License 1.1, and releases up to 1.1.0 keep the PolyForm Noncommercial terms they shipped with); personal trading is free, and commercial use requires a separate license; the capital in an account a proprietary-trading firm or funded-trader program provides or allocates, including a challenge, evaluation or simulated account, is investment capital. Public reference strategies, benchmarks and validation tooling are available in their respective repositories; the community-script test set is not redistributed.
34
34
-**Fast.** In-process, no interpreter: median **36× faster than PyneCore** on the 200 strategies both engines time (100 corpus probes and 100 held-out private strategies), measured at engine `35db01c8` on 2026-09-29 on an AWS c7a.8xlarge with PyneCore timed as a subprocess, its interpreter start-up included (PineForge runs a median 807k bars/s per strategy over its 201 slots with the bar magnifier on; [method](benchmarks/results/speed.md)). Parameter sweeps re-run a loaded `.so` with new inputs — no recompile, no fork.
35
-
-**Deterministic to the bit.** Two runs with the same inputs produce identical trade lists. Same on Linux and macOS.
35
+
-**Deterministic to the bit.** Two runs with the same inputs produce identical trade lists.
36
36
-**Yours to embed.** 158 `PF_API` declarations across six installed headers — `pineforge.h`'s 102 (82 of the 93 runtime exports and up to 20 per-strategy functions a generated module defines), eleven more runtime declarations in `execution_observer.h`, `selected_window.h` and `report_sink.h` (three, three and five), `native_c_api.h`'s 43 native-host declarations and `selected_window_plan.h`'s two planner declarations — an ABI that is append-only within a major version from 1.0 on. Call it from C, Python, Rust, Go, Node, Julia — or let an AI agent drive it over MCP.
37
37
38
38
Recorded outputs and their additional API declarations described here are
The [shared local/CI verifier](docs/ci.md) includes source guards, tests and installed-package smoke checks. Its ABI check links callers against both the current library and seven separately built, pinned historical libraries. Preparation uses local Git history and the configured compiler, fetching a pinned commit the clone lacks; see the ABI fixture guide (the README of the private fixture set `settlement_cpp_abi`) for repeated checks. The first run needs network (the verifier initialises the public `corpus` submodule itself; configure fetches Eigen when no system copy is found) and a full clone: a depth-1 clone fails the benchmark provenance row ([CI guide](docs/ci.md)). CTest itself stays offline.
125
125
126
-
Prerequisites: CMake ≥ 3.16 to build (the verifier and `ctest --test-dir` need 3.20), a C++17 compiler whose standard library has floating-point `std::to_chars` (libstdc++ from GCC 11 or later, or libc++ 14 or later; on macOS a deployment target of 13.3 or later; CI builds with GCC on Ubuntu 24.04 and Apple Clang on macOS 26), Eigen 3.3+ (fetched automatically if absent), Python 3 for the tests (`-DPINEFORGE_BUILD_TESTS=OFF -DPINEFORGE_BUILD_TUTORIAL=OFF` for a library-only build). `cmake --install build --prefix /usr/local` installs `lib/libpineforge.a` and `lib/libpineforge_kernel.a`, `include/pineforge/`, and the `find_package(PineForge)` config.
126
+
**Supported platforms: Linux x86_64 and arm64.** From 1.8.0 the engine's release archives are built, and CI runs, for Linux only (`linux-x86_64` and `linux-aarch64` archives; no macOS archive). Other platforms build from source and are not tested or supported.
127
+
128
+
Prerequisites: CMake ≥ 3.16 to build (the verifier and `ctest --test-dir` need 3.20), a C++17 compiler whose standard library has floating-point `std::to_chars` (libstdc++ from GCC 11 or later, or libc++ 14 or later; CI builds with GCC on Ubuntu 24.04), Eigen 3.3+ (fetched automatically if absent), Python 3 for the tests (`-DPINEFORGE_BUILD_TESTS=OFF -DPINEFORGE_BUILD_TUTORIAL=OFF` for a library-only build). `cmake --install build --prefix /usr/local` installs `lib/libpineforge.a` and `lib/libpineforge_kernel.a`, `include/pineforge/`, and the `find_package(PineForge)` config.
127
129
128
130
### Prebuilt library
129
131
@@ -176,12 +178,12 @@ relink against that pair's headers and archive.
python3 scripts/run_strategy.py . --ohlcv tutorial/data/btcusdt_15m_7d.csv --no-trim-output # or drive it over the C ABI
182
184
```
183
185
184
-
Run it from the engine checkout, with `strategy.pine` there, after the `cmake --install` above (with a prebuilt tarball instead, add `-I<its directory>/include` and link its `lib/libpineforge.a`). Engine v1.3.0 pairs with pineforge-codegen 1.3.0, as v1.2.0 does with 1.2.0, v1.1.0 with 1.1.0, v1.0.1 with 1.0.1 and v1.0.0 with 1.0.0; codegen 0.10.4 emits C++ for engine v0.13.1, which the headers of v1.0.0, v1.0.1, v1.1.0, v1.2.0 and v1.3.0 no longer compile. No codegen release has a command-line entry point, so transpile through `transpile()`. The compile line is macOS/Clang's: on Linux link `-Wl,--whole-archive /usr/local/lib/libpineforge.a -Wl,--no-whole-archive`, and drop `-fbracket-depth` for GCC. Linking the whole archive is what puts the runtime's C exports (`pf_abi_version`, the `strategy_stream_*` family) in the module; a script that uses `matrix.*` also needs Eigen's include directory.
186
+
Run it from the engine checkout, with `strategy.pine` there, after the `cmake --install` above (with a prebuilt tarball instead, add `-I<its directory>/include` and link its `lib/libpineforge.a`). Engine v1.3.0 pairs with pineforge-codegen 1.3.0, as v1.2.0 does with 1.2.0, v1.1.0 with 1.1.0, v1.0.1 with 1.0.1 and v1.0.0 with 1.0.0; codegen 0.10.4 emits C++ for engine v0.13.1, which the headers of v1.0.0, v1.0.1, v1.1.0, v1.2.0 and v1.3.0 no longer compile. No codegen release has a command-line entry point, so transpile through `transpile()`. The compile line above is for Linux; with Clang, add `-fbracket-depth=1024`. A macOS/Clang source build instead links `-Wl,-force_load,/usr/local/lib/libpineforge.a`. Linking the whole archive is what puts the runtime's C exports (`pf_abi_version`, the `strategy_stream_*` family) in the module; a script that uses `matrix.*` also needs Eigen's include directory.
185
187
186
188
### 2. C++, against the kernel
187
189
@@ -514,7 +516,7 @@ ground written for an agent that has been handed a brief in this repository.
514
516
-`<pineforge/pineforge.h>` — the public C ABI, the stability-pinned consumer surface.
515
517
-`<pineforge/native_c_api.h>` and the native C++ host headers (`native_host.hpp`, `native_run_spec.hpp`, `native_order.hpp`, …) — the kernel's host API, which the [public contract](docs/pages/public-contract.md) covers from 1.0.0.
516
518
-`engine.hpp`, `ta.hpp`, `<pineforge/source/*.hpp>`, `<pineforge/compat/pine/*.hpp>` — the C++ the transpiler emits against (generated code derives from `pineforge::source::PineStrategyHost`); outside the version-number guarantee, held by the codegen pairing rule instead.
517
-
- C++ unit and recorded TradingView replay tests; CI on Linux + macOS × Release + Debug, sanitizers, and a `find_package` smoke consumer.
519
+
- C++ unit and recorded TradingView replay tests; CI on Linux x86_64 and arm64 × Release + Debug, sanitizers, and a `find_package` smoke consumer.
518
520
-`corpus/` — the 312-strategy public validation corpus (submodule).
519
521
-`benchmarks/` — the cross-engine comparison harness (PineForge, PyneCore, PineTS, vectorbt) and the throughput package.
520
522
-`scripts/` — `run_corpus.sh`, `verify_corpus.py`, `run_strategy.py` (load any `.so` via ctypes), `regen_corpus_cpp.sh`, `coverage.sh`.
0 commit comments