From 4d4e0bd636a120f1ca97b3aae665985cb7a1f0bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrianna=20Pi=C5=84ska?= Date: Wed, 31 Jul 2024 11:44:38 +0200 Subject: [PATCH 1/4] Add required configuration file to fix ReadTheDocs build --- .readthedocs.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..bfd7b7c --- /dev/null +++ b/.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 From 14381819b86513153720d1a9cea880c715ca0800 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrianna=20Pi=C5=84ska?= Date: Wed, 31 Jul 2024 12:08:13 +0200 Subject: [PATCH 2/4] Bump package versions to fix RTD build --- docs/requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 5c247ef..db02125 100644 --- a/docs/requirements.txt +++ b/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 From eff1b21a8b97207812e5a90963a5a91658aa4126 Mon Sep 17 00:00:00 2001 From: Angus Comrie Date: Wed, 14 Aug 2024 13:43:11 +0200 Subject: [PATCH 3/4] Remote file requests from hips2fits server (#93) * initial work on remote file requests * Update changelog, remove imports, compile messages * Update index with new minor version --------- Co-authored-by: yuhsuan Co-authored-by: Pam Harris --- docs/src/changelog.rst.txt | 3 + docs/src/enums.rst.txt | 6 ++ docs/src/index.rst | 4 +- docs/src/messages.rst.txt | 110 ++++++++++++++++++++++++++++-- request/remote_file_request.proto | 41 +++++++++++ shared/enums.proto | 2 + 6 files changed, 160 insertions(+), 6 deletions(-) create mode 100644 request/remote_file_request.proto diff --git a/docs/src/changelog.rst.txt b/docs/src/changelog.rst.txt index 4d56ac6..60a3935 100644 --- a/docs/src/changelog.rst.txt +++ b/docs/src/changelog.rst.txt @@ -219,6 +219,9 @@ Changelog * - ``28.14.0`` - 27/10/23 - Adjusted file ID generation. + * - ``28.15.0`` + - 23/05/24 + - Added :carta:ref:`RemoteFileRequest` and :carta:ref:`RemoteFileResponse` messages. Versioning ---------- diff --git a/docs/src/enums.rst.txt b/docs/src/enums.rst.txt index d23d6e6..cd066bf 100644 --- a/docs/src/enums.rst.txt +++ b/docs/src/enums.rst.txt @@ -540,6 +540,12 @@ Source file: `shared/enums.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 `_ + + + +.. 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: diff --git a/request/remote_file_request.proto b/request/remote_file_request.proto new file mode 100644 index 0000000..134fd3d --- /dev/null +++ b/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; +} diff --git a/shared/enums.proto b/shared/enums.proto index 6e998c7..7edb3fe 100644 --- a/shared/enums.proto +++ b/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 { From deaaf0a1b457f008d229de06ad3cfccd7373c334 Mon Sep 17 00:00:00 2001 From: pford Date: Mon, 19 Aug 2024 02:48:00 -0600 Subject: [PATCH 4/4] Add overwrite field to SaveFile, ExportRegion (#97) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add overwrite field to SaveFile * Increment major version in index * Add overwrite field to ExportRegion * add overwrite confirm required flag * update docs --------- Co-authored-by: yuhsuan Co-authored-by: Adrianna Pińska --- control/export_region.proto | 4 ++++ docs/src/changelog.rst.txt | 3 +++ docs/src/index.rst | 8 ++++---- docs/src/messages.rst.txt | 16 ++++++++++++++++ request/save_file.proto | 4 ++++ 5 files changed, 31 insertions(+), 4 deletions(-) diff --git a/control/export_region.proto b/control/export_region.proto index af9ffc3..d724116 100644 --- a/control/export_region.proto +++ b/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; } diff --git a/docs/src/changelog.rst.txt b/docs/src/changelog.rst.txt index 60a3935..bad4fb0 100644 --- a/docs/src/changelog.rst.txt +++ b/docs/src/changelog.rst.txt @@ -222,6 +222,9 @@ Changelog * - ``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. Versioning ---------- diff --git a/docs/src/index.rst b/docs/src/index.rst index ab6fb5e..3c4df6b 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -1,11 +1,11 @@ CARTA Interface Control Document ================================ -:Date: 03 July 2024 +:Date: 11 June 2024 :Authors: Angus Comrie, Rob Simmonds and the CARTA development team -:Version: 28.15.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 diff --git a/docs/src/messages.rst.txt b/docs/src/messages.rst.txt index 86fea72..1be9a71 100644 --- a/docs/src/messages.rst.txt +++ b/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 @@ -2356,6 +2364,10 @@ Source file: `request/save_file.proto