edit the docs

README.md

@@ -18,34 +18,216 @@ StingrayExplorer is a data analysis tool designed for quick visualization and ex
 
 ```
 .
+├── CODE_OF_CONDUCT.md
+├── Dockerfile
+├── LICENSE
+├── README.md
 ├── assets
-│   ├── audio
-│   ├── icons
-│   │   └── svg.py
-│   ├── images
-│   ├── stylesheets
-│   │   └── explorer.css
-│   └── videos
+│   ├── audio
+│   ├── icons
+│   │   ├── __pycache__
+│   │   │   └── svg.cpython-311.pyc
+│   │   └── svg.py
+│   ├── images
+│   │   ├── holoviz_logo.png
+│   │   ├── holoviz_logo_minimised.png
+│   │   ├── stingray_explorer.png
+│   │   ├── stingray_explorer.webp
+│   │   ├── stingray_explorer_minimised.png
+│   │   ├── stingray_logo.png
+│   │   └── stingray_logo_minimised.png
+│   ├── stylesheets
+│   │   └── explorer.css
+│   └── videos
+├── docs
+│   ├── Makefile
+│   ├── build
+│   │   ├── doctrees
+│   │   │   ├── DataLoading.doctree
+│   │   │   ├── Home.doctree
+│   │   │   ├── QuickLook.doctree
+│   │   │   ├── environment.pickle
+│   │   │   ├── index.doctree
+│   │   │   └── modules.doctree
+│   │   └── html
+│   │       ├── DataLoading.html
+│   │       ├── Home.html
+│   │       ├── QuickLook.html
+│   │       ├── _modules
+│   │       │   ├── index.html
+│   │       │   └── modules
+│   │       │       ├── DataLoading
+│   │       │       │   └── DataIngestion.html
+│   │       │       ├── Home
+│   │       │       │   └── HomeContent.html
+│   │       │       └── QuickLook
+│   │       │           ├── AverageCrossSpectrum.html
+│   │       │           ├── AveragePowerSpectrum.html
+│   │       │           ├── Bispectrum.html
+│   │       │           ├── CrossSpectrum.html
+│   │       │           ├── LightCurve.html
+│   │       │           ├── PowerColors.html
+│   │       │           └── PowerSpectrum.html
+│   │       ├── _sources
+│   │       │   ├── DataLoading.rst.txt
+│   │       │   ├── Home.rst.txt
+│   │       │   ├── QuickLook.rst.txt
+│   │       │   ├── index.rst.txt
+│   │       │   └── modules.rst.txt
+│   │       ├── _static
+│   │       │   ├── _sphinx_javascript_frameworks_compat.js
+│   │       │   ├── basic.css
+│   │       │   ├── css
+│   │       │   │   ├── badge_only.css
+│   │       │   │   ├── fonts
+│   │       │   │   │   ├── Roboto-Slab-Bold.woff
+│   │       │   │   │   ├── Roboto-Slab-Bold.woff2
+│   │       │   │   │   ├── Roboto-Slab-Regular.woff
+│   │       │   │   │   ├── Roboto-Slab-Regular.woff2
+│   │       │   │   │   ├── fontawesome-webfont.eot
+│   │       │   │   │   ├── fontawesome-webfont.svg
+│   │       │   │   │   ├── fontawesome-webfont.ttf
+│   │       │   │   │   ├── fontawesome-webfont.woff
+│   │       │   │   │   ├── fontawesome-webfont.woff2
+│   │       │   │   │   ├── lato-bold-italic.woff
+│   │       │   │   │   ├── lato-bold-italic.woff2
+│   │       │   │   │   ├── lato-bold.woff
+│   │       │   │   │   ├── lato-bold.woff2
+│   │       │   │   │   ├── lato-normal-italic.woff
+│   │       │   │   │   ├── lato-normal-italic.woff2
+│   │       │   │   │   ├── lato-normal.woff
+│   │       │   │   │   └── lato-normal.woff2
+│   │       │   │   └── theme.css
+│   │       │   ├── doctools.js
+│   │       │   ├── documentation_options.js
+│   │       │   ├── file.png
+│   │       │   ├── fonts
+│   │       │   │   ├── Lato
+│   │       │   │   │   ├── lato-bold.eot
+│   │       │   │   │   ├── lato-bold.ttf
+│   │       │   │   │   ├── lato-bold.woff
+│   │       │   │   │   ├── lato-bold.woff2
+│   │       │   │   │   ├── lato-bolditalic.eot
+│   │       │   │   │   ├── lato-bolditalic.ttf
+│   │       │   │   │   ├── lato-bolditalic.woff
+│   │       │   │   │   ├── lato-bolditalic.woff2
+│   │       │   │   │   ├── lato-italic.eot
+│   │       │   │   │   ├── lato-italic.ttf
+│   │       │   │   │   ├── lato-italic.woff
+│   │       │   │   │   ├── lato-italic.woff2
+│   │       │   │   │   ├── lato-regular.eot
+│   │       │   │   │   ├── lato-regular.ttf
+│   │       │   │   │   ├── lato-regular.woff
+│   │       │   │   │   └── lato-regular.woff2
+│   │       │   │   └── RobotoSlab
+│   │       │   │       ├── roboto-slab-v7-bold.eot
+│   │       │   │       ├── roboto-slab-v7-bold.ttf
+│   │       │   │       ├── roboto-slab-v7-bold.woff
+│   │       │   │       ├── roboto-slab-v7-bold.woff2
+│   │       │   │       ├── roboto-slab-v7-regular.eot
+│   │       │   │       ├── roboto-slab-v7-regular.ttf
+│   │       │   │       ├── roboto-slab-v7-regular.woff
+│   │       │   │       └── roboto-slab-v7-regular.woff2
+│   │       │   ├── jquery.js
+│   │       │   ├── js
+│   │       │   │   ├── badge_only.js
+│   │       │   │   ├── theme.js
+│   │       │   │   └── versions.js
+│   │       │   ├── language_data.js
+│   │       │   ├── minus.png
+│   │       │   ├── plus.png
+│   │       │   ├── pygments.css
+│   │       │   ├── searchtools.js
+│   │       │   └── sphinx_highlight.js
+│   │       ├── genindex.html
+│   │       ├── index.html
+│   │       ├── modules.html
+│   │       ├── objects.inv
+│   │       ├── py-modindex.html
+│   │       ├── search.html
+│   │       └── searchindex.js
+│   ├── files
+│   │   └── loaded-data
+│   ├── make.bat
+│   ├── requirements.txt
+│   └── source
+│       ├── DataLoading.rst
+│       ├── Home.rst
+│       ├── QuickLook.rst
+│       ├── _static
+│       ├── _templates
+│       ├── conf.py
+│       ├── index.rst
+│       └── modules.rst
+├── environment.yml
 ├── explorer.py
 ├── files
-│   ├── data
-│   └── loaded-data
+│   ├── data
+│   │   ├── LightCurve_bexvar.fits
+│   │   ├── data_small.hdf5
+│   │   ├── data_smaller.hdf5
+│   │   ├── lcurveA.fits
+│   │   ├── lcurve_new.fits
+│   │   ├── monol_testA.evt
+│   │   ├── monol_testA_calib.evt
+│   │   ├── monol_testA_calib_unsrt.evt
+│   │   ├── nomission.evt
+│   │   ├── xte_gx_test.evt.gz
+│   │   └── xte_test.evt.gz
+│   └── loaded-data
 ├── modules
-│   ├── DataLoading
-│   │   ├── DataIngestion.py
-│   ├── Home
-│   │   ├── HomeContent.py
-│   └── QuickLook
-│       ├── AverageCrossSpectrum.py
-│       ├── AveragePowerSpectrum.py
-│       ├── CrossSpectrum.py
-│       ├── LightCurve.py
-│       ├── PowerSpectrum.py
-├── utils
+│   ├── DataLoading
+│   │   ├── DataIngestion.py
+│   │   ├── __init__.py
+│   │   └── __pycache__
+│   │       ├── DataIngestion.cpython-311.pyc
+│   │       └── __init__.cpython-311.pyc
+│   ├── Home
+│   │   ├── HomeContent.py
+│   │   ├── __init__.py
+│   │   └── __pycache__
+│   │       ├── Home.cpython-311.pyc
+│   │       ├── HomeContent.cpython-311.pyc
+│   │       └── __init__.cpython-311.pyc
+│   └── QuickLook
+│       ├── AverageCrossSpectrum.py
+│       ├── AveragePowerSpectrum.py
+│       ├── Bispectrum.py
+│       ├── CrossSpectrum.py
+│       ├── LightCurve.py
+│       ├── PowerColors.py
+│       ├── PowerSpectrum.py
+│       ├── __init__.py
+│       └── __pycache__
+│           ├── AverageCrossSpectrum.cpython-311.pyc
+│           ├── AveragePowerSpectrum.cpython-311.pyc
+│           ├── Bispectrum.cpython-311.pyc
+│           ├── CrossSpectrum.cpython-311.pyc
+│           ├── LightCurve.cpython-311.pyc
+│           ├── PowerColors.cpython-311.pyc
+│           ├── PowerSpectrum.cpython-311.pyc
+│           └── __init__.cpython-311.pyc
+├── pyproject.toml
+├── setup.py
+├── tests
+│   ├── test_dataloading
+│   │   ├── __pycache__
+│   │   │   └── test_dataingestion.cpython-311-pytest-8.2.1.pyc
+│   │   └── test_dataingestion.py
+│   ├── test_quicklook
+│   └── test_utils
+└── utils
     ├── DashboardClasses.py
+    ├── __pycache__
+    │   ├── dashboardClasses.cpython-311.pyc
+    │   ├── globals.cpython-311.pyc
+    │   ├── sidebar.cpython-311.pyc
+    │   └── strings.cpython-311.pyc
     ├── globals.py
     ├── sidebar.py
     └── strings.py
+
+47 directories, 162 files
 ```
 
 ## Installation

