format help string in data ingestion

modules/DataLoading/DataIngestion.py

@@ -6,6 +6,7 @@ from stingray import Lightcurve
 import warnings
 import os
 import stat
+import numpy as np
 from bokeh.models import Tooltip
 from utils.globals import loaded_event_data
 from utils.DashboardClasses import (
@@ -18,7 +19,7 @@ from utils.DashboardClasses import (
     Footer,
 )
 import param
-
+from utils.strings import LOADING_DATA_HELP_BOX_STRING
 
 # Path to the topmost directory for loaded-data
 loaded_data_path = os.path.join(os.getcwd(), "files", "loaded-data")
@@ -26,6 +27,7 @@ loaded_data_path = os.path.join(os.getcwd(), "files", "loaded-data")
 # Create the loaded-data directory if it doesn't exist
 os.makedirs(loaded_data_path, exist_ok=True)
 
+
 # Custom warning handler
 class WarningHandler:
     def __init__(self):
@@ -74,7 +76,11 @@ def load_event_data(
     warning_handler,
 ):
     if not file_selector.value:
-        output_box_container[:] = [create_loadingdata_output_box("No file selected. Please select a file to upload.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box(
+                "No file selected. Please select a file to upload."
+            )
+        ]
         return
 
     file_paths = file_selector.value
@@ -100,14 +106,22 @@ def load_event_data(
             ]
         )
     if len(formats) < len(file_paths):
-        output_box_container[:] = [create_loadingdata_output_box("Please specify formats for all files or check the default format option.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box(
+                "Please specify formats for all files or check the default format option."
+            )
+        ]
         return
 
     try:
         loaded_files = []
         for file_path, file_name, file_format in zip(file_paths, filenames, formats):
             if any(file_name == event[0] for event in loaded_event_data):
-                output_box_container[:] = [create_loadingdata_output_box(f"A file with the name '{file_name}' already exists in memory. Please provide a different name.")]
+                output_box_container[:] = [
+                    create_loadingdata_output_box(
+                        f"A file with the name '{file_name}' already exists in memory. Please provide a different name."
+                    )
+                ]
                 return
 
             event_list = EventList.read(file_path, file_format)
