schemas.rst

Input Schemas

Input File Structure Schema

Input file files are organized as shown in the input file structure schema. Schemas for the objects referenced are shown below.

Schema properties shown in bold are required.

.. jsonschema:: ../ghedesigner/schemas/file_structure.schema.json

Borehole Input Schema

.. jsonschema:: ../ghedesigner/schemas/borehole.schema.json

Design Input Schema

.. jsonschema:: ../ghedesigner/schemas/design.schema.json

Fluid Input Schema

.. jsonschema:: ../ghedesigner/schemas/fluid.schema.json

Geometric Constraint Input Schemas

Input schemas for the geometric constraints are shown below. Each respective schema will describes how to each design method is applied.

Near-Square

.. jsonschema:: ../ghedesigner/schemas/geometric_near_square.schema.json

Rectangle

.. jsonschema:: ../ghedesigner/schemas/geometric_rectangle.schema.json

Bi-Rectangle

.. jsonschema:: ../ghedesigner/schemas/geometric_bi_rectangle.schema.json

Bi-Zoned Rectangle

.. jsonschema:: ../ghedesigner/schemas/geometric_bi_zoned_rectangle.schema.json

Bi-Rectangle Constrained

.. jsonschema:: ../ghedesigner/schemas/geometric_bi_rectangle_constrained.schema.json

Rowwise

.. jsonschema:: ../ghedesigner/schemas/geometric_rowwise.schema.json

Grout Input Schema

.. jsonschema:: ../ghedesigner/schemas/grout.schema.json

Loads Input Schema

.. jsonschema:: ../ghedesigner/schemas/loads.schema.json

Pipe Input Schemas

Input schemas for different pipe types are shown below.

Coaxial

.. jsonschema:: ../ghedesigner/schemas/pipe_coaxial.schema.json

Single U-tube, Double U-tube

.. jsonschema:: ../ghedesigner/schemas/pipe_single_double_u_tube.schema.json

Simulation Input Schema

.. jsonschema:: ../ghedesigner/schemas/simulation.schema.json

Soil Input Schema

.. jsonschema:: ../ghedesigner/schemas/soil.schema.json