well_parser

Parsing the Texas RRC data on wells

Pure Nim score 15/100 · tests present · no docs generated

Summary

Latest Version 0.2.1
License GPL-3.0
CI Status Failing
Downloads 0
Last Indexed 2026-08-07 05:29

Tags

Texas Railroad Commission Drilling Permits Injection wells

Authors

  • Empower, LLC

Installation

nimble install well_parser
choosenim install well_parser
git clone https://codeberg.org/samsamros/RRC-permits

OS Compatibility

Platform Linux macOS Windows FreeBSD OpenBSD NetBSD Android iOS WASM Embedded
well_parser ✓ ✓ ✓ - - - - - - -

Dependencies

Package Version Optional
nim >= 2.0 No
anonimongo >= 0.7.2 No

Source

Repository https://codeberg.org/samsamros/RRC-permits
Homepage https://codeberg.org/samsamros/RRC-permits
Registry Source nimble_official

README

Well parser

image

About

This project is intended to parse Texas Railroad Commission data provided in an unsuitable and non-transparent format. As of January 2024, this code is able to parse Drilling Permit Master and Trailer (Includes Latitudes and Longitudes) and Underground Injection Control Data

Future development of other datasets is not guaranteed due to time constraints.

Installation

You can install this by downloading the git, cd'ing to it and running

nimble install

or, when available through the Nim repository:

nimble install well_parser

Usage

You can either convert the data to json format or insert the data in MongoDB.

Drilling Permits

For drilling permits you can convert the data to json with the following code:

let jsonConversion = getDrillingData("/path/drilling_wells/daf420.dat.11-30-2023")
# and save file
jsonConversion.writeJson("/path/output.json")

To insert data to a MongoDb collection the following example may be used:

import well_parser, anonimongo, asyncdispatch

const 
    pathToFile = "/path/drilling_wells/daf420.dat.11-30-2023"
    URI = "mongodb://localhost:27017/"

var
   mongoDB = newMongo[AsyncSocket](MongoUri URI)
   localdb = mongoDB["texas-ccs"]
   col = localdb["drilling-permits"]
   iteration = 0

assert waitFor mongoDB.connect 
let s = getDrillingDataMongo(pathToFile)
for stuff in s:
    try:
        let insertM = waitFor col.insert(@[stuff])
        if not insertM.success:
            echo "Something went wrong!"
            break
    except MongoError:
        echo stuff
        quit()

If you require authentication, please refer to Anonimongo's documentation.

Injection wells

For Underground Injection Control Data converting to json differs slightly. As the file is one big flat file, json files are divided into chunks:

let sizeOfChunk = 500
getInjectionData("/path/to/uif700a.txt", "/directory/output/, sizeOfChunk)

this will create several jsons with a size of 500 elements.

To insert documents to MongoDB for the first time:

import well_parser, anonimongo, asyncdispatch

const 
    pathToFile = "/media/steamgames/uif700a.txt"
    URI = "mongodb://localhost:27017/"

var
   mongoDB = newMongo[AsyncSocket](MongoUri URI)
   localdb = mongoDB["texas-ccs"]
   col = localdb["injection-wells"]

assert waitFor mongoDB.connect
col.getInjectionDataMongo(pathToFile, false)

This will parse the entire file and insert every single injection well. If users wish to only update the collection the final argument of the getInjectionDataMongo proc needs to be changed to:

...
col.getInjectionDataMongo(pathToFile, true)

This will still traverse the entire file, but only insert new documents.