Skip to content

Commit 37dd9a3

Browse files
JamesPImesJamesPImes
committed
add new .aliquots (etc.) to guide
1 parent 0a31483 commit 37dd9a3

1 file changed

Lines changed: 35 additions & 30 deletions

File tree

‎guides/guides/tract_attributes.md‎

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,40 @@
22

33
Access these `Tract` attributes directly, or [compile them in bulk](extracting_data.md#extracting-bulk) with various methods.
44

5-
| Attribute | Explanation | Possible Type(s) | Footnote |
6-
|:------------------|:----------------------------------------------------------------------------------------------|-----------------------------------|:--------:|
7-
| `.trs` | The Twp/Rge/Sec combination in [the standard pyTRS format](trs.md#standard) | str | 1, 5 |
8-
| `.twp` | Twp portion of `.trs` | str | 1, 5 |
9-
| `.twp_num` | Twp portion of `.trs` (without N/S), as an int or None | int, None | 5 |
10-
| `.twp_ns` | N/S portion of `.trs`, as a str or None | str, None | 5 |
11-
| `.rge` | Rge portion of `.trs` | str | 1, 5 |
12-
| `.rge_num` | Rge portion of `.trs` (without E/W), as an int or None | int, None | 5 |
13-
| `.rge_ew` | E/W portion of `.trs`, as a str or None | str, None | 5 |
14-
| `.twprge` | Twp/Rge portion of `.trs` | str | 1, 5 |
15-
| `.sec` | Section portion of `.trs`, as a str | str | 1, 5 |
16-
| `.sec_num` | Section portion of `.trs`, as an int or None | int, None | 5 |
17-
| `.desc` | the description block of the land __within__ this Twp/Rge/Sec | str | |
18-
| `.qqs` | list of identified aliquots | list of strings | 2 |
19-
| `.aliquots_whole` | identified whole aliquots (not broken down to QQs) | list of strings | 2 |
20-
| `.lots` | list of identified lots | list of strings | 2 |
21-
| `.ilots` | list of identified lots, as integers | list of ints | 2 |
22-
| `.lots_qqs` | list of identified lots and aliquots | list of strings | 2 |
23-
| `.lot_acres` | identified lots and their purported gross acreages | dict of {str: str} | 2 |
24-
| `.pp_desc` | the preprocessed description | str | |
25-
| `.source` | user-specified source of the data that was parsed <br> (specify `source=<any value>` at init) | (any) | |
26-
| `.orig_desc` | The full, original text of the parent `PLSSDesc` object, if any. | str, None | |
27-
| `.orig_index` | order in which this `Tract` object was created in parent `PLSSDesc` | int | |
28-
| `.w_flags` | a list of warning flags | list of strings | 3 |
29-
| `.w_flag_lines` | list of 2-tuples (warning flags, and their context) | list of tuples | 3 |
30-
| `.e_flags` | a list of error flags | list of strings | 3 |
31-
| `.e_flag_lines` | list of 2-tuples (error flags, and their context) | list of tuples | 3 |
32-
| `.flags` | a list of warning + error flags | list of strings | 3 |
33-
| `.flag_lines` | list of 2-tuples (warning + error flags, and their context) | list of tuples | 3 |
34-
| `.desc_is_flawed` | If a fatal flaw was found during parsing of parent `PLSSDesc` | bool | 4 |
5+
| Attribute | Explanation | Possible Type(s) | Footnote |
6+
|:--------------------------|:---------------------------------------------------------------------------------------------------|-----------------------------------|:--------:|
7+
| `.trs` | The Twp/Rge/Sec combination in [the standard pyTRS format](trs.md#standard) | str | 1, 5 |
8+
| `.twp` | Twp portion of `.trs` | str | 1, 5 |
9+
| `.twp_num` | Twp portion of `.trs` (without N/S), as an int or None | int, None | 5 |
10+
| `.twp_ns` | N/S portion of `.trs`, as a str or None | str, None | 5 |
11+
| `.rge` | Rge portion of `.trs` | str | 1, 5 |
12+
| `.rge_num` | Rge portion of `.trs` (without E/W), as an int or None | int, None | 5 |
13+
| `.rge_ew` | E/W portion of `.trs`, as a str or None | str, None | 5 |
14+
| `.twprge` | Twp/Rge portion of `.trs` | str | 1, 5 |
15+
| `.sec` | Section portion of `.trs`, as a str | str | 1, 5 |
16+
| `.sec_num` | Section portion of `.trs`, as an int or None | int, None | 5 |
17+
| `.desc` | the description block of the land __within__ this Twp/Rge/Sec | str | |
18+
| `.qqs` | list of identified aliquots (broken down to QQ, or smaller) | list of strings | 2 |
19+
| `.aliquots` | list of __reconstructed__ aliquots | list of strings | 2, 6 |
20+
| `.aliquots_standard` | list of __reconstructed__ aliquots, assuming this is a <br> 'standard' section | list of strings | 2, 6 |
21+
| `.aliquots_whole` | identified whole aliquots (not broken down to QQs) | list of strings | 2, 6 |
22+
| `.lots` | list of identified lots | list of strings | 2 |
23+
| `.ilots` | list of identified lots, as integers | list of ints | 2 |
24+
| `.lots_qqs` | list of identified lots and aliquots (QQs) | list of strings | 2 |
25+
| `.lots_aliquots` | list of identified lots and __reconstructed__ aliquots | list of strings | 2 |
26+
| `.lots_aliquots_standard` | list of identified lots and __reconstructed__ aliquots, <br> assuming this is a 'standard' section | list of strings | 2 |
27+
| `.lot_acres` | identified lots and their purported gross acreages | dict of {str: str} | 2 |
28+
| `.pp_desc` | the preprocessed description | str | |
29+
| `.source` | user-specified source of the data that was parsed <br> (specify `source=<any value>` at init) | (any) | |
30+
| `.orig_desc` | The full, original text of the parent `PLSSDesc` object, if any. | str, None | |
31+
| `.orig_index` | order in which this `Tract` object was created in parent `PLSSDesc` | int | |
32+
| `.w_flags` | a list of warning flags | list of strings | 3 |
33+
| `.w_flag_lines` | list of 2-tuples (warning flags, and their context) | list of tuples | 3 |
34+
| `.e_flags` | a list of error flags | list of strings | 3 |
35+
| `.e_flag_lines` | list of 2-tuples (error flags, and their context) | list of tuples | 3 |
36+
| `.flags` | a list of warning + error flags | list of strings | 3 |
37+
| `.flag_lines` | list of 2-tuples (warning + error flags, and their context) | list of tuples | 3 |
38+
| `.desc_is_flawed` | If a fatal flaw was found during parsing of parent `PLSSDesc` | bool | 4 |
3539

3640
Footnotes:
3741
1) The [standard pyTRS format for Twp/Rge/Sec](trs.md#standard) is up to 3 digits for Twp (plus `'n'` or `'s'`) and for Rge (plus `'e'` or `'w'`), and exactly two digits for section. (Examples: `Sec 14 of T154N-R97W` -> `'154n97w14'`; and `Sec 1 of T7S-R9E` -> `'7s9e01'`)
@@ -44,3 +48,4 @@ Footnotes:
4448

4549
5) [*Setting* the `.trs` attribute](tract.md#setting-trs) of a `Tract` object will populate the other associated attributes accordingly (`.twp`, `.rge`, `.sec`, etc. -- which cannot be set directly).
4650

51+
6) `.aliquots`, `.aliquots_standard`, `.lots_aliquots`, and `.lots_aliquot_standard` all combine the parsed QQs into larger aliquots, such as `['NENE', 'NWNE', 'SWNE']` into `['N2NE', 'SWNE']`. Conversely, note that `.aliquots_whole` instead shows the aliquots that were identified by the parser in the __original__ description. Finally, note that `.aliquots` and `.lots_aliquots` will __not__ assume that this is a standard section (i.e., they will never combine the aliquots into `'ALL'`), whereas `.aliquots_standard` and `.lots_aliquots_standard` __can__ combine QQs into `'ALL'` where appropriate.

0 commit comments

Comments
 (0)