Merge pull request #2653 from cta-observatory/fix_cta_icon

Fix CTAO link in docs
cta-observatory · Nov 18, 2024 · 9f2d9a7 · 9f2d9a7
2 parents f248b66 + bff1f69
commit 9f2d9a7
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 18 deletions.
diff --git a/README.rst b/README.rst
@@ -18,8 +18,8 @@
 .. |pypi| image:: https://badge.fury.io/py/ctapipe.svg
     :target: https://pypi.org/project/ctapipe
 
-Low-level data processing pipeline software for
-`CTA <https://www.cta-observatory.org>`__ (the Cherenkov Telescope Array)
+Low-level data processing pipeline software for the
+`CTAO (Cherenkov Telescope Array Observatory) <https://www.ctao.org>`__.
 
 This is code is a prototype data processing framework and is under rapid
 development. It is not recommended for production use unless you are an

diff --git a/docs/api-reference/instrument/camera_geometry.rst b/docs/api-reference/instrument/camera_geometry.rst
@@ -11,7 +11,7 @@ cubes related to Cherenkov Cameras.  In *ctapipe*, a camera image is
 simply a flat 1D array (or 2D if time information is included), where
 there is one value per pixel. Of course, to work with such an array,
 one needs spatial information about how the pixels are laid out.
-Since CTA has at least 6 different camera types, and may have multiple
+Since CTAO has at least 6 different camera types, and may have multiple
 versions of each as revisions are made, it is necessary to have a
 common way to describe all cameras.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -307,10 +307,10 @@ def setup(app):
     "icon_links_label": "Quick Links",
     "icon_links": [
         {
-            "name": "CTA Observatory",
-            "url": "https://www.cta-observatory.org/",
+            "name": "CTAO",
+            "url": "https://www.ctao.org/",
             "type": "url",
-            "icon": "https://www.cta-observatory.org/wp-content/themes/ctao/favicon.ico",  # noqa: E501
+            "icon": "https://www.ctao.org/wp-content/uploads/cropped-Favicon_CTAO_1-32x32.png",  # noqa: E501
         },
     ],
     "announcement": """
@@ -385,7 +385,8 @@ def setup(app):
         "ctapipe Documentation",
         author,
         "ctapipe",
-        "Experimental Data Analysis for the" "Cherenkov Telescope Array (CTA).",
+        "Experimental Data Analysis for the"
+        "Cherenkov Telescope Array Observatory (CTAO).",
         "Science",
     )
 ]

diff --git a/docs/developer-guide/code-guidelines.rst b/docs/developer-guide/code-guidelines.rst
@@ -2,8 +2,8 @@
 Code Guidelines
 ***************
 
-Coding should follow the CTA coding guidelines from the **CTA Code
-Standards** document.
+Coding should follow the CTA coding guidelines from the **CTAO Software
+Programming Standards** document :cite:p:`ctao-software-standards`.
 
 Here, we list useful guidelines for the logical structure of code (see
 also the style-guide for code style).  This guide is subject to change

diff --git a/docs/developer-guide/getting-started.rst b/docs/developer-guide/getting-started.rst
@@ -18,7 +18,7 @@ We strongly recommend using the `mambaforge conda distribution <https://github.c
 Forking vs. Working in the Main Repository
 ==========================================
 
-If you are a member of CTA (Consortium or Observatory), or
+If you are a member of CTAO (Consortium or Central Organization), or
 otherwise a regular contributor to ctapipe, the maintainers can give you
 access to the main repository at ``cta-observatory/ctapipe``.
 Working directly in the main repository has two main advantages

diff --git a/docs/developer-guide/support-libraries.rst b/docs/developer-guide/support-libraries.rst
@@ -8,7 +8,7 @@ supported packages. All packages chosen have large developer
 bases, and a wide community of users, ensuring long-term support.
 
 The following are support libraries that are
-allowed when developing CTA Pipeline algorithms.  Any new dependencies must
+allowed when developing CTAO Pipeline algorithms.  Any new dependencies must
 be discussed with the software manager.
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -40,7 +40,8 @@ Prototype CTA Pipeline Framework (``ctapipe``)
 
 
 
-``ctapipe`` is a framework for prototyping the low-level data processing algorithms for the Cherenkov Telescope Array.
+``ctapipe`` is a framework for prototyping the low-level data processing
+algorithms for the Cherenkov Telescope Array Observatory (CTAO).
 
 .. _ctapipe_docs:
 

diff --git a/docs/references.bib b/docs/references.bib
@@ -136,3 +136,12 @@ @article{bright-star-catalog
   year={1991},
   url={https://heasarc.gsfc.nasa.gov/W3Browse/star-catalog/bsc5p.html},
 }
+
+@manual{ctao-software-standards,
+  title={Software Programming Standards},
+  number={CTA-STD-OSO-000000-0001},
+  version={2b},
+  year=2024,
+  institution={CTAO},
+  url={https://redmine.cta-observatory.org/dmsf/files/8628/view},
+}
diff --git a/examples/tutorials/ctapipe_handson.py b/examples/tutorials/ctapipe_handson.py
@@ -2,7 +2,7 @@
 Getting Started with ctapipe
 ============================
 
-This hands-on was presented at the Paris CTA Consoritum meeting (K.
+This hands-on was presented at the Paris CTAO Consoritum meeting (K.
 Kosack)
 
 """

diff --git a/examples/tutorials/raw_data_exploration.py b/examples/tutorials/raw_data_exploration.py
@@ -4,7 +4,7 @@
 
 Here are just some very simple examples of going through and inspecting
 the raw data, and making some plots using ``ctapipe``. The data explored
-here are *raw Monte Carlo* data, which is Data Level “R0” in CTA
+here are *raw Monte Carlo* data, which is Data Level “R0” in CTAO
 terminology (e.g. it is before any processing that would happen inside a
 Camera or off-line)
 

diff --git a/src/ctapipe/io/hdf5merger.py b/src/ctapipe/io/hdf5merger.py
@@ -254,7 +254,7 @@ def _read_meta(self, h5file):
             return metadata._read_reference_metadata_hdf5(h5file)
         except Exception:
             raise CannotMerge(
-                f"CTA Reference meta not found in input file: {h5file.filename}"
+                f"CTAO Reference meta not found in input file: {h5file.filename}"
             )
 
     def _check_can_merge(self, other):

diff --git a/src/ctapipe/io/metadata.py b/src/ctapipe/io/metadata.py
@@ -1,5 +1,5 @@
 """
-Management of CTA Reference Metadata.
+Management of CTAO Reference Metadata.
 
 Definitions from :cite:`ctao-top-level-data-model`.
 This information is required to be attached to the header of any files generated.
@@ -260,7 +260,7 @@ def __repr__(self):
 
 def _to_dict(hastraits_instance, prefix=""):
     """helper to convert a HasTraits to a dict with keys
-    in the required CTA format (upper-case, space separated)
+    in the required CTAO format (upper-case, space separated)
     """
     res = {}
 
@@ -280,7 +280,7 @@ def _to_dict(hastraits_instance, prefix=""):
 
 
 class Reference(HasTraits):
-    """All the reference Metadata required for a CTA output file, plus a way to turn
+    """All the reference Metadata required for a CTAO output file, plus a way to turn
     it into a dict() for easy addition to the header of a file"""
 
     contact = Instance(Contact)