381 apitest hygiene

CONTRIBUTING.md

@@ -42,8 +42,7 @@ Please make sure you follow the EasyScience organization-wide
 If you are not planning to contribute code, you may want to:
 
 - 🐞 Report a bug — see [Reporting Issues](#11-reporting-issues)
-- 🛡 Report a security issue — see
-  [Security Issues](#12-security-issues)
+- 🛡 Report a security issue — see [Security Issues](#12-security-issues)
 - 💬 Ask a question or start a discussion at
   [Project Discussions](https://github.com/easyscience/reflectometry-lib/discussions)
 

docs/docs/tutorials/simulation/bilayer.ipynb

@@ -331,7 +331,7 @@
     "q = np.linspace(0.005, 0.3, 500)\n",
     "\n",
     "# Calculate reflectometry\n",
-    "reflectivity = model.interface().reflectity_profile(q, model.unique_name)\n",
+    "reflectivity = model.interface().reflectivity_profile(q, model.unique_name)\n",
     "\n",
     "# Plot\n",
     "plt.figure(figsize=(10, 6))\n",
@@ -391,7 +391,7 @@
    "outputs": [],
    "source": [
     "# First, compute reflectivity with current conformal roughness (3.0 Å)\n",
-    "reflectivity_conformal = model.interface().reflectity_profile(q, model.unique_name)\n",
+    "reflectivity_conformal = model.interface().reflectivity_profile(q, model.unique_name)\n",
     "\n",
     "# Disable conformal roughness to allow independent roughness per layer\n",
     "bilayer.conformal_roughness = False\n",
@@ -406,7 +406,7 @@
     "bilayer.back_head_layer.roughness.value = 4.0\n",
     "\n",
     "# Compute reflectivity with variable roughness\n",
-    "reflectivity_variable_roughness = model.interface().reflectity_profile(q, model.unique_name)\n",
+    "reflectivity_variable_roughness = model.interface().reflectivity_profile(q, model.unique_name)\n",
     "\n",
     "# Plot comparison\n",
     "plt.figure(figsize=(10, 6))\n",
@@ -629,8 +629,8 @@
    "outputs": [],
    "source": [
     "# Calculate reflectivity for both contrasts\n",
-    "reflectivity_d2o = model.interface().reflectity_profile(q, model.unique_name)\n",
-    "reflectivity_h2o = model_h2o.interface().reflectity_profile(q, model_h2o.unique_name)\n",
+    "reflectivity_d2o = model.interface().reflectivity_profile(q, model.unique_name)\n",
+    "reflectivity_h2o = model_h2o.interface().reflectivity_profile(q, model_h2o.unique_name)\n",
     "\n",
     "plt.figure(figsize=(10, 6))\n",
     "plt.semilogy(q, reflectivity_d2o, 'b-', linewidth=2, label='D₂O contrast')\n",

docs/docs/tutorials/simulation/magnetism.ipynb

@@ -252,7 +252,7 @@
     "model.resolution_function = PercentageFwhm(0)\n",
     "model_interface = model.interface()\n",
     "model_interface.magnetism = False\n",
-    "model_data_no_magnetism_ref1d_easy = model.interface().reflectity_profile(\n",
+    "model_data_no_magnetism_ref1d_easy = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -284,7 +284,7 @@
     "model.interface = interface\n",
     "model_interface = model.interface()\n",
     "model_interface.include_magnetism = True\n",
-    "model_data_magnetism = model.interface().reflectity_profile(\n",
+    "model_data_magnetism = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -301,7 +301,7 @@
     "model_interface._wrapper.update_layer(\n",
     "    list(model_interface._wrapper.storage['layer'].keys())[2], magnetism_rhoM=5, magnetism_thetaM=175\n",
     ")\n",
-    "model_data_magnetism_layer_1 = model.interface().reflectity_profile(\n",
+    "model_data_magnetism_layer_1 = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -365,7 +365,7 @@
     "model_interface._wrapper.update_layer(\n",
     "    list(model_interface._wrapper.storage['layer'].keys())[2], magnetism_rhoM=5, magnetism_thetaM=175\n",
     ")\n",
-    "model_data_magnetism_easy = model.interface().reflectity_profile(\n",
+    "model_data_magnetism_easy = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -478,7 +478,7 @@
     "interface.switch('refnx')\n",
     "model.interface = interface\n",
     "model_interface = model.interface()\n",
-    "model_data_no_magnetism_refnx = model.interface().reflectity_profile(\n",
+    "model_data_no_magnetism_refnx = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -488,7 +488,7 @@
     "interface.switch('refl1d')\n",
     "model.interface = interface\n",
     "model_interface = model.interface()\n",
-    "model_data_no_magnetism_ref1d = model.interface().reflectity_profile(\n",
+    "model_data_no_magnetism_ref1d = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -518,7 +518,7 @@
     "model.interface = interface\n",
     "model_interface = model.interface()\n",
     "model_interface.magnetism = True\n",
-    "model_data_magnetism = model.interface().reflectity_profile(\n",
+    "model_data_magnetism = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -529,7 +529,7 @@
     "model.interface = interface\n",
     "model_interface = model.interface()\n",
     "model_interface.magnetism = False\n",
-    "model_data_no_magnetism = model.interface().reflectity_profile(\n",
+    "model_data_no_magnetism = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",

docs/docs/tutorials/simulation/resolution_functions.ipynb

@@ -310,7 +310,7 @@
     "        num=1000,\n",
     "    )\n",
     "    model.resolution_function = resolution_function_dict[key]\n",
-    "    model_data = model.interface().reflectity_profile(\n",
+    "    model_data = model.interface().reflectivity_profile(\n",
     "        model_coords,\n",
     "        model.unique_name,\n",
     "    )\n",
@@ -363,14 +363,14 @@
     ")\n",
     "\n",
     "model.resolution_function = resolution_function_dict[key]\n",
-    "model_data = model.interface().reflectity_profile(\n",
+    "model_data = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
     "plt.plot(model_coords, model_data, 'k-', label='Variable', linewidth=5)\n",
     "\n",
     "model.resolution_function = PercentageFwhm(1.0)\n",
-    "model_data = model.interface().reflectity_profile(\n",
+    "model_data = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -402,7 +402,7 @@
     ")\n",
     "\n",
     "model.resolution_function = resolution_function_dict[key]\n",
-    "model_data = model.interface().reflectity_profile(\n",
+    "model_data = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",
@@ -415,7 +415,7 @@
     "data_points.append(reference_data)  # R\n",
     "data_points.append(reference_variances)  # sQz (variance of Qz)\n",
     "model.resolution_function = Pointwise(q_data_points=data_points)\n",
-    "model_data = model.interface().reflectity_profile(\n",
+    "model_data = model.interface().reflectivity_profile(\n",
     "    model_coords,\n",
     "    model.unique_name,\n",
     ")\n",

docs/mkdocs.yml

@@ -208,7 +208,8 @@ nav:
       - Elements:
           - Layers:
               - Layer: api-reference/elements/layer.md
-              - Layer Area Per Molecule: api-reference/elements/layer_area_per_molecule.md
+              - Layer Area Per Molecule:
+                  api-reference/elements/layer_area_per_molecule.md
           - Materials:
               - Material: api-reference/elements/material.md
               - Material Density: api-reference/elements/material_density.md