Repository navigation
docs: say which process holds what in each deployment - #186
Merged
Merged
Conversation
The developer README described one workspace per proposal, shared by every notebook and program through connect(). No deployment of the first release has that: a notebook, a technique application with a batch page, and the automatic reduction are each one Python process that holds the application, its client, and its own workspace. The new section "Deployments" names the three boundaries (screen, application, workspace, binding), draws the batch page and the automatic reduction, and states the consequence: a proposal has several histories, and a value passes between them as a file. Elsewhere: open_folder is shown next to local, connect() is a hosted workspace that is not implemented, "the proposal's history" is "the workspace's history", and open questions 10 to 12 are added. The user and system stories get a note on how to read "the service". Step 1 of #184. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
The developer README keeps the rule, the boundaries, and a table of the three deployments. The drawings, what is implemented of each, and the path of a value from one workspace to another are in deployments.md. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
The glossary defined the batch-reduction service as a long-running program on DMSC servers for many users. An application that a user starts on a VISA machine serves as well (Simon, 2026-11-13). Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
The requirement said batch and automatic reduction run as services. Batch reduction may run as an application that a user starts on a VISA machine, and for a first release automatic reduction may too (Simon, 2026-11-13). The memory bound holds for each. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
5 of 7 tasks
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.
Step 1 of #184: the developer docs say which process holds what in each deployment.
Why. The README described one workspace per proposal that every notebook and program shares, reached with
connect(). No deployment of the first release has that. A notebook, a technique application with a batch page, and the automatic reduction are each one Python process that holds the application, its client, and its own workspace. The consequences were not written down anywhere.What the new page
docs/developer/deployments.mdstates. The README keeps a short section with the rule, the boundaries, and a table of the three deployments, and links to the page.Three boundaries, and which of them lies between two processes today:
A screen never calls a workspace: application logic is Python that holds a
Client, and the HTTP interface of a page belongs to that page.One drawing per deployment: notebook, technique application with a batch page, automatic reduction (one process per instrument, a workspace per proposal), and what of each is implemented.
A proposal has several histories, and a reference names a record of the same history. A value passes from one history to another as a file: written, named, published, listed, loaded. Parts exist; the path as a whole is listed as an open question.
Elsewhere in the README.
open_folderis shown next tolocal.connect()is described as a hosted workspace, not implemented and not needed by the first release. "The proposal's history" is now "the workspace's history", and "app" is "application", defined once. Three open questions are added: where bindings run (threads today; a split would go between workspace and worker processes), the path of a value between histories, and the automatic reduction as a process (routing files to per-proposal workspaces, where its configuration is kept).Requirements. The glossary defined the batch-reduction service as a long-running program on DMSC servers for many users. An application that a user starts on a VISA machine serves as well, and the entry now says so. The requirement in
users.mdthat batch and automatic reduction run as services now asks this of automatic reduction only, and allows a first release to run automatic reduction as an application on a VISA machine. The memory bound holds for each.Review. A fresh reviewer checked the text against the code and the linked guides. Fixed from it: the section claimed the batch page was implemented, while the web page is experimental and runs as a demo; "a reloaded web page" as the example of a second client in open question 9 and in
accumulators.mdno longer fits, since a page holds no client; the drawings were misaligned; several sentences repeated that no deployment needs a hosted workspace.Not done here.
connect(url, proposal=...)), and in E1 and E4 a user reads the automatic results through a second client. The conventions ofuser-stories.mdand the head ofsystem-stories.mdnow say how to read "the service". Rewriting the stories belongs with step 4 of Tracking: settle disk formats, deployments, and where reductions run #184, which settles one model for batch and automatic reduction.ess.apps.protocolandautomatic-reduction.mdstate that a history is dropped once its proposal has been idle. That rule was written for a hosted workspace; what it means for a folder is part of step 3 (what is durable).🤖 Generated with Claude Code