SkyBox Analysis

Multi-language analysis toolbox for SkyBox wave run-up and impact dataset.

Languages & Documentation

Python

• Package: skyboxdatapy
• Scripts: Analysis notebooks in skyboxdatapy/scripts/
• Install: pip install -e ./skyboxdatapy

Julia

• Package: SkyBoxData
• Source: SkyBoxData.jl
• Example: run_example.jl
• Setup: julia --project=SkyBoxData.jl

Quick Start

Python Installation and Usage

# Install all dependencies in conda env
conda create --name skybox --clone base
conda activate skybox
pip install -r ./skyboxdatapy/requirements.txt

# Install the package
pip install -e ./skyboxdatapy

# Explore analysis notebooks
jupyter notebook skyboxdatapy/scripts/

Create the auto-documentation using:

cd ./skyboxdatapy
pdoc -o docs/ src/skyboxdatapy

Julia Setup

julia --project=SkyBoxData.jl
julia> using Pkg; Pkg.instantiate()
julia SkyBoxData.jl/scripts/run_example.jl

Available Analysis Scripts

The skyboxdatapy/scripts/ directory contains various analysis notebooks:

Core Analysis

• plotWP.ipynb - Wave probe analysis
• plotPP.ipynb - Pressure probe analysis
• plotFP_comp.ipynb - Force plate comparison

Data Processing

• readMAT.ipynb - MAT file processing
• Data conversion tools in convertFiles/

Peak Analysis

• Regular wave peaks in peaks/regular/
• Focusing wave peaks in peaks/focusing/

Project Structure

├── skyboxdatapy/           # Python package and analysis scripts
│   ├── src/
│   |   └──skyboxdatapy/    # Core Python modules (io, postprocess, spec, utils)
│   ├── scripts/            # Jupyter notebooks for analysis
│   ├── docs/               # Auto-generated Python API documentation
│   ├── requirements.txt    # Python dependencies
│   └── pyproject.toml      # Python package configuration
│
├── SkyBoxData.jl/          # Julia package
│   ├── src/                # Julia source code
│   ├── scripts/            # Julia example scripts
│   └── Project.toml        # Julia package configuration
│
└── data/                   # Raw and processed datasets

## Contributing

1. Follow existing code style for each language
2. Add tests and documentation  
3. Update this README when adding features

---