@@ -115,13 +129,19 @@ def load_event_data(
             loaded_files.append(
                 f"File '{file_path}' loaded successfully as '{file_name}' with format '{file_format}'."
             )
-        output_box_container[:] = [create_loadingdata_output_box("\n".join(loaded_files))]
+        output_box_container[:] = [
+            create_loadingdata_output_box("\n".join(loaded_files))
+        ]
         if warning_handler.warnings:
-            warning_box_container[:] = [create_loadingdata_warning_box("\n".join(warning_handler.warnings))]
+            warning_box_container[:] = [
+                create_loadingdata_warning_box("\n".join(warning_handler.warnings))
+            ]
         else:
             warning_box_container[:] = [create_loadingdata_warning_box("No warnings.")]
     except Exception as e:
-        output_box_container[:] = [create_loadingdata_output_box(f"An error occurred: {e}")]
+        output_box_container[:] = [
+            create_loadingdata_output_box(f"An error occurred: {e}")
+        ]
 
     # Clear the warnings after displaying them
     warning_handler.warnings.clear()
@@ -137,7 +157,9 @@ def save_loaded_files(
     warning_handler,
 ):
     if not loaded_event_data:
-        output_box_container[:] = [create_loadingdata_output_box("No files loaded to save.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box("No files loaded to save.")
+        ]
         return
 
     filenames = (
@@ -155,13 +177,23 @@ def save_loaded_files(
         formats = ["hdf5" for _ in range(len(loaded_event_data))]
 
     if len(filenames) < len(loaded_event_data):
-        output_box_container[:] = [create_loadingdata_output_box("Please specify names for all loaded files.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box("Please specify names for all loaded files.")
+        ]
         return
     if len(filenames) != len(loaded_event_data):
-        output_box_container[:] = [create_loadingdata_output_box("Please ensure that the number of names matches the number of loaded files.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box(
+                "Please ensure that the number of names matches the number of loaded files."
+            )
+        ]
         return
     if len(formats) < len(loaded_event_data):
-        output_box_container[:] = [create_loadingdata_output_box("Please specify formats for all loaded files or check the default format option.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box(
+                "Please specify formats for all loaded files or check the default format option."
+            )
+        ]
         return
 
     saved_files = []
@@ -172,7 +204,11 @@ def save_loaded_files(
             if os.path.exists(
                 os.path.join(loaded_data_path, f"{file_name}.{file_format}")
             ):
-                output_box_container[:] = [create_loadingdata_output_box(f"A file with the name '{file_name}' already exists. Please provide a different name.")]
+                output_box_container[:] = [
+                    create_loadingdata_output_box(
+                        f"A file with the name '{file_name}' already exists. Please provide a different name."
+                    )
+                ]
                 return
 
             save_path = os.path.join(loaded_data_path, f"{file_name}.{file_format}")
@@ -187,13 +223,19 @@ def save_loaded_files(
                 f"File '{file_name}' saved successfully to '{save_path}'."
             )
 
-        output_box_container[:] = [create_loadingdata_output_box("\n".join(saved_files))]
+        output_box_container[:] = [
+            create_loadingdata_output_box("\n".join(saved_files))
+        ]
         if warning_handler.warnings:
-            warning_box_container[:] = [create_loadingdata_warning_box("\n".join(warning_handler.warnings))]
+            warning_box_container[:] = [
+                create_loadingdata_warning_box("\n".join(warning_handler.warnings))
+            ]
         else:
-            warning_box_container[:] = [create_loadingtab_warning_box("No warnings.")]
+            warning_box_container[:] = [create_loadingdata_warning_box("No warnings.")]
     except Exception as e:
-        warning_box_container[:] = [create_loadingdata_warning_box(f"An error occurred while saving files: {e}")]
+        warning_box_container[:] = [
+            create_loadingdata_warning_box(f"An error occurred while saving files: {e}")
+        ]
 
     # Clear the warnings after displaying them
     warning_handler.warnings.clear()
@@ -207,7 +249,11 @@ def delete_selected_files(
     warning_handler,
 ):
     if not file_selector.value:
-        output_box_container[:] = [create_loadingdata_output_box("No file selected. Please select a file to delete.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box(
+                "No file selected. Please select a file to delete."
+            )
+        ]
         return
 
     file_paths = file_selector.value
@@ -228,7 +274,9 @@ def delete_selected_files(
             deleted_files.append(f"An error occurred while deleting '{file_path}': {e}")
     output_box_container[:] = [create_loadingdata_output_box("\n".join(deleted_files))]
     if warning_handler.warnings:
-        warning_box_container[:] = [create_loadingdata_warning_box("\n".join(warning_handler.warnings))]
+        warning_box_container[:] = [
+            create_loadingdata_warning_box("\n".join(warning_handler.warnings))
+        ]
     else:
         warning_box_container[:] = [create_loadingdata_warning_box("No warnings.")]
 
@@ -243,7 +291,9 @@ def preview_loaded_files(
     time_limit=10,
 ):
     if not loaded_event_data:
-        output_box_container[:] = [create_loadingdata_output_box("No files loaded to preview.")]
+        output_box_container[:] = [
+            create_loadingdata_output_box("No files loaded to preview.")
+        ]
         return
 
     preview_data = []
@@ -257,12 +307,159 @@ def preview_loaded_files(
             warning_handler.warn(str(e), category=RuntimeWarning)
 
     if preview_data:
-        output_box_container[:] = [create_loadingdata_output_box("\n\n".join(preview_data))]
+        output_box_container[:] = [
+            create_loadingdata_output_box("\n\n".join(preview_data))
+        ]
+    else:
+        output_box_container[:] = [
+            create_loadingdata_output_box("No valid files loaded for preview.")
+        ]
+
+    if warning_handler.warnings:
+        warning_box_container[:] = [
+            create_loadingdata_warning_box("\n".join(warning_handler.warnings))
+        ]
+    else:
+        warning_box_container[:] = [create_loadingdata_warning_box("No warnings.")]
+
+    warning_handler.warnings.clear()
+
+
+def create_event_list(
+    event,
+    times_input,
+    energy_input,
+    gti_input,
+    mjdref_input,
+    name_input,
+    output_box_container,
+    warning_box_container,
+    warning_handler,
+):
+    # Clear previous warnings
+    warning_handler.warnings.clear()
+    warnings.resetwarnings()
+
+    try:
+        if not times_input.value or not mjdref_input.value:
+            output_box_container[:] = [
+                create_loadingdata_output_box(
+                    "Please enter Photon Arrival Times and MJDREF."
+                )
+            ]
+            return
+
+        times = [float(t) for t in times_input.value.split(",")]
+        mjdref = float(mjdref_input.value)
+        energy = (
+            [float(e) for e in energy_input.value.split(",")]
+            if energy_input.value
+            else None
+        )
+        gti = (
+            [
+                [float(g) for g in interval.split()]
+                for interval in gti_input.value.split(";")
+            ]
+            if gti_input.value
+            else None
+        )
+
+        if name_input.value:
+            name = name_input.value
+            if any(name == event[0] for event in loaded_event_data):
+                output_box_container[:] = [
+                    create_loadingdata_output_box(
+                        f"A file with the name '{name}' already exists in memory. Please provide a different name."
+                    )
+                ]
+                return
+        else:
+            name = f"event_list_{len(loaded_event_data)}"
+
+        event_list = EventList(times, energy=energy, gti=gti, mjdref=mjdref)
+
+        loaded_event_data.append((name, event_list))
+
+        output_box_container[:] = [
+            create_loadingdata_output_box(
+                f"Event List created successfully!\nSaved as: {name}\nTimes: {event_list.time}\nMJDREF: {event_list.mjdref}\nGTI: {event_list.gti}\nEnergy: {event_list.energy if energy else 'Not provided'}"
+            )
+        ]
+    except ValueError as ve:
+        warning_handler.warn(str(ve), category=ValueError)
+    except Exception as e:
+        warning_handler.warn(str(e), category=RuntimeError)
+
+    if warning_handler.warnings:
+        warning_box_container[:] = [
+            create_loadingdata_warning_box("\n".join(warning_handler.warnings))
+        ]
     else:
-        output_box_container[:] = [create_loadingdata_output_box("No valid files loaded for preview.")]
+        warning_box_container[:] = [create_loadingdata_warning_box("No warnings.")]
+
+    warning_handler.warnings.clear()
+
+
+def simulate_event_list(
+    event,
+    time_slider,
+    count_slider,
+    dt_input,
+    name_input,
+    method_selector,
+    output_box_container,
+    warning_box_container,
+    warning_handler,
+):
+    # Clear previous warnings
+    warning_handler.warnings.clear()
+    warnings.resetwarnings()
+
+    try:
+        if not name_input.value:
+            output_box_container[:] = [
+                create_loadingdata_output_box(
+                    "Please provide a name for the simulated event list."
+                )
+            ]
+            return
+
+        if any(name_input.value == event[0] for event in loaded_event_data):
+            output_box_container[:] = [
+                create_loadingdata_output_box(
+                    f"A file with the name '{name_input.value}' already exists in memory. Please provide a different name."
+                )
+            ]
+            return
+
+        times = np.arange(time_slider.value)
+        counts = np.floor(np.random.rand(time_slider.value) * count_slider.value)
+        dt = dt_input.value
+        lc = Lightcurve(times, counts, dt=dt, skip_checks=True)
+
+        if method_selector.value == "Standard Method":
+            event_list = EventList.from_lc(lc)
+        else:
+            event_list = EventList()
+            event_list.simulate_times(lc)
+
+        name = name_input.value
+        loaded_event_data.append((name, event_list))
+
+        output_box_container[:] = [
+            create_loadingdata_output_box(
+                f"Event List simulated successfully!\nSaved as: {name}\nTimes: {event_list.time}\nCounts: {counts}"
+            )
+        ]
+
+    except Exception as e:
+        warning_handler.warn(str(e), category=RuntimeError)
 
     if warning_handler.warnings:
-        warning_box_container[:] = [create_loadingdata_warning_box("\n".join(warning_handler.warnings))]
+        warning_box_container[:] = [
+            create_loadingdata_warning_box("\n".join(warning_handler.warnings))
+        ]
     else:
         warning_box_container[:] = [create_loadingdata_warning_box("No warnings.")]
 
@@ -393,13 +590,128 @@ def create_loading_tab(output_box_container, warning_box_container, warning_hand
     return tab_content
 
 
+def create_event_list_tab(output_box_container, warning_box_container, warning_handler):
+    output = pn.widgets.TextAreaInput(
+        name="Output", value="", disabled=True, height=200
+    )
+    warning_output = pn.widgets.TextAreaInput(
+        name="Warnings", value="", disabled=True, height=200
+    )
+
+    times_input = pn.widgets.TextInput(
+        name="Photon Arrival Times", placeholder="e.g., 0.5, 1.1, 2.2, 3.7"
+    )
+    mjdref_input = pn.widgets.TextInput(name="MJDREF", placeholder="e.g., 58000.")
+    energy_input = pn.widgets.TextInput(
+        name="Energy (optional)", placeholder="e.g., 0., 3., 4., 20."
+    )
+    gti_input = pn.widgets.TextInput(
+        name="GTIs (optional)", placeholder="e.g., 0 4; 5 10"
+    )
+    name_input = pn.widgets.TextInput(
+        name="Event List Name", placeholder="e.g., my_event_list"
+    )
+    create_button = pn.widgets.Button(name="Create Event List", button_type="primary")
+
+    create_button.on_click(
+        lambda event: create_event_list(
+            event,
+            times_input,
+            energy_input,
+            gti_input,
+            mjdref_input,
+            name_input,
+            output_box_container,
+            warning_box_container,
+            warning_handler,
+        )
+    )
+
+    tab_content = pn.Column(
+        pn.pane.Markdown("# Create Event List"),
+        times_input,
+        mjdref_input,
+        energy_input,
+        gti_input,
+        name_input,
+        create_button,
+    )
+    return tab_content
+
+
+def create_simulate_event_list_tab(
+    output_box_container, warning_box_container, warning_handler
+):
+
+    simulation_title = pn.pane.Markdown("# Simulating Event Lists")
+    time_slider = pn.widgets.IntSlider(
+        name="Number of Time Bins", start=1, end=10000, value=10
+    )
+    count_slider = pn.widgets.IntSlider(
+        name="Max Counts per Bin", start=1, end=10000, value=5
+    )
+    dt_input = pn.widgets.FloatSlider(
+        name="Delta Time (dt)", start=0.0001, end=10000.0, step=0.001, value=1.0
+    )
+    method_selector = pn.widgets.Select(
+        name="Method", options=["Standard Method", "Inverse CDF Method"]
+    )
+    sim_name_input = pn.widgets.TextInput(
+        name="Simulated Event List Name", placeholder="e.g., my_sim_event_list"
+    )
+    simulate_button = pn.widgets.Button(
+        name="Simulate Event List", button_type="primary"
+    )
+
+    simulate_button.on_click(
+        lambda event: simulate_event_list(
+            event,
+            time_slider,
+            count_slider,
+            dt_input,
+            sim_name_input,
+            method_selector,
+            output_box_container,
+            warning_box_container,
+            warning_handler,
+        )
+    )
+
+    tab_content = pn.Column(
+        simulation_title,
+        time_slider,
+        count_slider,
+        dt_input,
+        method_selector,
+        sim_name_input,
+        simulate_button,
+    )
+    return tab_content
+
+
 def create_loadingdata_main_area(output_box, warning_box):
     warning_handler = create_warning_handler()
     tabs_content = {
-        "Loading": create_loading_tab(
+        "Load Event List": create_loading_tab(
             output_box_container=output_box,
             warning_box_container=warning_box,
             warning_handler=warning_handler,
-        )
+        ),
+        "Create Event List": create_event_list_tab(
+            output_box_container=output_box,
+            warning_box_container=warning_box,
+            warning_handler=warning_handler,
+        ),
+        "Simulate Event List": create_simulate_event_list_tab(
+            output_box_container=output_box,
+            warning_box_container=warning_box,
+            warning_handler=warning_handler,
+        ),
     }
     return MainArea(tabs_content=tabs_content)
+
+
+def create_loadingdata_help_area():
+    help_content = LOADING_DATA_HELP_BOX_STRING
+    return HelpBox(help_content=help_content, title="Help Section")
+

modules/Home/HomeContent.py

@@ -10,14 +10,14 @@ from utils.DashboardClasses import (
 )
 from utils.strings import (
     HOME_HEADER_STRING,
-    WELCOME_MESSAGE_STRING,
-    FOOTER_STRING,
-    STINGRAY_TAB_STRING,
-    HOLOVIZ_TAB_STRING,
-    DASHBOARD_TAB_STRING,
-    OUTPUT_BOX_STRING,
-    WARNING_BOX_STRING,
-    HELP_BOX_STRING,
+    HOME_WELCOME_MESSAGE_STRING,
+    HOME_FOOTER_STRING,
+    HOME_STINGRAY_TAB_STRING,
+    HOME_HOLOVIZ_TAB_STRING,
+    HOME_DASHBOARD_TAB_STRING,
+    HOME_OUTPUT_BOX_STRING,
+    HOME_WARNING_BOX_STRING,
+    HOME_HELP_BOX_STRING,
 )
 
 """ Header Section """
@@ -33,9 +33,9 @@ def create_home_header():
 
 """ Main Area Section """
 def create_home_main_area():
-    tab1_content = pn.pane.Markdown(STINGRAY_TAB_STRING)
-    tab2_content = pn.pane.Markdown(HOLOVIZ_TAB_STRING)
-    tab3_content = pn.pane.Markdown(DASHBOARD_TAB_STRING)
+    tab1_content = pn.pane.Markdown(HOME_STINGRAY_TAB_STRING)
+    tab2_content = pn.pane.Markdown(HOME_HOLOVIZ_TAB_STRING)
+    tab3_content = pn.pane.Markdown(HOME_DASHBOARD_TAB_STRING)
 
     tabs_content = {
         "What's Stingray?": tab1_content,
@@ -47,11 +47,11 @@ def create_home_main_area():
 
 """ Output Box Section """
 def create_home_output_box():
-    return OutputBox(output_content=OUTPUT_BOX_STRING)
+    return OutputBox(output_content=HOME_OUTPUT_BOX_STRING)
 
 """ Warning Box Section """
 def create_home_warning_box():
-    return WarningBox(warning_content=WARNING_BOX_STRING)
+    return WarningBox(warning_content=HOME_WARNING_BOX_STRING)
 
 """ Plots Area Section """
 def create_home_plots_area():
@@ -69,7 +69,7 @@ def create_home_plots_area():
 
 """ Help Area Section """
 def create_home_help_area():
-    help_content = HELP_BOX_STRING
+    help_content = HOME_HELP_BOX_STRING
     return HelpBox(help_content=help_content, title="Help Section")
 
 """ Footer Section """

utils/sidebar.py

@@ -15,6 +15,7 @@ from modules.DataLoading.DataIngestion import (
     create_loadingdata_main_area,
     create_loadingdata_output_box,
     create_loadingdata_warning_box,
+    create_loadingdata_help_area,
 )
 from modules.QuickLook.LightCurve import create_quicklook_lightcurve_header
 from assets.icons.svg import HOME_ICON_SVG, LOAD_DATA_ICON_SVG
@@ -71,6 +72,7 @@ def create_sidebar(main_area, header, footer, output_box, warning_box, help_box)
         main_area[:] = [create_loadingdata_main_area(output_box, warning_box)]
         output_box[:] = [create_home_output_box()]
         warning_box[:] = [create_home_warning_box()]
+        help_box[:] = [create_loadingdata_help_area()]
 
     load_data_button.on_click(load_data)
 

utils/strings.py

@@ -4,7 +4,7 @@ HOME_HEADER_STRING = """
 <h1>Welcome to the Stingray Explorer Dashboard</h1>
 """
 
-WELCOME_MESSAGE_STRING = """
+HOME_WELCOME_MESSAGE_STRING = """
 <div>
     <p>This dashboard is designed to provide a comprehensive toolset for X-ray astronomy data analysis. Here are the main features:</p>
     <ul>
@@ -63,7 +63,7 @@ WELCOME_MESSAGE_STRING = """
 </div>
 """
 
-FOOTER_STRING = """
+HOME_FOOTER_STRING = """
     <div>
         <p>Stingray Explorer Dashboard</p>
         <p>&copy; 2021 Kartik Mandar</p>
@@ -73,7 +73,7 @@ FOOTER_STRING = """
 
 # Tabs in Main Area of Home Page
 
-STINGRAY_TAB_STRING = """
+HOME_STINGRAY_TAB_STRING = """
 <h2> Stingray: Next-Generation Spectral Timing </h2>
 
 ![Stingray-logo](../assets/images/stingray_logo_minimised.png)
@@ -130,7 +130,7 @@ Windows uses an internal 32-bit representation for int. This might create numeri
 <br></br>
 """
 
-HOLOVIZ_TAB_STRING = """
+HOME_HOLOVIZ_TAB_STRING = """
 <h2> High-level tools to simplify visualization in Python </h2>
 
 ![HoloViz-logo](../assets/images/holoviz_logo_minimised.png)
@@ -185,7 +185,7 @@ HoloViz tools provide extensive support for Jupyter notebooks, as well as for st
 <br/>
 """
 
-DASHBOARD_TAB_STRING = """
+HOME_DASHBOARD_TAB_STRING = """
 <h2> Stingray Explorer </h2>
 
 ![Stingray-Explorer-logo](../assets/images/stingray_explorer_minimised.png)
@@ -195,18 +195,149 @@ This dashboard is designed to provide a comprehensive toolset for X-ray astronom
 <br/>
 """
 
-OUTPUT_BOX_STRING = """
+HOME_OUTPUT_BOX_STRING = """
 This is the output container. It will display the output of the analysis tools.
 It may contain what EventLists are made, what lightcurves are generated, what power spectra are calculated, etc. It can also be used to preview the loaded EventList. 
 """
 
 
-WARNING_BOX_STRING = """
+HOME_WARNING_BOX_STRING = """
 This is the warning container. It will display any warnings or errors that occur during the analysis process.
 """
 
-HELP_BOX_STRING = """
+HOME_HELP_BOX_STRING = """
 This is the helpbox container. It will display any help or documentation for the analysis tools.
 It will also have links to the documentation and tutorials for the tools.
 And have a brief description of the physics behind the analysis. 
 """
+
+
+# This section contains strings used in the DataIngestion.py
+
+LOADING_DATA_HELP_BOX_STRING = """
+<h2> Loading Tab </h2>
+
+### Functionality
+The "Loading" tab allows you to load, save, delete, and preview event data files. Here is a detailed explanation of each component and its functionality:
+
+- **File Selector**: Select files to load into the event data list.
+- **Enter File Names**: Specify custom names for the loaded files. If left blank, the names will be derived from the file paths.
+- **Enter Formats**: Specify the formats of the files being loaded. If left blank, the default format is used.
+- **Use default format**: Check this to use the default format ('ogip' for loading and 'hdf5' for saving).
+- **Load Event Data**: Load the selected files into the event data list.
+- **Save Loaded Data**: Save the loaded event data files to the specified directory.
+- **Delete Selected Files**: Delete the selected files from the file system.
+- **Preview Loaded Files**: Preview the contents of the loaded event data files.
+
+### Precautions
+- Ensure the file contains at least a 'time' column when loading event data.
+- When specifying custom names or formats, ensure that the number of names/formats matches the number of files selected.
+- Deleting files with the ".py" extension is not allowed to prevent accidental deletion of script files.
+
+### Examples
+#### Loading an Event List
+```python
+from stingray import EventList
+ev = EventList.read('events.fits', 'ogip')
+print(ev.time)
+```
+
+### Saving an Event List
+```python
+ev.write("events.hdf5", "hdf5")
+```
+
+## Creation Tab
+
+### Functionality
+
+The "Creation" tab allows you to create new event lists or simulate event lists from light curves. Here is a detailed explanation of each component and its functionality:
+
+- **Photon Arrival Times**: Enter photon arrival times in seconds from a reference MJD.
+- **MJDREF**: Enter the MJD reference for the photon arrival times.
+- **Energy (optional)**: Enter the energy values associated with the photons.
+- **GTIs (optional)**: Enter the Good Time Intervals (GTIs) for the event list.
+- **Event List Name**: Specify a name for the new event list.
+- **Create Event List**: Create a new event list with the specified parameters.
+
+### Simulation of Event Lists
+
+- **Number of Time Bins**: Specify the number of time bins for the simulation.
+- **Max Counts per Bin**: Specify the maximum counts per bin.
+- **Delta Time (dt)**: Specify the delta time for the light curve.
+- **Method**: Choose between "Standard Method" and "Inverse CDF Method" for simulating event lists.
+- **Simulated Event List Name**: Specify a name for the simulated event list.
+- **Simulate Event List**: Simulate an event list using the specified parameters.
+
+### Precautions
+
+- Ensure that photon arrival times and MJDREF are provided when creating an event list.
+- When simulating event lists, ensure that the provided parameters (e.g., number of time bins, max counts per bin) are reasonable to avoid excessively large or small event lists.
+
+### Examples
+
+#### Creating an Event List
+
+```python
+from stingray import EventList
+times = [0.5, 1.1, 2.2, 3.7]
+mjdref = 58000.
+energy = [0., 3., 4., 20.]
+gti = [[0, 4]]
+ev = EventList(times, gti=gti, energy=energy, mjdref=mjdref)
+print(ev.time)
+```
+
+#### Simulating an Event List from a Light Curve
+```python
+from stingray import EventList, Lightcurve
+times = np.arange(3)
+counts = np.floor(np.random.rand(3) * 5)
+lc = Lightcurve(times, counts, skip_checks=True, dt=1.)
+ev = EventList.from_lc(lc)
+print(ev.time)
+```
+
+## Stingray Documentation References
+
+### Creating EventList from Photon Arrival Times
+
+```python
+from stingray import EventList
+times = [0.5, 1.1, 2.2, 3.7]
+mjdref = 58000.
+ev = EventList(times, mjdref=mjdref)
+print(ev.time)
+```
+
+### Transforming a Lightcurve into an EventList
+```python
+from stingray import EventList, Lightcurve
+times = np.arange(3)
+counts = np.floor(np.random.rand(3) * 5)
+lc = Lightcurve(times, counts, skip_checks=True, dt=1.)
+ev = EventList.from_lc(lc)
+print(ev.time)
+```
+
+### Simulating EventList from Lightcurve
+```python
+from stingray import EventList, Lightcurve
+times = np.arange(50)
+counts = np.floor(np.random.rand(50) * 50000)
+lc = Lightcurve(times, counts, skip_checks=True, dt=1.)
+ev = EventList()
+ev.simulate_times(lc)
+print(ev.time)
+```
+
+### Loading and Writing EventList Objects
+```python
+from stingray import EventList
+ev = EventList.read('events.fits', 'ogip')
+ev.write("events.hdf5", "hdf5")
+```
+
+<br/>
+
+"""