Updating service docs (Meiji) #197

meiji274 · 2024-05-08T21:01:59Z

This is part of the team effort to fill out the documentation pages in the services module of catkit2 (see issue #190 for more information).

So far I am planning to do 3 services (will update if more are needed):
-[x] ZWO camera
-[x] Newport picomotor
-[x] Web power switch

ivalaginja

Thanks for picking this up, just leaving you some comments before you move on.

ivalaginja · 2024-05-09T11:43:36Z

docs/services/zwo_camera.rst

+This service operates a ZWO camera. There are currently four different types of ZWO cameras being used on the testbed:
+- ZWO ASI533MM (Science camera, https://www.zwoastro.com/product/asi533mm-mc/)
+- ZWO ASI290MM (TA camera, https://agenaastro.com/zwo-asi290mm-cmos-monochrome-astronomy-imaging-camera.html)
+- ZWO ASI178MM (MOWFS Camera and Pupil Camera, https://agenaastro.com/zwo-asi178mm-cmos-monochrome-astronomy-imaging-camera.html)
+- ZWO ASI1600MM (Phase Retrieval Camera, https://agenaastro.com/zwo-asi1600mm-p-cmos-monochrome-astronomy-imaging-camera-pro.html)


The documentation should not refer to a specific testbed. Instead, there should just be a list of concrete devices (the ones you list here) that have been tested and used with catkit2 so far.

ivalaginja · 2024-05-09T11:44:14Z

docs/services/zwo_camera.rst

+    science_camera:
+        service_type: zwo_camera
+        simulated_service_type: camera_sim
+        interface: hicat_camera


Here too, replace the hicat reference with either a default proxy that lives inside of catkit2, or if there is none, just delete this line (a dedicated proxy is not required for a service).

ivalaginja · 2024-05-09T11:44:39Z

docs/services/zwo_camera.rst

+        exposure_time_step_size: 33
+        exposure_time_offset_correction: -79.2
+        exposure_time_base_step: 50


These lines can go as well as they relate to the hicat camera proxy only.

ivalaginja · 2024-05-09T11:45:00Z

docs/services/zwo_camera.rst

+        exposure_time_offset_correction: -79.2
+        exposure_time_base_step: 50
+
+    ta_camera:


We only need one entry as an example. Remember, these are the catkit2 docs, not the hicat docs.

ivalaginja · 2024-05-13T11:10:23Z

docs/services/zwo_camera.rst

+``take_calibrated_exposures(num_exposures, only_use_cache=True)``: This takes a number of calibrated exposures.
+
+``get_exposure_calibration_function(only_use_cache=True)``: This gets a function to calibrate individual exposures.
+
+``take_calibrated_image(num_exposures, upsample_factor=None, alignment_window=None, only_use_cache=True)``: This takes a calibrated 
+image which is background subtracted, exposure time corrected, nd flux calibrated and sub-frame aligned using phase cross correlation method.
+
+``take_dark(num_exposures)``: This takes a dark image for the current exposure time by moving the beam dump.


Careful, this is again from the HiCAT proxy, so these need to be deleted. If you want to make a note about the generic camera proxy, then it might be best to do this in the general description up top in this doc.

ivalaginja

Looking good except for one minor comment.

ivalaginja · 2024-05-23T16:38:15Z

docs/services/web_power_switch.rst

+For some examples of commercially available web power switches:
+https://controlbyweb.com/webswitch/
+https://dlidirect.com/products/new-pro-switch


Can you list the ones that have been run successfully with catkit2?

ehpor · 2024-05-22T23:33:47Z

docs/services/web_power_switch.rst

@@ -1,14 +1,48 @@
 Web Power Switch
 ================

+This service controls a power switch that is controllable over the internet.


It's for a very specific web power switch. Look up which one we use.

I asked Raphael and it should be the link below that he sent me (line 7).

ehpor · 2024-05-22T23:35:01Z

docs/services/web_power_switch.rst


 Datastreams
 -----------
+``{outlet_name}``: The name of an outlet added by the user using the add_outlet() command.


This is wrong. The outlet names are defined by the config.

ivalaginja

Only minor inline comments, but I also just noticed that your links are not formatted URLs - for rst files, you need to declare/format them as described in this link, otherwise they are unclickable (see also examples in other service docs):
https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#links-to-external-web-pages

ivalaginja · 2024-05-24T11:27:03Z

docs/services/newport_picomotor.rst

+``{axis_name}_command``: A movement command along the axis corresponding to axis_name (where axis_name can be x, y, or z).
+
+``{axis_name}_current_position``: The current position of the picomotor along the axis corresponding to axis_name (where axis_name can be x, y, or z).


In line with Emiel's comment further below, let's also specify here that the axis names are defined in the service configuration.

ivalaginja · 2024-05-24T11:28:12Z

docs/services/web_power_switch.rst

+So far catkit2 has been tested on the LPC7-PRO web power switch from TeleDynamics:
+https://www.teledynamics.com/#/productdetails/LPC7-PRO


This is minor, but could you reformat this into a bullet list like you did for the ZWO camera models? This is also how we have it in some other service docs and makes it simpler to extend later on (and to find where to extend).

ivalaginja · 2024-05-24T11:29:05Z

docs/services/zwo_camera.rst

@@ -1,14 +1,64 @@
 ZWO Camera
 ==========

+This service operates a ZWO camera. There are currently four different types of ZWO cameras that have been tested and used with catkit2 so far:


Ditch the "four" to limit the risk of incomplete list extension in the future, put down something like "the following devices" instead.

ivalaginja · 2024-05-24T15:55:49Z

docs/services/zwo_camera.rst

@@ -1,14 +1,64 @@
 ZWO Camera


It needs to be stated here that using the ZWO cameras requires the installation of their drivers - you can copy that information from here, and delete the comment from the env file:

catkit2/environment.yml

Line 41 in 0670c9e

- zwoasi>=0.0.21 # Requires additional manual install of driver(s) from https://astronomy-imaging-camera.com/software-drivers

ivalaginja · 2024-05-24T15:56:30Z

docs/services/newport_picomotor.rst

+
+https://www.newport.com/f/open-loop-picomotor-motion-controller
+
+The bottom of the webpage linked above has resources for the user including software downloads, technical notes, and user manuals.


Please state more clearly whether for example a driver needs to be installed for this device or not.

ivalaginja · 2024-05-24T15:57:05Z

docs/services/web_power_switch.rst

@@ -1,14 +1,47 @@
 Web Power Switch


Same here, can you confirm no driver installation is required, or alternately state here that it is required?

ivalaginja

Almost there - there's one language fix I'd like to be addressed. I also left two comments asking you to go slightly out of scope of this PR but it's minor and is still related, it would be great if you could implement those too.

ivalaginja · 2024-05-25T12:35:40Z

docs/services/zwo_camera.rst

+
+``brightness``: Brightness of the camera.
+
+``width``: The width of the camera.


I just noticed that the description of width and height, as well as x and y offset are not really clear - it was me who wrote this for the Alvium and Hamamatsu camera but let's use this opportunity to fix this.

Width and height should be "of the camera frames." or "images" if you like that better.
Offset x and y should be: "... of the camera frames on the sensor." or anything that specifies better.

Could I also ask you to sneak in a fix for this in the Alvium and Hamamatsu service doc please?

ivalaginja · 2024-05-25T12:36:29Z

docs/services/zwo_camera.rst


 Datastreams
 -----------
+``temperature``: The temperature as measured by this sensor in Celsius.


Let's replace "this sensor" by "the camera", and also port that change to the Alvium and Hamamatsu service doc.

ivalaginja · 2024-05-25T12:37:25Z

docs/services/zwo_camera.rst

+- `ZWO ASI1600MM <https://agenaastro.com/zwo-asi1600mm-p-cmos-monochrome-astronomy-imaging-camera-pro.html>`_
+
+For camera specs, see the website links above.
+Note that to use the ZWO cameras requires additional manual install of driver(s) from `zwoastro.com <https://astronomy-imaging-camera.com/software-drivers>`_ 


This is a wonky sentence, please fix to: "Note that using ZWO cameras requires a manual installation of..."

ivalaginja · 2024-05-29T13:00:20Z

docs/services/zwo_camera.rst

 Properties
 ----------
+``exposure_time``: Exposure time of the camera.


One last one: please add the exposure time units here.

meiji274 added the documentation label May 8, 2024

meiji274 requested a review from ivalaginja May 8, 2024 21:01

meiji274 self-assigned this May 8, 2024

meiji274 changed the title ~~Updating docs pages (Meiji)~~ Updating service docs (Meiji) May 8, 2024

ivalaginja reviewed May 9, 2024

View reviewed changes

ivalaginja reviewed May 13, 2024

View reviewed changes

meiji274 mentioned this pull request May 14, 2024

Fill in all service doc pages #190

Open

21 tasks

meiji274 marked this pull request as ready for review May 22, 2024 21:15

meiji274 force-pushed the feature/add_service_docs_meiji branch from c98f813 to 6d93913 Compare May 22, 2024 21:16

ivalaginja marked this pull request as draft May 23, 2024 14:23

ivalaginja force-pushed the feature/add_service_docs_meiji branch from 6d93913 to 503f353 Compare May 23, 2024 14:29

ivalaginja requested changes May 23, 2024

View reviewed changes

meiji274 marked this pull request as ready for review May 23, 2024 17:20

ehpor reviewed May 23, 2024

View reviewed changes

ivalaginja requested changes May 24, 2024

View reviewed changes

ivalaginja reviewed May 24, 2024

View reviewed changes

ivalaginja requested changes May 24, 2024

View reviewed changes

meiji274 added 10 commits May 24, 2024 13:51

updated docs page for zwo camera

8ee26bf

address PR comments

40c9205

removed proxy commands

e7037d3

added documentation for newport picomotor and web power switch

32cd199

found the web power switch used by hicat

be12f7d

added extra comment to picomotor docs

95c5f2e

corrected description of outlet_name datastream

c3f94b9

address PR comments to add proper hyperlinks and minor reformatting

5de1497

minor formatting edits

7c4a8b8

added driver and user manual information and links

e8538cd

meiji274 force-pushed the feature/add_service_docs_meiji branch from ac247c9 to e8538cd Compare May 24, 2024 17:51

minor formatting

d006cd9

ivalaginja reviewed May 25, 2024

View reviewed changes

minor language edits to three camera types

3adc430

ivalaginja reviewed May 29, 2024

View reviewed changes

added units for exposure time

8932bc2

ivalaginja approved these changes May 29, 2024

View reviewed changes

ivalaginja merged commit dc0c024 into develop May 29, 2024
6 checks passed

ivalaginja deleted the feature/add_service_docs_meiji branch May 29, 2024 16:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating service docs (Meiji) #197

Updating service docs (Meiji) #197

meiji274 commented May 8, 2024 •

edited

ivalaginja left a comment

ivalaginja May 9, 2024

ivalaginja May 9, 2024

ivalaginja May 9, 2024

ivalaginja May 9, 2024

ivalaginja May 13, 2024

ivalaginja left a comment

ivalaginja May 23, 2024

meiji274 May 23, 2024

ehpor May 22, 2024

meiji274 May 23, 2024 •

edited

ehpor May 22, 2024

ivalaginja left a comment •

edited

ivalaginja May 24, 2024

ivalaginja May 24, 2024

ivalaginja May 24, 2024

ivalaginja May 24, 2024

ivalaginja May 24, 2024

ivalaginja May 24, 2024

ivalaginja left a comment

ivalaginja May 25, 2024

ivalaginja May 25, 2024

ivalaginja May 25, 2024

ivalaginja May 29, 2024

		``{axis_name}_command``: A movement command along the axis corresponding to axis_name (where axis_name can be x, y, or z).

		``{axis_name}_current_position``: The current position of the picomotor along the axis corresponding to axis_name (where axis_name can be x, y, or z).

		So far catkit2 has been tested on the LPC7-PRO web power switch from TeleDynamics:
		https://www.teledynamics.com/#/productdetails/LPC7-PRO


		https://www.newport.com/f/open-loop-picomotor-motion-controller

		The bottom of the webpage linked above has resources for the user including software downloads, technical notes, and user manuals.


		``brightness``: Brightness of the camera.

		``width``: The width of the camera.

Updating service docs (Meiji) #197

Updating service docs (Meiji) #197

Conversation

meiji274 commented May 8, 2024 • edited

ivalaginja left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivalaginja left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

meiji274 May 23, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivalaginja left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivalaginja left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

meiji274 commented May 8, 2024 •

edited

meiji274 May 23, 2024 •

edited

ivalaginja left a comment •

edited