Merge branch 'dev' into moment_restfreq

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/src/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

control/export_region.proto

@@ -21,6 +21,8 @@ message ExportRegion {
     string directory = 5;
     // Optional file name of server file
     string file = 6;
+    // Optional overwrite existing file
+    bool overwrite = 7;
 }
 
 // EXPORT_REGION_ACK
@@ -32,4 +34,6 @@ message ExportRegionAck {
     string message = 2;
     // File contents for client export (one line per string)
     repeated string contents = 3;
+    // Request for overwrite confirmation
+    bool overwrite_confirmation_required = 4;
 }

docs/requirements.txt

@@ -1,4 +1,4 @@
-Sphinx==4.1.2
+Sphinx==7.3.7
 plantweb==1.2.1
-sphinxcontrib-svg2pdfconverter==1.1.1
-sphinx-rtd-theme==0.5.2
+sphinxcontrib-svg2pdfconverter==1.2.2
+sphinx-rtd-theme==2.0.0

docs/src/changelog.rst.txt

@@ -220,6 +220,12 @@ Changelog
      - 27/10/23
      - Adjusted file ID generation.
    * - ``28.15.0``
+     - 23/05/24
+     - Added :carta:ref:`RemoteFileRequest` and :carta:ref:`RemoteFileResponse` messages.
+   * - ``29.0.0``
+     - 26/06/24
+     - Added ``overwrite`` to :carta:ref:`SaveFile` and :carta:ref:`ExportRegion` messages.
+   * - ``29.1.0``
      - 23/07/24
      - Added ``rest_freq`` to :carta:ref:`MomentRequest` message.
 

docs/src/enums.rst.txt

@@ -540,6 +540,12 @@ Source file: `shared/enums.proto <https://github.com/CARTAvis/carta-protobuf/blo
    * - :carta:refc:`CLOSE_PV_PREVIEW`
      - 87
      - 
+   * - :carta:refc:`REMOTE_FILE_REQUEST`
+     - 88
+     - 
+   * - :carta:refc:`REMOTE_FILE_RESPONSE`
+     - 89
+     - 
 
 .. carta:class:: carta-sub filefeatureflags
 

docs/src/index.rst

@@ -1,11 +1,11 @@
 CARTA Interface Control Document
 ================================
 
-:Date: 14 August 2023
+:Date: 11 June 2024
 :Authors: Angus Comrie, Rob Simmonds and the CARTA development team
-:Version: 28.14.0
-:ICD Version Integer: 28
-:CARTA Target: Version 4.0
+:Version: 29.0.0
+:ICD Version Integer: 29
+:CARTA Target: Version 5.0
 
 .. include:: changelog.rst.txt
 

docs/src/messages.rst.txt

@@ -657,6 +657,10 @@ Backend responds with  :carta:refc:`EXPORT_REGION_ACK`
      - string
      - 
      - Optional file name of server file
+   * - overwrite
+     - bool
+     - 
+     - Optional overwrite existing file
 
 .. carta:class:: carta-b2f exportregionack
 
@@ -691,6 +695,10 @@ Response for :carta:refc:`EXPORT_REGION` to indicate success and file contents i
      - string
      - repeated
      - File contents for client export (one line per string)
+   * - overwrite_confirmation_required
+     - bool
+     - 
+     - Request for overwrite confirmation
 
 .. carta:class:: carta-f2b fileinforequest
 
@@ -2088,6 +2096,108 @@ Informs the frontend whether the session was correctly.
      - repeated
      - Map of server-generated platform information strings
 
+.. carta:class:: carta-f2b remotefilerequest
+
+.. _remotefilerequest:
+
+RemoteFileRequest
+~~~~~~~~~~~~~~~~~
+
+Source file: `request/remote_file_request.proto <https://github.com/CARTAvis/carta-protobuf/blob/dev/request/remote_file_request.proto>`_
+
+
+
+.. list-table::
+   :widths: 20 20 20 40
+   :header-rows: 1
+   :class: proto
+
+   * - Field
+     - Type
+     - Label
+     - Description
+   * - file_id
+     - sfixed32
+     - 
+     - File ID
+   * - hips
+     - string
+     - 
+     - ID or keyword identifying the HiPS to use
+   * - wcs
+     - string
+     - 
+     - The WCS definition of the cutout, defined as a key-value dictionary JSON string
+   * - width
+     - int32
+     - 
+     - Width in pixels of the output image
+   * - height
+     - int32
+     - 
+     - Height in pixels of the output image
+   * - projection
+     - string
+     - 
+     - Name of the requested projection, eg: SIN, TAN, MOL, AIT, CAR, CEA, STG
+   * - fov
+     - float
+     - 
+     - Size (FoV) of the cutout on the sky, in decimal degrees
+   * - ra
+     - float
+     - 
+     - Right ascension in decimal degrees of the center of the output image
+   * - dec
+     - float
+     - 
+     - Declination in decimal degrees of the center of the output image
+   * - coordsys
+     - string
+     - 
+     - coordsys	Coordinate frame system to be used for the projection
+   * - rotation_angle
+     - float
+     - 
+     - Angle value (in decimal degrees) to be applied to the projection
+   * - object
+     - string
+     - 
+     - Name of the object the output image will be centered on. The name will be resolved to coordinated by the Sesame service.
+
+.. carta:class:: carta-b2f remotefileresponse
+
+.. _remotefileresponse:
+
+RemoteFileResponse
+~~~~~~~~~~~~~~~~~~
+
+Source file: `request/remote_file_request.proto <https://github.com/CARTAvis/carta-protobuf/blob/dev/request/remote_file_request.proto>`_
+
+
+
+.. list-table::
+   :widths: 20 20 20 40
+   :header-rows: 1
+   :class: proto
+
+   * - Field
+     - Type
+     - Label
+     - Description
+   * - success
+     - bool
+     - 
+     - Defines whether the remote file was opened successfully
+   * - message
+     - string
+     - 
+     - Error message (if applicable)
+   * - open_file_ack
+     - :carta:refc:`OpenFileAck`
+     - 
+     - Opened file information
+
 .. carta:class:: carta-f2b removeregion
 
 .. _removeregion:
