Skip to content

Doc clarifications#438

Open
ivalaginja wants to merge 8 commits intodevelopfrom
doc_clarifications
Open

Doc clarifications#438
ivalaginja wants to merge 8 commits intodevelopfrom
doc_clarifications

Conversation

@ivalaginja
Copy link
Copy Markdown
Collaborator

@ivalaginja ivalaginja commented May 5, 2026

This PR contains a couple of doc updates and simulator example updates I found worthy changing while I was working on capsule setup over the first couple of days.

  • Updates the Getting started instructions to be more explicit about how to handle the cookiecutter results
  • Adds info to the ZWO camera documentation about the required environment variable that points to the vendor SDK
  • Inserts an explicitly stated unit wavelength with its own variable in the template simulator provided by cookiecutter, as it is otherwise just silently assumed and hard to identify for necessary changes.
  • Both for cookiecutter template simulator, as well as simple simulator: changes the camera_readout() function to actually use the passed in camera_name variable and not the hard-coded science_camera. Also removes the images data stream from the simulator as image data streams are standardly associated with a (simulated or hardware) camera.

@ivalaginja ivalaginja self-assigned this May 5, 2026
@ivalaginja ivalaginja marked this pull request as ready for review May 6, 2026 09:07
@ivalaginja ivalaginja force-pushed the doc_clarifications branch from 38bbd65 to b0b512a Compare May 8, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant