Renames package to lower case and fixes some build issues (#168)

Author: StephenNneji

.github/workflows/release.yml

@@ -15,6 +15,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - name: Build sdist
         run: |
           pip install pybind11

.github/workflows/run_tests.yml

@@ -54,4 +54,4 @@ jobs:
         run: |
           export PATH="$pythonLocation:$PATH"
           python -m pip install -e .[Dev,Orso]
-          pytest tests/ --cov=RATapi --cov-report=term
+          pytest tests/ --cov=ratapi --cov-report=term

RATapi/__init__.py

@@ -0,0 +1,29 @@
+"""ratapi is a Python package for modelling, fitting and optimising reflectivity problems."""
+
+from contextlib import suppress
+
+import ratapi.examples as examples
+from ratapi import events, models
+from ratapi.classlist import ClassList
+from ratapi.controls import Controls
+from ratapi.outputs import BayesResults, Results
+from ratapi.project import Project
+from ratapi.run import run
+from ratapi.utils import convert, plotting
+
+with suppress(ImportError):  # orsopy is an optional dependency
+    from ratapi.utils import orso as orso
+
+__all__ = [
+    "examples",
+    "models",
+    "events",
+    "ClassList",
+    "Controls",
+    "BayesResults",
+    "Results",
+    "Project",
+    "run",
+    "plotting",
+    "convert",
+]

RATapi/examples/__init__.py

@@ -17,8 +17,8 @@
     model_validator,
 )
 
-from RATapi.utils.custom_errors import custom_pydantic_validation_error
-from RATapi.utils.enums import BoundHandling, Display, Parallel, Procedures, Strategies
+from ratapi.utils.custom_errors import custom_pydantic_validation_error
+from ratapi.utils.enums import BoundHandling, Display, Parallel, Procedures, Strategies
 
 common_fields = ["procedure", "parallel", "calcSldDuringFit", "resampleMinAngle", "resampleNPoints", "display"]
 update_fields = ["updateFreq", "updatePlotFreq"]

RATapi/utils/__init__.py

@@ -3,7 +3,7 @@
 import os
 from typing import Callable, Union
 
-from RATapi.rat_core import EventBridge, EventTypes, PlotEventData, ProgressEventData
+from ratapi.rat_core import EventBridge, EventTypes, PlotEventData, ProgressEventData
 
 
 def notify(event_type: EventTypes, data: Union[str, PlotEventData, ProgressEventData]) -> None:

ratapi/__init__.py

@@ -0,0 +1,25 @@
+"""Usage examples for the Python RAT API."""
+
+from ratapi.examples.absorption.absorption import absorption
+from ratapi.examples.convert_rascal_project.convert_rascal import convert_rascal
+from ratapi.examples.domains.domains_custom_layers import domains_custom_layers
+from ratapi.examples.domains.domains_custom_XY import domains_custom_XY
+from ratapi.examples.domains.domains_standard_layers import domains_standard_layers
+from ratapi.examples.normal_reflectivity.DSPC_custom_layers import DSPC_custom_layers
+from ratapi.examples.normal_reflectivity.DSPC_custom_XY import DSPC_custom_XY
+from ratapi.examples.normal_reflectivity.DSPC_data_background import DSPC_data_background
+from ratapi.examples.normal_reflectivity.DSPC_function_background import DSPC_function_background
+from ratapi.examples.normal_reflectivity.DSPC_standard_layers import DSPC_standard_layers
+
+__all__ = [
+    "absorption",
+    "domains_custom_layers",
+    "domains_custom_XY",
+    "domains_standard_layers",
+    "DSPC_custom_layers",
+    "DSPC_custom_XY",
+    "DSPC_standard_layers",
+    "DSPC_data_background",
+    "DSPC_function_background",
+    "convert_rascal",
+]