Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ described in [LIBRARY_MERGE_PLAN.md](LIBRARY_MERGE_PLAN.md) is **complete**: eve
function identified as a duplicate now delegates to petrolib while keeping its historical
name, signature, and — bit for bit — its published numeric output.

- **Docs:** [docs/petrolib.md](docs/petrolib.md) (guide) and
[docs/petrolib-api.md](docs/petrolib-api.md) (generated API reference);
- **Docs:** [docs/petrolib.md](docs/petrolib.md) (guide),
[docs/petrolib-api.md](docs/petrolib-api.md) (generated API reference), and the
[Petrophysics Handbook](docs/Petrophysics_Handbook.pdf) (PDF user manual — every function
with purpose, parameters, and full journal sources);
[CONVENTIONS.md](CONVENTIONS.md) has the API rules.
- Running article scripts needs **no install step** — every directory keeps working from
a bare clone (`cd src2019_06 && python test_all.py`).
Expand Down
Binary file added docs/Petrophysics_Handbook.pdf
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/petrolib.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,13 @@ ends with a *References* section resolving those tags to complete SPWLA
*Petrophysics* citations (title, authors, year, volume/issue/pages, DOI).
`help(petrolib.<module>)` therefore shows the full bibliography of a domain.

For a print-ready reference, the **Petrophysics Handbook**
([Petrophysics_Handbook.pdf](Petrophysics_Handbook.pdf)) documents every
public function alphabetically — purpose, input parameters, output, and full
journal sources — and is regenerated with
`python tools/gen_petrolib_handbook.py` (needs `pip install reportlab`, or
`pip install -e ".[docs]"`).

## Testing and regression gates

```bash
Expand Down
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ image = ["scikit-image>=0.21"]
# Everything the 75 issue directories collectively need.
articles = ["spwla-petrolib[scipy,ml,torch,image]"]
dev = ["pytest>=7", "pytest-xdist", "ruff", "mypy"]
# PDF handbook generator (tools/gen_petrolib_handbook.py).
docs = ["reportlab>=4"]

[tool.hatch.build.targets.wheel]
# Only the library is packaged; the 75 srcYYYY_MM issue directories stay
Expand Down
Loading
Loading