Repository navigation
Document running experiments across rigs - #295
Merged
Merged
Conversation
- Add the "Running on other rigs" article: the XML-RPC server and its settings, registering it as a scheduled task, RemoteRepository (ensure_running, verify, running apps, session directories and network shares), and transferring both machines' data with the watchdog - Add a remote execution example page and nav entries, and mention multi-rig experiments in the README - Fix the behavior launcher example page, which showed the literal text of a mangled snippet include instead of the code - Replace stale RpcClient/RpcExecutor/clabe.rpc names in the XML-RPC docstrings, which feed the API reference, and annotate the server's submit_command so its docstring renders
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
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.
Documents what #291, #292 and #293 added. Docs only, plus docstring fixes that feed the API reference.
New: "Running on other rigs" (
docs/articles/remote_execution.md)Written for someone deploying a second rig, in the order they would do it:
serve, andregister-task/unregister-task(what the scheduled task does and why it runs in the user's session rather than as a service).RemoteRepositoryarguments,ensure_running(), and exactly whatverify()compares.app.run_async(executor=remote), and what the executor does on top of a local run (working directory, path rewriting, copyingCommand.inputs), with the limitations.register_session,session_directoryvssession_directory_unc(which path is valid on which machine),data_roots/to_unc.Also: a "Remote execution" example page (includes
examples/client_behavior_launcher.py), nav entries, and a README bullet.Fixes found while writing it
--8 < --"..."), so the published page showed that literal text instead of the code. Fixed.XmlRpcExecutorandXmlRpcClientexamples referred toRpcClient,RpcExecutorandclabe.rpc._client, none of which exist. They render in the API reference, so they're corrected.XmlRpcServer.submit_commandgot a type annotation so its docstring renders without agriffewarning.Review notes
mkdocs build --strictshows no warnings from any page or module touched here, and every cross-reference in the new article resolves. I also checked the rendered HTML for the new pages, the example snippets, and the nav links. Docs only build on a release in CI, so nothing in CI covers this PR.griffedocstring warnings (e.g.modifiers.py,runnable/_core.py) and two unresolved cross-references (clabe.runnable.RunnableSettings,clabe.stores.confierge.DEFAULT_SCOPE_MAPPING), so--strictcannot be turned on in CI yet.launch()(Launch Open Ephys GUI and wait for its API, locally or remotely #294), which isn't merged. Its docstrings are the reference for now; the article has a natural place for a short section once it lands.ensure_running()andregister-taskdescribe Windows Task Scheduler behavior that was only tested withschtasksmocked, so the article describes what the code runs, not what was observed on a rig.