Skip to main content

a schedule parser for standard style input data files.

Project description

schedule_reader

A set of functions to read eclipse format DATA file and include files and extract well data from SCHEDULE section; like WELSPECS, COMPDAT, WCONHIST, WCONPROD or WLIST keywords.

Using the following functions, the corresponding keywords are recognized and the corresponding parameters names are set as columns labels:

  • DATES and TSTEP with dates2df (TSTEP are transformed into the corresponding datetime)
  • DATES bounds with get_start_date and get_end_date
  • WELSPECS with welspec2df
  • COMPDAT with compdat2df
  • WCONHIST with wconhist2df
  • WCONPROD with wconprod2df
  • WCONINJH with wconinjh2df
  • WCONINJE with wconinje2df
  • WLIST with wlist2df

These functions must be provided with the path to .DATA file or include file as argument.
Any other SCHEDULE section keyword can be extracted, but the columns will not be labelled, using the function keyword2df providing the path to the file and requested keyword as arguments.

Returns a DataFrame with the extracted data, associated to its respective date from DATES keyword.

Release 0.7.21 (2026-05-09)

  • Refactored keyword matching logic to use exact matching via _keyword() instead of string prefix matching.
    • Fixed critical bug where TSTEPCRIT was incorrectly routed to TSTEP handler due to prefix collision.
    • Eliminated potential prefix collision issues with other keywords (TIME, DATES, COMPDAT, WELSPEC*, WCON*, etc.).
  • Improved parser robustness through consistent exact keyword matching.

Release 0.7.20 (2026-05-09)

  • Normalized dates2df() to always return a pandas DataFrame.
  • Normalized get_start_date() and get_end_date() to always return pandas.Timestamp (or None).

Release 0.7.19 (2026-05-09)

  • Added shape-based skip handling for ECHELON SCHEDULE keywords (COLORING, SOLVER, TSTEPCRIT, TUNINGDP, TUNING, EXPTSOLV).
  • Improved block keyword termination handling to respect slash-terminated records with inline comments.
  • Fixed TUNING parsing so all three records are captured correctly across continuation lines.

Release 0.7.17 (2026-05-09)

  • Fixed Python 3.7 compatibility in file path handling.
  • Fixed a TUNING keyword membership bug caused by a one-item tuple typo.
  • Declared the pandas dependency explicitly in package metadata.
  • Added Python 3.12, 3.13, and 3.14 classifiers.
  • Added a public get_end_date helper and documented the date helper API.

Release 0.7.16 (2026-05-03)

  • Fixed TSTEP date conversion to use cumulative increments.
  • Fixed parsing issues in WELSPECL and WELLSPEC records.
  • Improved robustness for SKIP blocks, EOF handling, and inline comment parsing.
  • Fixed COMPDAT/COMPDATL default I/J resolution and several keyword-table None guards.
  • Improved VFPINJ parsing initialization and general parser stability.

To install this package:

Install it from the pypi.org repository:
pip install schedule-reader
or upgrade to the latest version:
pip install --upgrade schedule-reader

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schedule_reader-0.7.21.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schedule_reader-0.7.21-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file schedule_reader-0.7.21.tar.gz.

File metadata

  • Download URL: schedule_reader-0.7.21.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for schedule_reader-0.7.21.tar.gz
Algorithm Hash digest
SHA256 7d42b488e8a8a4e4a5e7d70fad99d02db2aad1cfc62ca93a6fc9dc919e1d7ba2
MD5 8ec93bc751663ed7697c899a7ff46830
BLAKE2b-256 d4827d5ee0c273f3120a1779e62a7f3b086f0d649501be555edeb116b69fa8d0

See more details on using hashes here.

File details

Details for the file schedule_reader-0.7.21-py3-none-any.whl.

File metadata

File hashes

Hashes for schedule_reader-0.7.21-py3-none-any.whl
Algorithm Hash digest
SHA256 5ff890e393e83fd897ddb376a314768985c86542f2104a51680576ecb50ec71e
MD5 60a687ca06ab054e729983c07921caf5
BLAKE2b-256 d2603bcf582323094e9ad1093eaef9fb9396f4f5fb5c9a6637e71dd9732c6d5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page