Skip to main content

A library to read, write, and check AGS4 files using Pandas DataFrames

Project description

python-ags4

[[TOC]]

Introduction

python-ags4 is a library of functions that

  • imports/reads AGS4 files to a collection of Pandas DataFrames.
  • data can be analyzed, manipulated, and updated using Pandas
  • and then exported/written back to an AGS4 file

Release available at pypi.org/project/python-ags4/

This project is maintained by the AGS Data Format Working Group

Note This repo was forked from github.com/asitha-sena/python-ags4 which is now archived and read-only

HEAD is gitlab.com/ags-data-format-wg/ags-python-library

Documentation

Juypter Notebook

We have created an example Juypter Notebook which imports an AGS file, plots boreholes on a map and creates a Striplog.

See here

Installation

pip install python-ags4

Code Examples

first import the module

from python_ags4 import AGS4

Import data from an AG4 file:

tables, headings = AGS4.AGS4_to_dataframe('/home/asitha/Projects/python-AGS4/tests/test_data.ags')
  • tables is a dictionary of Pandas DataFrames. Each DataFrame contains the data from a GROUP in the AGS4 file.
  • headings is a dictionary of lists. Each list has the header names of the corresponding GROUP

All data are imported as text so they cannot be analyzed or plotted immediately. You can use the following code to convert all the numerical data in a DataFrame from text to numeric.

LOCA = AGS4.convert_to_numeric(tables['LOCA'])

The AGS4.convert_to_numeric() function automatically converts all columns in the input DataFrame with the a numeric TYPE to a float. (Note: The UNIT and TYPE rows are removed during this operation as they are non-numeric.)

Export data back to an AGS4 file:

AGS4.dataframe_to_AGS4(tables, headings, '/home/asitha/Documents/output.ags')

A DataFrame with numeric columns may not get exported with the correct precision so they should be converted back to formatted text. The AGS4.convert_to_text() function will do this automatically if an AGS4 dictionary file is provided with the necessary UNIT and TYPE information. Numeric fields in the DataFrame that are not described in the dictionary file will be skipped with a warning.

LOCA_txt = AGS4.convert_to_text(LOCA, 'DICT.ags')

Tables converted to numeric using the AGS4.convert_to_numeric() function should always be converted back to text before exporting to an AGS4 file. (Note: The UNIT and TYPE rows will be added back in addition to formatting the numeric columns.)

Command Line Interface

A cli tool was added in version 0.2.0. It should be available from the terminal (or on the Anaconda Powershell prompt in Windows) after running python pip install python-ags4>=0.2.0

It does not yet have the full functionality of the library, but it does provide a quick and easy way to convert .ags files to Excel spreadsheets (.xlsx) and back. The data can be easily edited in a spreadsheet and then converted back a .ags file. The TYPE values for numeric columns can be changed in the spreadsheet and the data will be automatically reformatted correctly when converted back to .ags, as long as all values in a column are numbers. Any supposedly numeric columns with text entries will be skipped with a warning message.

(Note: All data is imported to the spreadsheet as text entries so any column that should be reformatted should be explicitly converted to numbers in Excel.)

asciicast

A checking tool is available as of version 0.3.0 and it can be used to make sure that the file conforms to the AGS4 rules. The tool has been tested in both bash and Powershell.

asciicast

Graphical User Interface using pandasgui

The output from python-ags4 can be directly used with pandasgui to view and edit AGS4 files using an interactive graphical user interface. It also provides funtionality to plot and visualize the data.

from pandasgui import show

tables, headings = AGS4.AGS4_to_dataframe('/home/asitha/Projects/python-AGS4/tests/test_data.ags')
gui = show(**tables)

Any edits made in the GUI can be saved and exported back to an AGS4 file as follows:

updated_tables = gui.get_dataframes()

AGS4.dataframe_to_AGS4(updated_tables, headings, '/home/asitha/Documents/output.ags')

Development

Please refer to the Wiki page for details about the development environment and how to get involved in the project.

Implementations

This library has been used to create

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

python-AGS4-0.4.0.tar.gz (228.1 kB view details)

Uploaded Source

Built Distribution

python_AGS4-0.4.0-py3-none-any.whl (234.8 kB view details)

Uploaded Python 3

File details

Details for the file python-AGS4-0.4.0.tar.gz.

File metadata

  • Download URL: python-AGS4-0.4.0.tar.gz
  • Upload date:
  • Size: 228.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.9 CPython/3.8.5 Linux/5.13.0-51-generic

File hashes

Hashes for python-AGS4-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a2a74be3c6ad8a3b349510483956f5965481c84456b881ae6cfdcc6b7dd81506
MD5 49c3243aee96cf88c58a2f546962b552
BLAKE2b-256 23e2d421144a42f44919d1a8673644cd19cb09ef5c22b6d02c73c28d3a62d77b

See more details on using hashes here.

File details

Details for the file python_AGS4-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: python_AGS4-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 234.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.9 CPython/3.8.5 Linux/5.13.0-51-generic

File hashes

Hashes for python_AGS4-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ddb9d46048b1cd4ce0ecf0bc0f61de9488e929459e4900217da3fac5b84da14
MD5 ba8c722c77de60108e6222d21e5c2b42
BLAKE2b-256 b035107457908330883547a8aed7c553ae21b2cabce6ffef2d112cd32be5d6d5

See more details on using hashes here.

Supported by

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