@@ -2258,6 +2368,10 @@ Source file: `request/save_file.proto <https://github.com/CARTAvis/carta-protobu
      - double
      - 
      - Set the rest frequency (Hz) of the image
+   * - overwrite
+     - bool
+     - 
+     - Overwrite existing image
 
 .. carta:class:: carta-f2b savefileack
 
@@ -2291,6 +2405,10 @@ Source file: `request/save_file.proto <https://github.com/CARTAvis/carta-protobu
      - string
      - 
      - 
+   * - overwrite_confirmation_required
+     - bool
+     - 
+     - Request for overwrite confirmation
 
 .. carta:class:: carta-f2b scriptingrequest
 

request/remote_file_request.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+package CARTA;
+
+import "open_file.proto";
+
+message RemoteFileRequest {
+  // File ID
+  sfixed32 file_id = 1;
+  // ID or keyword identifying the HiPS to use
+  string hips = 2;
+  // The WCS definition of the cutout, defined as a key-value dictionary JSON string
+  string wcs = 3;
+  // Width in pixels of the output image
+  int32 width = 4;
+  // Height in pixels of the output image
+  int32 height = 5;
+  // Name of the requested projection, eg: SIN, TAN, MOL, AIT, CAR, CEA, STG
+  string projection = 6;
+  // Size (FoV) of the cutout on the sky, in decimal degrees
+  float fov = 7;
+  // Right ascension in decimal degrees of the center of the output image
+  float ra = 8;
+  // Declination in decimal degrees of the center of the output image
+  float dec = 9;
+  // coordsys	Coordinate frame system to be used for the projection
+  string coordsys = 10;
+  // Angle value (in decimal degrees) to be applied to the projection
+  float rotation_angle = 11;
+  // Name of the object the output image will be centered on.
+  // The name will be resolved to coordinated by the Sesame service.
+  string object = 12;
+}
+
+message RemoteFileResponse {
+  // Defines whether the remote file was opened successfully
+  bool success = 1;
+  // Error message (if applicable)
+  string message = 2;
+  // Opened file information
+  OpenFileAck open_file_ack = 3;
+}

request/save_file.proto

@@ -17,10 +17,14 @@ message SaveFile {
     bool keep_degenerate = 8;
     // Set the rest frequency (Hz) of the image
     double rest_freq = 9;
+    // Overwrite existing image
+    bool overwrite = 10;
 }
 
 message SaveFileAck {
     sfixed32 file_id = 1;
     bool success = 2;
     string message = 3;
+    // Request for overwrite confirmation
+    bool overwrite_confirmation_required = 4;
 }

shared/enums.proto

@@ -80,6 +80,8 @@ enum EventType {
     PV_PREVIEW_DATA = 85;
     STOP_PV_PREVIEW = 86;
     CLOSE_PV_PREVIEW = 87;
+    REMOTE_FILE_REQUEST = 88;
+    REMOTE_FILE_RESPONSE = 89;
 }
 
 enum SessionType {