Merge pull request #30 from AEONplus/25-add-soar-facility-to-aeonlib

25 add soar facility to aeonlib

Author: Fingel

README.md

@@ -109,19 +109,14 @@ curl https://observe.lco.global/api/instruments/ | codegen/lco/generator.py > sr
 
 This list is a work in progress.
 
-## OCS (Las Cumbres Observatory)
-
-Full documentation: TODO
-
+## Las Cumbres Observatory (LCO)
 
 ### Dependency group
-The OCS requires no additional dependency groups to be installed.
+Las Cumbres Observatory requires no additional dependency groups to be installed.
 
 ### Configuration Values
 See [configuration](#configuration) for instructions on setting these values.
 
-For LCO:
-
 ```python
 lco_token: str = ""
 lco_api_root: str = "https://observe.lco.global/api/"
@@ -132,6 +127,22 @@ lco_api_root: str = "https://observe.lco.global/api/"
 * [LCO Developer Documentation](https://developers.lco.global/)
 * [OCS API Documentation](https://observatorycontrolsystem.github.io/api/observation_portal/)
 
+## SOAR
+
+SOAR is functionally the same as LCO, but has its own set of instruments and can be configured seperately.
+
+### Dependency group
+SOAR requires no additional dependency groups to be installed.
+
+### Configuration Values
+See [configuration](#configuration) for instructions on setting these values.
+
+```python
+soar_token: str = ""
+soar_api_root: str = "https://observe.lco.global/api/"
+```
+Note: the soar API token will default to the same value as lco_token, if it is set.
+
 ## ESO (European Southern Observatory)
 
 Full documentation: TODO

codegen/lco/generator.py

@@ -15,14 +15,15 @@ def get_modes(ins: dict, type: str) -> list[str]:
         return []
 
 
-def generate_instrument_configs(ins_s: str) -> str:
+def generate_instrument_configs(ins_s: str, soar: bool = False) -> str:
     """
     Generate instrument models based on the output of the OCS
     instrument data endpoint. For LCO, this endpoint resides
     at https://observe.lco.global/api/instruments/
 
     Args:
         ins_s (str): The input json containing instrument data.
+        soar (bool): Whether to generate SOAR instruments.
 
     Returns:
         str: Generated Python Pydantic models as a string.
@@ -36,13 +37,20 @@ def generate_instrument_configs(ins_s: str) -> str:
     template = j_env.get_template("instruments.jinja")
     ins_data = json.loads(ins_s)
     instruments = []
+    if soar:
+        prefix = ""
+        filtered = {k: v for k, v in ins_data.items() if "soar" in k.lower()}
+    else:
+        prefix = "Lco"
+        filtered = {k: v for k, v in ins_data.items() if "soar" not in k.lower()}
+
     # Instruments endpoint seems inconsistent, this should keep our output consistent
-    ordered = dict(sorted(ins_data.items()))
+    ordered = dict(sorted(filtered.items()))
     for instrument_type, ins in ordered.items():
         instruments.append(
             {
                 "instrument_type": instrument_type,
-                "class_name": f"Lco{textcase.pascal(instrument_type)}",
+                "class_name": f"{prefix}{textcase.pascal(instrument_type)}",
                 "config_types": [
                     c["code"] for c in ins["configuration_types"].values()
                 ],
@@ -58,11 +66,15 @@ def generate_instrument_configs(ins_s: str) -> str:
             }
         )
 
-    return template.render(instruments=instruments)
+    return template.render(instruments=instruments, soar=soar)
 
 
 if __name__ == "__main__":
+    try:
+        soar = sys.argv.pop(1) == "soar"
+    except IndexError:
+        soar = False
     # Accepts input from stdin or a file argument
     with fileinput.input() as f:
         ins_json = "".join(list(f))
-        sys.stdout.write(generate_instrument_configs(ins_json))
+        sys.stdout.write(generate_instrument_configs(ins_json, soar=soar))

codegen/lco/templates/instruments.jinja

@@ -8,6 +8,11 @@ from aeonlib.models import SiderealTarget, NonSiderealTarget
 from aeonlib.ocs.target_models import Constraints
 from aeonlib.ocs.config_models import Roi
 
+{% if soar %}
+    {% set obs = "SOAR" %}
+{% else %}
+    {% set obs = "LCO" %}
+{% endif %}
 
 {% for ctx in instruments %}
 class {{ ctx.class_name }}OpticalElements(BaseModel):
@@ -70,7 +75,7 @@ class {{ ctx.class_name }}(BaseModel):
 
 {% endfor %}
 # Export a type that encompasses all instruments
-LCO_INSTRUMENTS = Union[
+{{ obs }}_INSTRUMENTS = Union[
 {% for ctx in instruments %}
     {{ ctx.class_name }},
 {% endfor %}

src/aeonlib/conf.py

@@ -8,6 +8,10 @@ class Settings(BaseSettings):
     lco_token: str = ""
     lco_api_root: str = "https://observe.lco.global/api/"
 
+    # SOAR
+    soar_token: str = ""
+    soar_api_root: str = "https://observe.lco.global/api/"
+
     # European Southern Observatory
     eso_environment: str = "demo"
     eso_username: str = ""

src/aeonlib/ocs/lco/facility.py

@@ -65,10 +65,10 @@ def validate_request_group(
         response = self.client.post("/requestgroups/validate/", json=payload)
         response = response.json()
         logger.debug("<- %s", response)
-        if response["request_durations"]:
+        if response.get("request_durations"):
             return True, []
         else:
-            return False, response["errors"]
+            return False, response.get("errors", [str(response)])
 
     def submit_request_group(
         self, request_group: RequestGroup