Skip to content

Commit

Permalink
fix:add support materials
Browse files Browse the repository at this point in the history
  • Loading branch information
blasscoc committed Nov 14, 2024
1 parent 3265173 commit 0ee1d25
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
37 changes: 37 additions & 0 deletions examples/real_data_example/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
cmake_minimum_required(VERSION 3.24)
project(real_data_example_project VERSION 1.0.0 LANGUAGES CXX)

# Set the C++ standard
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# Include FetchContent module
include(FetchContent)

# Fetch the mdio-cpp library from the specified branch
FetchContent_Declare(
mdio
GIT_REPOSITORY https://github.com/TGSAI/mdio-cpp.git
GIT_TAG main
)
FetchContent_MakeAvailable(mdio)

# Fetch the indicators library
FetchContent_Declare(
indicators
GIT_REPOSITORY https://github.com/p-ranav/indicators.git
GIT_TAG v2.3
)
FetchContent_MakeAvailable(indicators)

# Create an executable target
add_executable(real_data_example src/real_data_example.cc)

# Link the mdio and indicators libraries to the executable
target_link_libraries(real_data_example PRIVATE
mdio
${mdio_INTERNAL_DEPS}
${mdio_INTERNAL_S3_DRIVER_DEPS}
PNG::PNG
indicators
)
47 changes: 47 additions & 0 deletions examples/real_data_example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Seismic Data Extractor

A C++ tool for extracting and processing 3D seismic data slices from MDIO datasets. The tool will extract a slice of a larger MDIO dataset and output the result to a NumPy array called seismic_slice.npy.

This tool demonstrates working with the Poseidon dataset, a public seismic dataset available on AWS Earth, and is provided under a CC BY 4.0 license.

## Overview

This tool allows users to extract specific slices from 3D seismic data stored in MDIO format, with options to specify ranges for inline, crossline, and depth dimensions. The extracted data can be saved in NumPy format for further analysis.

## Prerequisites

- C++ compiler with C++17 support
- MDIO library (for reading seismic data)
- indicators library (for progress bars)
- CMake (for building)

## Installation

[Installation instructions would be valuable here]

## Usage

```bash
./real_data_example [flags]
```

### Flags

- `--dataset_path`: Path to the MDIO dataset (default: "s3://tgs-opendata-poseidon/full_stack_agc.mdio")
- `--inline_range`: Inline range in format {inline,start,end,step} (default: "{inline,700,701,1}")
- `--xline_range`: Crossline range in format {crossline,start,end,step} (default: "{crossline,500,700,1}")
- `--depth_range`: Optional depth range in format {depth,start,end,step}
- `--variable_name`: Name of the seismic variable to extract (default: "seismic")
- `--print_dataset`: Print the dataset URL and return without processing

### Example

To print the contents of the file ...
```
./real_data_example --print_dataset --dataset_path="s3://tgs-opendata-poseidon/full_stack_agc.mdio"
```

To slice the data and write to numpy ...
```
./real_data_example --inline_range="{inline,700,701,1}" --xline_range="{crossline,500,1000,1}" --depth_range="{time, 300, 900,1}"
```

0 comments on commit 0ee1d25

Please sign in to comment.