pyTRSplat

pyTRSplat (imported as pytrsplat) is a library for generating customizable land plat images from Public Land Survey System (PLSS) land descriptions (or “legal descriptions”).

Also check out the pyTRS library, which handles parsing the land descriptions. You may want to reference the pyTRS quickstart guide to see how the parsing works, and in particular the config parameters.

Feel free to reach out via my GitHub with feedback or inquiries, or to let me know if you run into any issues.

Bird’s-Eye View

import pytrsplat

To plat a single township, use a Plat.

To plat multiple townships on a single page, use a MegaPlat. (The example image above is a MegaPlat.)

To plat multiple townships, each on its own page, use a PlatGroup.

(Example images are available in each link.)

Table of Contents

• Quickstart
  • Typical Workflow
  • Example Code

These classes are types of plats:

• Plat
  • Example Image
  • Example Code
  • Methods and Attributes
    • Plat
      • Plat.__init__()
      • Plat.add_description()
      • Plat.add_tract()
      • Plat.add_tracts()
      • Plat.carve_description()
      • Plat.carve_tract()
      • Plat.carve_tracts()
      • Plat.clear_layer_carveouts()
      • Plat.clear_layer_queue()
      • Plat.execute_queue()
      • Plat.find_undefined_lots()
      • Plat.find_unplattable_tracts()
      • Plat.output()
      • Plat.prompt_define()
      • Plat.write_footer_text()
      • Plat.write_header()
      • Plat.write_lot_numbers()
      • Plat.write_tracts()
• MegaPlat
  • Example Image
  • Example Code
  • Methods and Attributes
    • MegaPlat
      • MegaPlat.__init__()
      • MegaPlat.add_description()
      • MegaPlat.add_tract()
      • MegaPlat.add_tracts()
      • MegaPlat.carve_description()
      • MegaPlat.carve_tract()
      • MegaPlat.carve_tracts()
      • MegaPlat.clear_layer_carveouts()
      • MegaPlat.clear_layer_queue()
      • MegaPlat.execute_queue()
      • MegaPlat.find_undefined_lots()
      • MegaPlat.find_unplattable_tracts()
      • MegaPlat.output()
      • MegaPlat.prompt_define()
      • MegaPlat.write_lot_numbers()
• PlatGroup
  • Example Images
  • Example Code
  • Methods and Attributes
    • PlatGroup
      • PlatGroup.__init__()
      • PlatGroup.add_description()
      • PlatGroup.add_tract()
      • PlatGroup.add_tracts()
      • PlatGroup.carve_description()
      • PlatGroup.carve_tract()
      • PlatGroup.carve_tracts()
      • PlatGroup.clear_layer_carveouts()
      • PlatGroup.clear_layer_queue()
      • PlatGroup.execute_queue()
      • PlatGroup.find_undefined_lots()
      • PlatGroup.find_unplattable_tracts()
      • PlatGroup.output()
      • PlatGroup.prompt_define()
      • PlatGroup.write_lot_numbers()

These classes contribute to the behavior and/or appearance of the plats.

• Settings
  • Example Code
    • Settings
      • Settings.from_dict()
      • Settings.from_json()
      • Settings.list_presets()
      • Settings.preset()
      • Settings.restore_default()
      • Settings.restore_presets()
      • Settings.save_preset()
      • Settings.set_font()
      • Settings.set_layer_fill()
      • Settings.to_dict()
      • Settings.to_json()
• LotDefiner
  • Default lots
  • Defining lots in .csv
  • Defining lots in code
  • Defining lots manually in console
  • Undefined Lots
  • Methods and Attributes
    • LotDefiner
      • LotDefiner.__init__()
      • LotDefiner.convert_lots()
      • LotDefiner.defaults()
      • LotDefiner.define_lot()
      • LotDefiner.find_undefined_lots()
      • LotDefiner.from_csv()
      • LotDefiner.get_all_definitions()
      • LotDefiner.process_tract()
      • LotDefiner.process_tracts()
      • LotDefiner.prompt_define()
      • LotDefiner.read_csv()
      • LotDefiner.save_to_csv()

These are custom warnings (subclasses of UserWarning):

• Custom Warnings
  • PlatWarning
  • UndefinedLotWarning
  • UnplattableWarning

These are guides to using multiple layers:

• Using Multiple Layers
  • Example Image
  • Example Code
  • Output layer order
• Using Carve-Outs
  • Example Code
  • Example Code (multiple layers)