Skip to content

Commit 26a8e88

Browse files
committed
update Getting started documentation
1 parent 412aa6a commit 26a8e88

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,43 @@
33
### Seismic library for geophysical processing
44

55
This is a learn-by-doing project
6-
to reacquaint myself with the C Programming Language and my geophysical background.
6+
to reacquaint myself with the C/C++, geophysics, and binding with Python.
77

88
## Getting Started
99

10-
...
10+
### Prerequisites
11+
12+
- CMake
13+
- C++ compiler (e.g., g++, clang++)
14+
- Python > 3.12
15+
- Python development headers
16+
- On Debian/Ubuntu: `sudo apt-get install python3-dev`
17+
- On Fedora: `sudo dnf install python3-devel`
18+
- On macOS: `brew install python`
19+
- [uv](https://docs.astral.sh/uv/) for python project management
20+
21+
### Building the Library
22+
23+
1. Clone the repo
24+
2. Navigate to the project directory
25+
3. Create a virtual environment (optional but recommended)
26+
```shell
27+
uv venv
28+
source .venv/bin/activate
29+
```
30+
4. Build and install the project
31+
```shell
32+
uv sync
33+
```
34+
5. Run the Python tests
35+
36+
With the virtual environment activated, libseis should be installed and available.
37+
38+
```shell
39+
pytest
40+
```
41+
6. Run the C++ tests
42+
```shell
43+
cd build
44+
ctest
45+
```

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ cache-keys = [
4848
[tool.scikit-build]
4949
wheel.expand-macos-universal-tags = true
5050
minimum-version = "build-system.requires"
51-
build-dir = "build/{wheel_tag}"
51+
build-dir = "build/"
5252

5353

5454
[tool.pytest.ini_options]

0 commit comments

Comments
 (0)