pyproject.toml

@@ -14,3 +14,5 @@ dependencies = [
     "stingray",
     # Add other dependencies here if needed
 ]
+[tool.pytest.ini_options]
+pythonpath = ["."]

tests/test_dataloading/test_dataingestion.py

@@ -0,0 +1,189 @@
+import pytest
+from unittest.mock import MagicMock, patch
+from modules.DataLoading.DataIngestion import (
+    create_loadingdata_output_box,
+    load_event_data,
+    save_loaded_files,
+    delete_selected_files,
+    preview_loaded_files,
+    clear_loaded_files,
+    create_event_list,
+    simulate_event_list,
+    create_warning_handler,
+)
+
+
+def test_create_loadingdata_output_box():
+    content = "File loaded successfully."
+    output_box = create_loadingdata_output_box(content)
+    assert output_box.output_content == content
+
+
+@patch("dataingestion.loaded_event_data", [])
+def test_load_event_data_no_file_selected(
+    output_box_container, warning_box_container, warning_handler, mock_file_selector, filename_input, format_input, format_checkbox
+):
+    # Set up file selector with no selection
+    mock_file_selector.value = []
+    load_event_data(
+        event=None,
+        file_selector=mock_file_selector,
+        filename_input=filename_input,
+        format_input=format_input,
+        format_checkbox=format_checkbox,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "No file selected" in output_box_container[0].output_content
+
+
+@patch("dataingestion.loaded_event_data", [])
+@patch("dataingestion.EventList.read")
+def test_load_event_data_success(mock_read, output_box_container, warning_box_container, warning_handler, mock_file_selector, filename_input, format_input, format_checkbox):
+    # Mock EventList read to return a valid event
+    mock_read.return_value = MagicMock()
+    
+    load_event_data(
+        event=None,
+        file_selector=mock_file_selector,
+        filename_input=filename_input,
+        format_input=format_input,
+        format_checkbox=format_checkbox,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert len(output_box_container) > 0
+    assert "loaded successfully" in output_box_container[0].output_content
+
+
+@patch("dataingestion.loaded_event_data", [("file1", MagicMock())])
+def test_load_event_data_duplicate_file(
+    output_box_container, warning_box_container, warning_handler, mock_file_selector, filename_input, format_input, format_checkbox
+):
+    # Test with duplicate file name
+    filename_input.value = "file1"
+    load_event_data(
+        event=None,
+        file_selector=mock_file_selector,
+        filename_input=filename_input,
+        format_input=format_input,
+        format_checkbox=format_checkbox,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "already exists in memory" in output_box_container[0].output_content
+
+
+@patch("dataingestion.os.path.exists", return_value=False)
+@patch("dataingestion.loaded_event_data", [("file1", MagicMock())])
+def test_save_loaded_files_success(mock_exists, output_box_container, warning_box_container, warning_handler, filename_input, format_input, format_checkbox):
+    save_loaded_files(
+        event=None,
+        filename_input=filename_input,
+        format_input=format_input,
+        format_checkbox=format_checkbox,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "saved successfully" in output_box_container[0].output_content
+
+
+@patch("dataingestion.os.path.exists", return_value=True)
+@patch("dataingestion.loaded_event_data", [("file1", MagicMock())])
+def test_save_loaded_files_duplicate_name(mock_exists, output_box_container, warning_box_container, warning_handler, filename_input, format_input, format_checkbox):
+    save_loaded_files(
+        event=None,
+        filename_input=filename_input,
+        format_input=format_input,
+        format_checkbox=format_checkbox,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "already exists" in output_box_container[0].output_content
+
+
+@patch("dataingestion.os.remove")
+def test_delete_selected_files_success(mock_remove, output_box_container, warning_box_container, warning_handler, mock_file_selector):
+    delete_selected_files(
+        event=None,
+        file_selector=mock_file_selector,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "deleted successfully" in output_box_container[0].output_content
+
+
+def test_preview_loaded_files_no_data(output_box_container, warning_box_container, warning_handler):
+    preview_loaded_files(
+        event=None,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "No valid files or light curves loaded" in output_box_container[0].output_content
+
+
+@patch("dataingestion.loaded_event_data", [("event1", MagicMock(time=[0.1, 0.2], mjdref=58000, gti=[[0, 1]]) )])
+def test_preview_loaded_files_with_data(output_box_container, warning_box_container, warning_handler):
+    preview_loaded_files(
+        event=None,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "Event List - event1" in output_box_container[0].output_content
+
+
+@patch("dataingestion.loaded_event_data", [("event1", MagicMock())])
+def test_clear_loaded_files(output_box_container, warning_box_container):
+    clear_loaded_files(
+        event=None,
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+    )
+    assert "cleared" in output_box_container[0].output_content
+
+
+def test_create_event_list_missing_data(output_box_container, warning_box_container, warning_handler):
+    create_event_list(
+        event=None,
+        times_input=MagicMock(value=""),
+        energy_input=MagicMock(value=""),
+        pi_input=MagicMock(value=""),
+        gti_input=MagicMock(value=""),
+        mjdref_input=MagicMock(value=""),
+        name_input=MagicMock(value=""),
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "Please enter Photon Arrival Times and MJDREF" in output_box_container[0].output_content
+
+
+def test_simulate_event_list(output_box_container, warning_box_container, warning_handler):
+    simulate_event_list(
+        event=None,
+        time_slider=MagicMock(value=10),
+        count_slider=MagicMock(value=5),
+        dt_input=MagicMock(value=0.1),
+        name_input=MagicMock(value="simulated_event"),
+        method_selector=MagicMock(value="Standard Method"),
+        output_box_container=output_box_container,
+        warning_box_container=warning_box_container,
+        warning_handler=warning_handler,
+    )
+    assert "simulated successfully" in output_box_container[0].output_content
+
+
+def test_create_warning_handler():
+    handler = create_warning_handler()
+    with pytest.warns(None) as record:
+        handler.warn("Test warning", category=UserWarning)
+    assert len(record) == 1
+    assert record[0].message.args[0] == "Test warning"