las_rs 0.2.1

High-performance parser and writer for LAS (Log ASCII Standard) well-log files — LAS 1.2 / 2.0 / 3.0. Pure-Rust core; the optional `python` feature adds the PyO3 bindings that back the `las-rs` PyPI wheel.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221

"""
Phase 5f tests — Depth unit detection and conversion.

Covers las.index_unit detection from the STRT header (M, FT, unknown),
depth_m and depth_ft conversion helpers, error on unknown unit, and the
index_unit= override when reading.

All tests are marked xfail because the `las_rs` Rust extension has not yet
been implemented.
"""

import os

import numpy as np
import pytest

import las_rs

test_dir = os.path.dirname(__file__)


def fixture(*parts):
    return os.path.join(test_dir, "fixtures", *parts)


# ---------------------------------------------------------------------------
# Inline LAS helpers — all self-contained, no fixture files needed.
# ---------------------------------------------------------------------------

def _las_meters():
    """Return a LASFile whose depth index is in metres."""
    return las_rs.read("""\
~VERSION INFORMATION
 VERS.   2.0 : LAS VERSION 2.0
 WRAP.    NO : ONE LINE PER DEPTH STEP
~WELL INFORMATION
 STRT.M   500.0 : START DEPTH
 STOP.M   502.0 : STOP DEPTH
 STEP.M     1.0 : STEP VALUE
 NULL. -999.25  : NULL VALUE
 COMP.  NORDIC PETROLEUM : COMPANY
 WELL.  FJORD-3 #1       : WELL NAME
~CURVE INFORMATION
 DEPT.M    : MEASURED DEPTH
 GR  .GAPI : GAMMA RAY
~ASCII LOG DATA
 500.0   33.11
 501.0   41.55
 502.0   38.72
""")


def _las_feet():
    """Return a LASFile whose depth index is in feet."""
    return las_rs.read("""\
~VERSION INFORMATION
 VERS.   2.0 : LAS VERSION 2.0
 WRAP.    NO : ONE LINE PER DEPTH STEP
~WELL INFORMATION
 STRT.FT  1640.0 : START DEPTH
 STOP.FT  1643.0 : STOP DEPTH
 STEP.FT     1.0 : STEP VALUE
 NULL.   -999.25 : NULL VALUE
 COMP.  GULF COAST ENERGY : COMPANY
 WELL.  LONGHORN-9 #2     : WELL NAME
~CURVE INFORMATION
 DEPT.FT   : MEASURED DEPTH
 GR  .GAPI : GAMMA RAY
~ASCII LOG DATA
 1640.0   55.21
 1641.0   62.88
 1642.0   49.77
 1643.0   57.30
""")


def _las_unknown_unit():
    """Return a LASFile whose depth index uses an unrecognised unit."""
    return las_rs.read("""\
~VERSION INFORMATION
 VERS.   2.0 : LAS VERSION 2.0
 WRAP.    NO : ONE LINE PER DEPTH STEP
~WELL INFORMATION
 STRT.FATH  100.0 : START DEPTH
 STOP.FATH  102.0 : STOP DEPTH
 STEP.FATH    1.0 : STEP VALUE
 NULL.    -999.25 : NULL VALUE
 COMP.  ABYSSAL SURVEYS : COMPANY
 WELL.  SEAMOUNT-1 #3   : WELL NAME
~CURVE INFORMATION
 DEPT.FATH  : MEASURED DEPTH
 GR  .GAPI  : GAMMA RAY
~ASCII LOG DATA
 100.0   27.44
 101.0   31.19
 102.0   29.88
""")


# Conversion constant
_FT_PER_M = 1.0 / 0.3048   # metres → feet
_M_PER_FT = 0.3048          # feet   → metres


# ===========================================================================
# index_unit detection
# ===========================================================================


