docs: drop 'chimaera' brand mentions outside Deprecation Notes#15
Merged
Conversation
User-facing prose in installation, monitoring, hpc-cluster, faq, quick-start, configuration, and a few module-test snippets still described the CLI as 'chimaera', the log file as /tmp/chimaera.log, and the bdev ChiMod as 'chimaera_bdev'. The canonical names are 'clio_run', /tmp/clio.log, and 'clio_bdev' respectively — fix the prose, leave the deprecation-notes page alone (its job is to catalog the legacy names). Changes: - installation.mdx: 'chimaera CLI' -> 'clio_run CLI'; docker-compose example mounts ./clio.yaml -> /home/iowarp/.clio/clio.yaml and uses the canonical 'clio_run start' command form. - monitoring.md: /tmp/chimaera.log -> /tmp/clio.log; the chimaera_pool_list example pointed at a binary that doesn't exist — replaced with the actual 'clio_run monitor' subcommand. - hpc-cluster.md: same chimaera_pool_list fix. - faq.md: 'pkill chimaera_*' -> 'pkill clio_*' in the pssh warning. - quick-start.mdx: bundled-modules table 'chimaera_bdev' -> 'clio_bdev'. - configuration.md: every YAML compose example switched to 'mod_name: clio_bdev'; /tmp/chimaera.log -> /tmp/clio.log; the prose 'Only chimaera_bdev is required' -> 'Only clio_bdev is required'. Preserved (out of scope for this PR — needs the C++ API to rebrand first, separate effort): - C++ namespace references (chimaera::admin::Client, chimaera::bdev::*). Those are the current C++ namespace and renaming the docs without renaming the code would mismatch reality. - find_package(chimaera ...) / find_package(chimaera_admin ...) calls in SDK docs. The build still exports these names as backward-compat aliases. - <chimaera/chimaera.h> / <chimaera/MOD_NAME/*.h> include paths. - CHIMAERA_INIT / ChimaeraMode enum names. - deprecation-notes.md and the two legacy-paths callouts in configuration.md (line 23) + monitoring.md (line 205) that explicitly point readers at the deprecation notes for the full lookup order.
lukemartinlogan
added a commit
to iowarp/clio-core
that referenced
this pull request
May 26, 2026
* docs(readme): add INSTALL.md and drop 'chimaera' brand from prose Three companion changes: 1. New INSTALL.md at repo root, aimed at users building from source on bare-metal Linux. Enumerates the always-required system prerequisites (with both apt and dnf install commands), then a per-feature table for every CMake -D<FLAG>=ON switch and what dep it pulls in (MPI, libfabric, Thallium, io_uring, all six compression codecs, OpenSSL, all eight CTE adapters including FUSE3 / HDF5 / ADIOS2 / NVIDIA GDS, CUDA / ROCm / SYCL / NVSHMEM / NIXL, Python bindings, OpenMP, sanitizer + coverage + Doxygen). Includes a feature checklist users can tick to assemble their CMake invocation. Top of the file points binary-only users at the pip / conda / release-tag channels so they don't read further. 2. README diagram + prose: 'Chimaera Runtime' -> 'CLIO Runtime'. Drop the 'legacy: ~/.chimaera/chimaera.yaml' parenthetical from both config-seeding callouts since ~/.clio/clio.yaml is the canonical user path now. Drop the 'historical install-time names (chimaera::*, wrp_cte::*, wrp_cae::*)' sentence — those aliases are still exported but the README isn't the right place to advertise them; point readers at Deprecation Notes instead. `ctest -R chimaera` -> `ctest -R runtime` in the testing example. 3. Bump docs/ submodule to docs/no-chimaera-cli-brand (PR iowarp/docs#15) which does the matching cleanup on the docs site: 'chimaera CLI' -> 'clio_run CLI', /tmp/chimaera.log -> /tmp/clio.log, chimaera_pool_list -> clio_run monitor, every YAML compose example switched to mod_name: clio_bdev. The C++ API references (chimaera::*, CHIMAERA_INIT, <chimaera/...>, find_package(chimaera ...)) are intentionally left alone — they describe the current C++ API and renaming them requires a separate code-rebrand effort. * test: lowercase CAE_*/CEE_* test names + give CEE Python tests cee_ prefix Catch2 ctest registrations had two prefix conventions: lowercase 'cae_*' (e.g. cae_binary_assim from the add_cae_unit_test helper) AND mixed-case 'CAE_*' (e.g. CAE_ClientInit from direct add_test calls). 'CEE_*' had the same split with three uppercase Python tests (test_context_interface_python, _enhanced_python, _retrieve_roundtrip_python) thrown in for good measure. Effect: `ctest -R cae` (case-sensitive default regex) only matched the lowercase set, silently skipping ~18 CAE_*/CEE_* registrations. Lowercase every ctest NAME so a single prefix matches them all: - CAE_ClientInit -> cae_clientinit, CAE_AssimilationCtx_Default -> cae_assimilationctx_default, ... (19 names) - CEE_Init -> cee_init, CEE_Retrieve_Basic -> cee_retrieve_basic, ... (16 names) - test_context_interface_python -> cee_python_interface test_context_interface_enhanced_python -> cee_python_interface_enhanced test_context_retrieve_roundtrip_python -> cee_python_retrieve_roundtrip The Catch2 tag arguments ('[cae][core][init]' etc.) and the .py filenames are unchanged — only ctest NAMEs were touched. The set_tests_properties NAME lists in both CMakeLists were rewritten to match. Also fix the README ctest examples to use the actual prefixes: 'ctest -R runtime' (matches nothing — there is no 'runtime_*' test) -> 'ctest -R cr' (matches the cr_chimaera_unit_tests etc. that the runtime test suite actually uses). Add explicit cae and cee lines; drop the obsolete 'omni' alias. * docs(readme): rewrite per-engine READMEs and promote clio::cee:: target Rewrite the README.md in each context-* subdirectory to drop legacy terminology (hermes_shm/HSHM, Chimaera/CHIMAERA_INIT, WRP_CORE_ENABLE_*, iowarp-runtime, iowarp/iowarp-build, grc-iit clone URLs, chi:: namespace) and to remove backward-compat call-outs. Examples now use clio::run::, clio::cte::, clio::cae::, and clio::cee:: as the canonical namespaces, and link via find_package(clio-core) + the unified modular targets. Move the C++ CTE Put/Get example out of the root README and make context-transfer-engine/README.md the canonical place for the CTE client-side API reference. Simplify the root README's components and benchmarking sections accordingly. Align CEE with the clio::<engine>:: scheme used by CTE/CAE: - Add context-exploration-engine/clio_repo.yaml with namespace: clio::cee. - Update context-exploration-engine/api/CMakeLists.txt to expose clio::cee::api as the canonical alias and to install the export set under NAMESPACE clio::cee:: with EXPORT_NAME api, so downstream find_package() consumers see clio::cee::api. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to iowarp/clio-core PR $pending which removes every 'chimaera' / 'chimaera CLI' brand reference from the top-level README. This PR does the same on the docs site.
Changed
./clio.yaml→/home/iowarp/.clio/clio.yamland uses the canonicalclio_run startcommand form./tmp/chimaera.log→/tmp/clio.log; thechimaera_pool_listexample pointed at a non-existent binary, replaced with the actualclio_run monitorsubcommand.chimaera_pool_list→clio_run monitorfix.pkill chimaera_*→pkill clio_*in the pssh warning.chimaera_bdev→clio_bdev.mod_name: chimaera_bdev→mod_name: clio_bdev; `chimaera_bdev` prose → `clio_bdev`;/tmp/chimaera.log→/tmp/clio.log.mod_name: chimaera_bdevin YAML snippets →clio_bdev.Preserved (out of scope — separate API-rebrand effort)
chimaera::admin::Client,chimaera::bdev::*,namespace chimaera::MOD_NAME) in SDK docs. The C++ codebase still uses these as the current namespace; renaming docs without renaming the code would mismatch reality.find_package(chimaera ...)/find_package(chimaera_admin ...)calls. Build system still exports these names as backward-compat CMake aliases.<chimaera/chimaera.h>and<chimaera/MOD_NAME/...>include paths.CHIMAERA_INIT/ChimaeraModeC++ macro + enum names.deprecation-notes.mdand the two legacy-paths callouts inconfiguration.md(line 23) +monitoring.md(line 205) — those exist specifically to document the legacy spellings and link to the deprecation notes.🤖 Generated with Claude Code