j-c-cook / gfunctiondatabase Goto Github PK

For clarity on what this package is, the library is to be renamed to a database. Quoting wikipedia: "Because of the close relationship between them, the term "database" is often used casually to refer to both a database and the DBMS used to manipulate it."

Python has a unit testing framework (unittest). The goal is to set this library up with unittests that run on a local pipeline.

A g-function library guide was pulled together by mainly Timothy West and Dr. Spitler. The guide gives an overview of many of the technicalities of this Python package.

How it is possible to recall a g-function stored in the library for a specific configuration?

This function takes in a configuration string argument, loads the specified database configuration file into memory and returns the entire file as a dictionary.

The C and LopU configurations were thought up for the development of the zoned rectangular algorithm. The L configurations need added in. Functions for accessing are necessary.

Create a read_file function that can handle json, xlsx and csv.

Here's a tutorial on how to us lfs-folderstore to host a git-lfs server through dropbox:

https://weirdbearddev.com/resources/learning/configuring-git-lfs-to-use-dropbox/

The g-function library guide v1.0 contains a table that would be good to have in the README file.

The function should return the file paths of all of the configurations available in the database.

It looks like the Nx, Ny, Nix, Niy gets confused for the query of the zoned rectangle library. That or the library has an error.

Take in the style, field parameters, numbers of boreholes in directions and then provide coordinates and easy plotting access.

Adds additional functionality to coordinate generation. Including nogo zones with S,L,T,U, and backwards L shapes. Generates trapezoidal fields (w/ rects and triangles represented as special trapezoids) with nogo zones that can be rotated and modifying spacing in order to maximize space usage.

It looks like the rectangular and zoned rectangle library may have its coordinates transposed from what is desired. The x and y locations can be swapped without any change in what the g-function would be. This is mainly for plotting purposes once a design has been procured.

The U configurations file seemed a bit limited. There were many NxM layouts that did not have a single layer of thickness, but rather solely had double and triple. This update seeks to flesh out the missing configurations.

When a configuration is accessed in the database, the dictionary returned is unimodal for the configurations that have multiple layers. The zoned rectangle is not stored in the database in a unimodal order, so it needed to be sorted.

The need for a library like this would not have been known to myself without the DOE contract DE-AC05-00OR22725. The library would not have been pheasant without the development of cpgfunction which was funded by Dr. Spitler (the OG&E Energy Technology Chair.

The repository was previously named gFunctionLibrary. The documentation needs to be setup to build the gFunctionDatabase.

The C configurations have multiple layers. There are thicknesses from 1-3.

This object serves as the base object for several of the g-function database management modules. The two instances of this object define the number of json levels and the number of keys used on each level.