@pytest.mark.xfail(reason="not yet implemented")
def test_index_unit_meters():
    """A file with STRT.M in the well section has las.index_unit == 'M'."""
    las = _las_meters()
    assert las.index_unit == "M"


@pytest.mark.xfail(reason="not yet implemented")
def test_index_unit_feet():
    """A file with STRT.FT in the well section has las.index_unit == 'FT'."""
    las = _las_feet()
    assert las.index_unit == "FT"


@pytest.mark.xfail(reason="not yet implemented")
def test_index_unit_none():
    """A file with an unrecognised depth unit (e.g. FATH) has
    las.index_unit == None."""
    las = _las_unknown_unit()
    assert las.index_unit is None


# ===========================================================================
# depth_m — metre output
# ===========================================================================


@pytest.mark.xfail(reason="not yet implemented")
def test_depth_m_from_meters():
    """depth_m on a metric file returns the index values unchanged."""
    las = _las_meters()
    expected = las.curves["DEPT"].data
    np.testing.assert_array_almost_equal(las.depth_m, expected)


@pytest.mark.xfail(reason="not yet implemented")
def test_depth_m_from_feet():
    """depth_m on a feet-indexed file returns values converted by * 0.3048."""
    las = _las_feet()
    depth_ft = las.curves["DEPT"].data
    expected_m = depth_ft * _M_PER_FT
    np.testing.assert_array_almost_equal(las.depth_m, expected_m, decimal=4)


# ===========================================================================
# depth_ft — feet output
# ===========================================================================


@pytest.mark.xfail(reason="not yet implemented")
def test_depth_ft_from_feet():
    """depth_ft on a feet-indexed file returns the index values unchanged."""
    las = _las_feet()
    expected = las.curves["DEPT"].data
    np.testing.assert_array_almost_equal(las.depth_ft, expected)


@pytest.mark.xfail(reason="not yet implemented")
def test_depth_ft_from_meters():
    """depth_ft on a metric file returns values converted by / 0.3048."""
    las = _las_meters()
    depth_m = las.curves["DEPT"].data
    expected_ft = depth_m * _FT_PER_M
    np.testing.assert_array_almost_equal(las.depth_ft, expected_ft, decimal=4)


# ===========================================================================
# Error on unknown unit
# ===========================================================================


@pytest.mark.xfail(reason="not yet implemented")
def test_depth_unknown_raises():
    """Calling depth_m on a LASFile with an unrecognised depth unit raises
    las_rs.LASUnknownUnitError (or a subclass of Exception)."""
    las = _las_unknown_unit()
    with pytest.raises((las_rs.LASUnknownUnitError, Exception)):
        _ = las.depth_m


# ===========================================================================
# index_unit override at read time
# ===========================================================================


@pytest.mark.xfail(reason="not yet implemented")
def test_force_index_unit():
    """Passing index_unit='m' to las_rs.read() overrides the auto-detected
    unit; las.index_unit should reflect the forced value."""
    # Read the feet file but force the unit to metres.
    las = las_rs.read("""\
~VERSION INFORMATION
 VERS.   2.0 : LAS VERSION 2.0
 WRAP.    NO : ONE LINE PER DEPTH STEP
~WELL INFORMATION
 STRT.FT  5000.0 : START DEPTH
 STOP.FT  5002.0 : STOP DEPTH
 STEP.FT     1.0 : STEP VALUE
 NULL.   -999.25 : NULL VALUE
 COMP.  SUMMIT DRILLING : COMPANY
 WELL.  HIGHPEAK-2 #1  : WELL NAME
~CURVE INFORMATION
 DEPT.FT   : MEASURED DEPTH
 GR  .GAPI : GAMMA RAY
~ASCII LOG DATA
 5000.0   44.10
 5001.0   52.37
 5002.0   48.95
""", index_unit="m")
    # The forced unit should be stored (case-insensitive comparison)
    assert las.index_unit is not None
    assert las.index_unit.lower() == "m"