causalchamber 0.0.1__tar.gz

causalchamber-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Juan L Gamella
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

causalchamber-0.0.1/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.1
+Name: causalchamber
+Version: 0.0.1
+Summary: Access the datasets and models from the causal chambers.
+Author-email: Juan L Gamella <juangamella@gmail.com>
+Project-URL: Homepage, https://causalchamber.org
+Project-URL: Repository, https://github.com/juangamella/causal-chamber
+Project-URL: Issues, https://github.com/juangamella/causal-chamber/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# `causalchamber` package
+
+TODO.

causalchamber-0.0.1/README.md

@@ -0,0 +1,139 @@
+# The Causal Chambers: Dataset Repository
+
+![The Causal Chambers: (left) the wind tunnel, and (right) the light tunnel with the front panel removed to show its interior.](the_chambers.jpg)
+
+This repository contains datasets collected from the _causal chambers_, the two devices described in the 2024 paper [*The Causal Chambers: Real Physical Systems as a Testbed for AI Methodology*](<https://placehold.co/600x400?text=Placeholder:\nArxiv link!>) by Juan L. Gamella, Jonas Peters and Peter Bühlmann. The repository is updated as we collect new datasets from the chambers.
+
+The datasets are publicly available through a permissive [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/). This means you are free to use, share and modify the datasets as long as you give appropriate credit and communicate changes. If you use the datasets in your scientific work, please consider citing:
+
+```
+@article{gamella2024chamber,
+  title={The Causal Chambers: Real Physical Systems as a Testbed for AI Methodology},
+  author={Gamella, Juan L. and B\"uhlmann, Peter and Peters, Jonas},
+  journal={arXiv preprint arXiv:TODO},
+  year={2024}
+}
+```
+
+This repository also contains the source code for the `causalchamber` [package](<https://placehold.co/600x400?text=Placeholder:\nPyPi link!>) to directly [import the datasets into your Python code](#downloading-the-datasets). The package also provides Python implementations of the [mechanistic models](#mechanistic-models) described in appendix [XX] of the original [paper](<https://placehold.co/600x400?text=Placeholder:\nArxiv link!>).
+
+Here you can also find the resources to [build the chambers](#building-the-chambers), and the datasheets for all chamber components (see [`hardware/`](hardware/)).
+
+The code to reproduce the case studies in the original paper can be found in the separate [paper repository](https://github.com/juangamella/causal-chamber-paper).
+
+## Available datasets
+
+<!-- ![Examples of data collected from the chambers. See Fig. TODO of the manuscript for more details.](chamber_data.png) -->
+
+Each dataset is described in detail in its corresponding page (click the dataset name). The chamber configurations are described in Fig. 3 of the manuscript.
+
+| Dataset name | Notes | Chamber | Config. |
+|--------:|:--------------------------------|:--------:|:--------:|
+| [lt_camera_walks_v1](datasets/lt_camera_walks_v1/) | Image data for the ICA case study (task d3, Fig. 6). | Light tunnel | camera |
+| [lt_color_regression_v1](datasets/lt_color_regression_v1/) | Image data for task b2 in the OOD case study (Fig. 5) | Light tunnel | camera |
+| [lt_interventions_standard_v1](datasets/lt_interventions_standard_v1/) | Observational and interventional data from the light tunnel, used for the causal discovery case study in Fig. 5. | Light tunnel | standard |
+| [lt_walks_v1](datasets/lt_walks_v1/) | Random and deterministic walks of the light-tunnel actuators. Used in the ICA case study (task d1), Fig. 6. | Light tunnel | standard |
+| [wt_walks_v1](datasets/wt_walks_v1/) | Random and deterministic walks of the wind-tunnel actuators. Used in the causal discovery (task a3) and ICA (task d2) case studies. | Wind tunnel | standard |
+| [lt_malus_v1](datasets/lt_malus_v1/) | Measurements of light intensity displaying Malus' law, used in the symbolic regression task in Fig. XX. | Light tunnel | standard |
+| [wt_bernoulli_v1](datasets/wt_bernoulli_v1/) | Measurements of air pressure displaying Bernoulli's principle, used in the symbolic regression task in Fig. XX. | Wind tunnel | standard |
+| [wt_changepoints_v1](datasets/wt_changepoints_v1/) | Used for the change point detection case study in Fig. 5. | Wind tunnel | standard |
+| [wt_intake_impulse_v1](datasets/wt_intake_impulse_v1/) | Barometric pressure curves used in task 2c, Fig. 5. | Wind tunnel | standard |
+| [wt_pressure_control_v1](datasets/wt_pressure_control_v1/) | Data from the pressure-control configuration of the wind tunnel. | Wind tunnel | pressure-control |
+| [lt_test_v1](datasets/lt_test_v1/) | Experiments to characterize some of the physical effects of the light tunnel. Shown in figures XX-XX of the manuscript. | Light tunnel | standard |
+| [wt_test_v1](datasets/wt_test_v1/) | Experiments to characterize some of the physical effects of the wind tunnel. Shown in figures XX-XX of the manuscript. | Wind tunnel | standard |
+| [lt_camera_test_v1](datasets/lt_camera_test_v1/) | Experiments to characterize some of the physical effects of the camera system in the light tunnel. | Light tunnel | camera |
+| [wt_validate_v1](datasets/wt_validate_v1/) | Randomized control experiments to validate the causal ground-truth graph of the wind tunnel in its _standard_ configuration (appendix XX of the manuscript). | Wind tunnel | standard |
+| [wt_pc_validate_v1](datasets/wt_validate_v1/) | Randomized control experiments to validate the causal ground-truth graph of the wind tunnel in its _pressure-control_ configuration (appendix XX of the manuscript). | Wind tunnel | pressure-control |
+| [lt_validate_v1](datasets/lt_validate_v1/) | Randomized control experiments to validate the causal ground-truth graphs of the light tunnel in its _standard_ configuration (appendix XX of the manuscript). | Light tunnel | standard |
+| [lt_camera_validate_v1](datasets/lt_validate_v1/) | Randomized control experiments to validate the causal ground-truth graphs of the light tunnel in its _camera_ configuration (appendix XX of the manuscript). | Light tunnel | standard |
+
+## Downloading the datasets
+
+For each dataset, you can simply download a `.zip` file with all the data, including the images at different resolutions. The link and checksum (to verify integrity) are available on the page of each dataset (click on the dataset name in the table above).
+
+If you use Python, you can directly import a dataset into your code through the `causalchamber` [package](<https://placehold.co/600x400?text=Placeholder:\nPyPi link!>). You can install it using pip, e.g. by typing
+
+```
+pip install causalchamber
+```
+
+in an appropriate shell. Datasets can then be accessed directly from your Python code. For example, you can access the image data from task d3 of the ICA case study ([Fig. 6](<https://placehold.co/600x400?text=Placeholder:\nArxiv link!>)) as follows:
+
+```python
+from causalchamber.datasets import Dataset
+
+# Download the dataset and store in e.g. /tmp
+dataset = Dataset(name='lt_camera_walks_v1',
+                  root='/tmp')
+
+# Load the observations and images (at 50x50 pixels)
+experiment = dataset.get_experiment(name='actuator_mix')
+
+observations = experiment.as_pandas_dataframe()
+images = experiment.as_image_array(size='50')
+```
+
+For the available experiment names, see the page for each dataset (click on the dataset name in the table above) or run
+```python
+dataset.available_experiments()
+
+# Output:
+# ['actuator_mix',
+#  'color_mix']
+```
+
+To force-download a fresh copy of a dataset, can call `Dataset(...)` above with the flag `force_download=True`. Update the `causalchamber` [package](<https://placehold.co/600x400?text=Placeholder:\nPyPi link!>) for access to the latest datasets.
+
+
+## Mechanistic models
+
+The `causalchamber` [package](<https://placehold.co/600x400?text=Placeholder:\nPyPi link!>) also contains Python implementations of the mechanistic models described in appendix [XX] of the original [paper](<https://placehold.co/600x400?text=Placeholder:\nArxiv link!>). The models follow the same nomenclature as in the paper, e.g., to import and run model A1 of the steady-state fan speed:
+```Python
+from causalchamber.models import model_a1
+model_a1(L=np.linspace(0,1,10), L_min=0.1, omega_max=314.15)
+
+# Output:
+
+# array([ 31.415     ,  34.90555556,  69.81111111, 104.71666667,
+#        139.62222222, 174.52777778, 209.43333333, 244.33888889,
+#        279.24444444, 314.15      ])
+```
+
+The implementations can be found in the [`src/causalchamber/models`](src/causalchamber/models) directory. You can find examples of using the models in the (case_studies/mechanistic_models.ipynb)[XX] notebook in the separate [paper repository](https://github.com/juangamella/causal-chamber-paper).
+
+## Causal ground-truth graphs
+
+The graphs for the causal ground truths given in Fig. 3 of the original [paper](<https://placehold.co/600x400?text=Placeholder:\nArxiv link!>) can be found as adjacency matrices in  the `ground_truths/` directory. The adjacencies can also be loaded through the `causalchamber` [package](<https://placehold.co/600x400?text=Placeholder:\nPyPi link!>), e.g., 
+```python
+from causalchamber.ground_truth import graph
+graph(chamber="lt", configuration="standard")
+
+# Output:
+
+#              red  green  blue  osr_c  v_c  current  pol_1  pol_2  osr_angle_1  \
+# red            0      0     0      0    0        1      0      0            0   
+# green          0      0     0      0    0        1      0      0            0   
+# blue           0      0     0      0    0        1      0      0            0   
+# osr_c          0      0     0      0    0        1      0      0            0   
+```
+
+To make it easier to plot graphs and reference them back to the original paper, the latex representation of each variable can be obtained by calling the `latex_name` function. For example, to obtain the latex representation $\theta_1$ of the `pol_1` variable, you can run
+```python
+from causalchamber.ground_truth import latex_name
+latex_name('pol_1', enclose=True)
+
+# Output:
+
+# '$\\theta_1$'
+```
+
+## Building the chambers
+
+You can find the resources to build the chambers in [`hardware/`](hardware/), together with the datasheets for all physical components (see appendix [XX]) of the original [paper](<https://placehold.co/600x400?text=Placeholder:\nArxiv link!>).
+
+## Licenses
+
+All images and `.csv` files in the datasets are licensed under a [CC BY 4.0 license](https://creativecommons.org/licenses/by/4.0/). A copy of the license can be found in [LICENSE_DATASETS.txt](LICENSE_DATASETS.txt).
+
+The code, e.g., for the `causalchamber` package and mechanistic models, is shared under the [MIT license](https://opensource.org/license/mit/). A copy of the license can also be found in [LICENSE_SOFTWARE.txt](LICENSE_SOFTWARE.txt).
+

causalchamber-0.0.1/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "causalchamber"
+version = "0.0.1"
+authors = [
+  { name="Juan L Gamella", email="juangamella@gmail.com" },
+]
+description = "Access the datasets and models from the causal chambers."
+readme = "src/README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "numpy>=1.17.0",
+    "pandas>=1.2.1"
+]
+
+[project.urls]
+Homepage = "https://causalchamber.org"
+Repository = "https://github.com/juangamella/causal-chamber"
+Issues = "https://github.com/juangamella/causal-chamber/issues"

causalchamber-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

causalchamber-0.0.1/src/README.md

@@ -0,0 +1,3 @@
+# `causalchamber` package
+
+TODO.

causalchamber-0.0.1/src/causalchamber/datasets/__init__.py

@@ -0,0 +1 @@
+from .main import *

causalchamber-0.0.1/src/causalchamber/datasets/main.py

@@ -0,0 +1,345 @@
+# MIT License
+
+# Copyright (c) 2023 Juan L. Gamella
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+import causalchamber.datasets.utils as utils
+from pathlib import Path
+import pandas as pd
+import yaml
+from PIL import Image
+import numpy as np
+import os
+
+
+# Maybe have this as a downloadable YAML file
+directory_path = Path(Path(__file__).parents[0], "directory.yaml")
+with open(directory_path, "r") as f:
+    directory = yaml.load(f, Loader=yaml.Loader)
+    f.close()
+
+# --------------------------------------------------------------------
+# Base Dataset and Experiment classes
+
+citation = """
+@article{gamella2024chamber,
+  title={The Causal Chambers: Real Physical Systems as a Testbed for AI Methodology},
+  author={Gamella, Juan L. and B\"uhlmann, Peter and Peters, Jonas},
+  journal={(work in progress)},
+  year={2023}
+}
+"""
+
+print(f"If you use our datasets for your work please consider citing:\n{citation}")
+
+
+class Dataset:
+    def __init__(self, name, root, download=True):
+        available_datasets = directory["datasets"].keys()
+        if name not in available_datasets:
+            string = ""
+            for d in available_datasets:
+                string += '  "' + d + '"\n'
+            raise ValueError(
+                f'Dataset "{name}" is not available. Available datasets:\n{string}'
+            )
+        # Store attributes
+        self.name = name
+        self.root = root
+        self.image = directory["datasets"][name]["image"]
+        # Check if dataset has already been downloaded to root
+        dataset_dir = Path(self.root, self.name)
+        if os.path.isdir(dataset_dir):
+            print(f'Dataset {self.name} found in "{dataset_dir}".')
+        else:
+            if download:
+                # Download, verify and extract
+                self.url = directory["datasets"][name]["url"]
+                self.checksum = directory["datasets"][name]["md5"]
+                utils.download_and_extract(self.url, self.root, self.checksum)
+            else:
+                raise FileNotFoundError(
+                    f'Could not find dataset directory "{dataset_dir}". Set download=True or choose another root directory (root).'
+                )
+        # Load available experiments
+        #   If not an image dataset, experiments are just .csv files in the dataset directory
+        #   If an image dataset, each experiment is a folder
+        #   containing the .csv file with measurements and a subfolder
+        #   with the images
+
+        if self.image:
+            experiment_names = [p.name for p in Path(self.root).glob(f"{self.name}/*")]
+            csv_paths = [
+                Path(self.root, self.name, e, f"{e}.csv") for e in experiment_names
+            ]
+            experiments = [ImageExperiment(self.name, path) for path in csv_paths]
+        else:
+            csv_paths = [p for p in Path(self.root).glob(f"{self.name}/*.csv")]
+            experiments = [Experiment(self.name, path) for path in csv_paths]
+        # Store experiment dictionary
+        assert len(experiments) > 0
+        self.__experiments = dict((e.name, e) for e in experiments)
+
+    def available_experiments(self):
+        return list(self.__experiments.keys())
+
+    def get_experiment(self, name):
+        return self.__experiments[name]
+
+
+class Experiment:
+    def __init__(self, dataset_name, csv_path):
+        self.dataset = dataset_name
+        self.csv_path = csv_path
+        self.name = csv_path.stem
+        self.columns = pd.read_csv(self.csv_path, nrows=0).columns.tolist()
+
+    def as_pandas_dataframe(self):
+        """Returns a pandas dataframe with the experiment data (excl. images)"""
+        return pd.read_csv(self.csv_path)
+
+    def as_image_array(self):
+        raise NotImplementedError("This is not an image dataset!")
+
+
+class ImageExperiment(Experiment):
+    def __init__(self, dataset_name, csv_path):
+        super().__init__(dataset_name, csv_path)
+        self.image_folders = {}
+        for path in [p for p in Path(csv_path.parents[0]).glob("images_*")]:
+            size = path.stem.split("_")[1]
+            self.image_folders[size] = path
+
+    def available_sizes(self):
+        return list(self.image_folders.keys())
+
+    def as_image_array(self, size):
+        """Returns a numpy array with all the images along the first dimension (axis-0)"""
+        if size not in self.image_folders.keys():
+            raise ValueError(
+                f" Size {size} not available; available image sizes: {list(self.image_folders.keys())}."
+            )
+        image_filenames = pd.read_csv(self.csv_path).image_file
+        image_folder = self.image_folders[size]
+        image_paths = [Path(image_folder, f) for f in image_filenames]
+        return np.array([np.array(Image.open(f)) for f in image_paths])
+
+
+latex_names = {
+    # Light tunnel variables
+    "red": r"R",
+    "green": r"G",
+    "blue": r"B",
+    "osr_c": r"O_C",
+    "v_c": r"R_C",
+    "current": r"\tilde{C}",
+    "pol_1": r"\theta_1",
+    "pol_2": r"\theta_2",
+    "osr_angle_1": r"O_1",
+    "osr_angle_2": r"O_2",
+    "v_angle_1": r"R_1",
+    "v_angle_2": r"R_2",
+    "angle_1": r"\tilde{\theta}_1",
+    "angle_2": r"\tilde{\theta}_2",
+    "ir_1": r"\tilde{I}_1",
+    "vis_1": r"\tilde{V}_1",
+    "ir_2": r"\tilde{I}_2",
+    "vis_2": r"\tilde{V}_2",
+    "ir_3": r"\tilde{I}_3",
+    "vis_3": r"\tilde{V}_3",
+    "l_11": r"L_{11}",
+    "l_12": r"L_{12}",
+    "l_21": r"L_{21}",
+    "l_22": r"L_{22}",
+    "l_31": r"L_{31}",
+    "l_32": r"L_{32}",
+    "diode_ir_1": r"D^I_1",
+    "diode_vis_1": r"D^V_1",
+    "diode_ir_2": r"D^I_2",
+    "diode_vis_2": r"D^V_2",
+    "diode_ir_3": r"D^I_3",
+    "diode_vis_3": r"D^V_3",
+    "t_ir_1": r"T^I_1",
+    "t_vis_1": r"T^V_1",
+    "t_ir_2": r"T^I_2",
+    "t_vis_2": r"T^V_2",
+    "t_ir_3": r"T^I_3",
+    "t_vis_3": r"T^V_3",
+    "im": r"\tilde{\text{I}}\text{m}",
+    "shutter_speed": r"T_\text{Im}",
+    "aperture": r"\text{Ap}",
+    "iso": r"\text{ISO}",
+    # Wind tunnel variables
+    "hatch": r"H",
+    "pot_1": r"A_1",
+    "pot_2": r"A_2",
+    "osr_1": r"O_1",
+    "osr_2": r"O_2",
+    "osr_mic": r"O_M",
+    "osr_in": r"O_\text{in}",
+    "osr_out": r"O_\text{out}",
+    "osr_upwind": r"O_\text{up}",
+    "osr_downwind": r"O_\text{dw}",
+    "osr_ambient": r"O_\text{amb}",
+    "osr_intake": r"O_\text{int}",
+    "v_1": r"R_1",
+    "v_2": r"R_2",
+    "v_mic": r"R_M",
+    "v_in": r"R_\text{in}",
+    "v_out": r"R_\text{out}",
+    "load_in": r"L_\text{in}",
+    "load_out": r"L_\text{out}",
+    "current_in": r"\tilde{C}_\text{in}",
+    "current_out": r"\tilde{C}_\text{out}",
+    "res_in": r"T_\text{in}",
+    "res_out": r"T_\text{out}",
+    "rpm_in": r"\tilde{\omega}_\text{in}",
+    "rpm_out": r"\tilde{\omega}_\text{out}",
+    "pressure_upwind": r"\tilde{P}_\text{up}",
+    "pressure_downwind": r"\tilde{P}_\text{dw}",
+    "pressure_ambient": r"\tilde{P}_\text{amb}",
+    "pressure_intake": r"\tilde{P}_\text{int}",
+    "mic": r"\tilde{M}",
+    "signal_1": r"\tilde{S}_1",
+    "signal_2": r"\tilde{S}_2",
+}
+
+
+def latex_name(var, enclose=True):
+    """Translate from machine variable name to latex name."""
+    if var not in latex_names:
+        return var
+    else:
+        name = latex_names[var]
+        return "$" + name + "$" if enclose else name
+
+
+lt_standard_edges = [
+    ("red", "ir_1"),
+    ("green", "ir_1"),
+    ("blue", "ir_1"),
+    ("red", "ir_2"),
+    ("green", "ir_2"),
+    ("blue", "ir_2"),
+    ("red", "ir_3"),
+    ("green", "ir_3"),
+    ("blue", "ir_3"),
+    ("red", "vis_1"),
+    ("green", "vis_1"),
+    ("blue", "vis_1"),
+    ("red", "vis_2"),
+    ("green", "vis_2"),
+    ("blue", "vis_2"),
+    ("red", "vis_3"),
+    ("green", "vis_3"),
+    ("blue", "vis_3"),
+    ("red", "current"),
+    ("green", "current"),
+    ("blue", "current"),
+    ("pol_1", "ir_3"),
+    ("pol_2", "ir_3"),
+    ("pol_1", "vis_3"),
+    ("pol_2", "vis_3"),
+    ("pol_1", "angle_1"),
+    ("pol_2", "angle_2"),
+    ("v_angle_1", "angle_1"),
+    ("osr_angle_1", "angle_1"),
+    ("v_angle_2", "angle_2"),
+    ("osr_angle_2", "angle_2"),
+    ("v_c", "current"),
+    ("osr_c", "current"),
+    ("l_11", "ir_1"),
+    ("l_12", "ir_1"),
+    ("l_11", "vis_1"),
+    ("l_12", "vis_1"),
+    ("t_ir_1", "ir_1"),
+    ("diode_ir_1", "ir_1"),
+    ("t_vis_1", "vis_1"),
+    ("diode_vis_1", "vis_1"),
+    ("l_21", "ir_2"),
+    ("l_22", "ir_2"),
+    ("l_21", "vis_2"),
+    ("l_22", "vis_2"),
+    ("t_ir_2", "ir_2"),
+    ("diode_ir_2", "ir_2"),
+    ("t_vis_2", "vis_2"),
+    ("diode_vis_2", "vis_2"),
+    ("l_31", "ir_3"),
+    ("l_32", "ir_3"),
+    ("l_31", "vis_3"),
+    ("l_32", "vis_3"),
+    ("t_ir_3", "ir_3"),
+    ("diode_ir_3", "ir_3"),
+    ("t_vis_3", "vis_3"),
+    ("diode_vis_3", "vis_3"),
+    ("pol_1", "im"),
+    ("pol_2", "im"),
+    ("red", "im"),
+    ("green", "im"),
+    ("blue", "im"),
+    ("shutter_speed", "im"),
+    ("aperture", "im"),
+    ("iso", "im"),
+]
+
+wt_standard_edges = [
+    ("load_in", "rpm_in"),
+    ("res_in", "rpm_in"),
+    ("load_in", "rpm_out"),
+    ("load_in", "current_in"),
+    ("load_in", "current_out"),
+    ("load_out", "rpm_in"),
+    ("load_out", "rpm_out"),
+    ("res_out", "rpm_out"),
+    ("load_out", "current_out"),
+    ("load_out", "current_in"),
+    ("hatch", "rpm_in"),
+    ("hatch", "rpm_out"),
+    ("load_in", "pressure_intake"),
+    ("hatch", "pressure_intake"),
+    ("load_out", "pressure_intake"),
+    ("osr_intake", "pressure_intake"),
+    ("load_in", "pressure_upwind"),
+    ("hatch", "pressure_upwind"),
+    ("load_out", "pressure_upwind"),
+    ("osr_up", "pressure_upwind"),
+    ("load_in", "pressure_downwind"),
+    ("hatch", "pressure_downwind"),
+    ("load_out", "pressure_downwind"),
+    ("osr_downwind", "pressure_downwind"),
+    ("osr_ambient", "pressure_ambient"),
+    ("osr_in", "current_in"),
+    ("v_in", "current_in"),
+    ("osr_out", "current_out"),
+    ("v_out", "current_out"),
+    ("pot_1", "signal_1"),
+    ("osr_1", "signal_1"),
+    ("v_1", "signal_1"),
+    ("pot_1", "signal_2"),
+    ("pot_2", "signal_2"),
+    ("osr_2", "signal_2"),
+    ("v_2", "signal_2"),
+    ("pot_1", "mic"),
+    ("load_in", "mic"),
+    ("load_out", "mic"),
+    ("hatch", "mic"),
+    ("osr_mic", "mic"),
+    ("v_mic", "mic"),
+]

causalchamber-0.0.1/src/causalchamber/datasets/sampling.py

@@ -0,0 +1,76 @@
+# MIT License
+
+# Copyright (c) 2023 Juan L. Gamella
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Functions for general sampling.
+"""
+
+import numpy as np
+
+
+def random_walk(n, step_size=1, step_resolution=1, random_state=None):
+    rng = np.random.default_rng(random_state)
+    possible_transitions = np.arange(
+        -step_size, step_size + step_resolution, step_resolution
+    )
+    steps = rng.choice(possible_transitions, size=n, replace=True)
+    return np.cumsum(steps)
+
+
+def random_walk_mirrored(
+    n, minn, maxx, step_size=1, step_resolution=1, random_state=None
+):
+    rng = np.random.default_rng(random_state - 1)
+    init = rng.choice(np.arange(minn, maxx + step_resolution, step_resolution))
+    walk = init + random_walk(
+        n,
+        step_size=step_size,
+        step_resolution=step_resolution,
+        random_state=random_state,
+    )
+    # As long as walk is out of bounds
+    while (
+        maxx is not None
+        and (walk > maxx).any()
+        or minn is not None
+        and (walk < minn).any()
+    ):
+        walk = np.minimum(walk, maxx) - np.maximum(walk, maxx) + maxx
+        walk = np.maximum(walk, minn) - np.minimum(walk, minn) + minn
+    return walk
+
+
+# Deprecatedx
+def discrete_rw(n, minn, maxx, step_sizes=[-1, 0, 1], p=None, seed=42):
+    rng = np.random.default_rng(seed)
+    walk = np.zeros(n)
+    walk[0] = rng.integers(minn, maxx + 1)
+    steps = rng.choice(step_sizes, p=p, size=n - 1, replace=True)
+    for i, s in enumerate(steps):
+        walk[i + 1] = min(max(walk[i] + s, minn), maxx)
+    return walk
+
+
+def smooth_discrete_rw(n, minn, maxx, step_sizes=[-1, 0, 1], p=None, lags=0, seed=42):
+    walk = discrete_rw(n + lags, minn, maxx, step_sizes, p, seed)
+    walk = pd.DataFrame(walk).rolling(lags).mean()[lags:]
+    return walk.values