compass-lib 0.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env python
2
+
3
+ import importlib.metadata
4
+
5
+ __version__ = importlib.metadata.version("compass_lib")
@@ -0,0 +1 @@
1
+ #!/usr/bin/env python
@@ -0,0 +1,56 @@
1
+ # #!/usr/bin/env python3
2
+
3
+ import argparse
4
+ from pathlib import Path
5
+
6
+ from compass_lib.parser import CompassParser
7
+
8
+
9
+ def convert(args: list[str]) -> int:
10
+ parser = argparse.ArgumentParser(prog="compass convert")
11
+
12
+ parser.add_argument(
13
+ "--input_file",
14
+ type=str,
15
+ default=None,
16
+ required=True,
17
+ help="Compass Survey Source File."
18
+ )
19
+
20
+ parser.add_argument(
21
+ "--output_file",
22
+ type=str,
23
+ default=None,
24
+ required=True,
25
+ help="Path to save the converted file at."
26
+ )
27
+
28
+ parser.add_argument(
29
+ "--overwrite",
30
+ action="store_true",
31
+ help="Allow overwrite an already existing file.",
32
+ default=False,
33
+ )
34
+
35
+ parser.add_argument(
36
+ "--format",
37
+ type=str,
38
+ choices=["json"],
39
+ required=True,
40
+ help="Conversion format used."
41
+ )
42
+
43
+ parsed_args = parser.parse_args(args)
44
+
45
+ dmp_file = Path(parsed_args.input_file)
46
+ if not dmp_file.exists():
47
+ raise FileNotFoundError(f"Impossible to find: `{dmp_file}`.")
48
+
49
+ output_file = Path(parsed_args.output_file)
50
+ if output_file.exists() and not parsed_args.overwrite:
51
+ raise FileExistsError(f"The file {output_file} already existing. "
52
+ "Please pass the flag `--overwrite` to ignore.")
53
+
54
+ parser = CompassParser(dmp_file)
55
+ parser.to_json(filepath=output_file)
56
+ return 0
@@ -0,0 +1,31 @@
1
+ # #!/usr/bin/env python3
2
+
3
+ import argparse
4
+ from importlib.metadata import entry_points
5
+
6
+ import compass_lib
7
+
8
+ def main():
9
+ registered_commands = entry_points(group='compass.actions')
10
+
11
+ parser = argparse.ArgumentParser(prog="compass_lib")
12
+ parser.add_argument(
13
+ "--version",
14
+ action="version",
15
+ version=f"%(prog)s version: {compass_lib.__version__}",
16
+ )
17
+ parser.add_argument(
18
+ "command",
19
+ choices=registered_commands.names,
20
+ )
21
+ parser.add_argument(
22
+ "args",
23
+ help=argparse.SUPPRESS,
24
+ nargs=argparse.REMAINDER,
25
+ )
26
+
27
+ args = argparse.Namespace()
28
+ parser.parse_args(namespace=args)
29
+
30
+ main_fn = registered_commands[args.command].load()
31
+ return main_fn(args.args)
compass_lib/enums.py ADDED
@@ -0,0 +1,112 @@
1
+ from enum import Enum
2
+
3
+ class CustomEnum(Enum):
4
+ @classmethod
5
+ def reverse(cls, name):
6
+ return cls._value2member_map_[name]
7
+
8
+ # ============================== Azimuth ============================== #
9
+
10
+ # export const azimuthUnits: { [string]: DisplayAzimuthUnit } = {
11
+ # D: 'degrees',
12
+ # Q: 'quads',
13
+ # G: 'gradians',
14
+ # }
15
+
16
+ class AzimuthUnits(CustomEnum):
17
+ DEGREES = "D"
18
+ QUADS = "Q"
19
+ GRADIANS = "G"
20
+
21
+ # ============================== Inclination Unit ============================== #
22
+
23
+ # export const inclinationUnits: { [string]: DisplayInclinationUnit } = {
24
+ # D: 'degrees',
25
+ # G: 'percentGrade',
26
+ # M: 'degreesAndMinutes',
27
+ # R: 'gradians',
28
+ # W: 'depthGauge',
29
+ # }
30
+
31
+ class InclinationUnits(CustomEnum):
32
+ DEGREES = "D"
33
+ PERCENT_GRADE = "G"
34
+ DEGREES_AND_MINUTES = "M"
35
+ GRADIANS = "R"
36
+ DEPTH_GAUGE = "W"
37
+
38
+ # ============================== Length Unit ============================== #
39
+
40
+
41
+ # export const lengthUnits: { [string]: DisplayLengthUnit } = {
42
+ # D: 'decimalFeet',
43
+ # I: 'feetAndInches',
44
+ # M: 'meters',
45
+ # }
46
+
47
+ class LengthUnits(CustomEnum):
48
+ DECIMAL_FEET = "D"
49
+ FEET_AND_INCHES = "I"
50
+ METERS = "M"
51
+
52
+ # ============================== LRUD ============================== #
53
+
54
+ # export const lrudItems: { [string]: LrudItem } = {
55
+ # L: 'left',
56
+ # R: 'right',
57
+ # U: 'up',
58
+ # D: 'down',
59
+ # }
60
+
61
+ class LRUD(CustomEnum):
62
+ LEFT = "L"
63
+ RIGHT = "R"
64
+ UP = "U"
65
+ DOWN = "D"
66
+
67
+ # ============================== ShotItem ============================== #
68
+
69
+ # export const shotMeasurementItems: { [string]: ShotMeasurementItem } = {
70
+ # L: 'length',
71
+ # A: 'frontsightAzimuth',
72
+ # D: 'frontsightInclination',
73
+ # a: 'backsightAzimuth',
74
+ # d: 'backsightInclination',
75
+ # }
76
+
77
+ class ShotItem(CustomEnum):
78
+ LENGTH = "L"
79
+ FRONTSIGHT_AZIMUTH = "A"
80
+ FRONTSIGHT_INCLINATION = "D"
81
+ BACKSIGHT_AZIMUTH = "a"
82
+ BACKSIGHT_INCLINATION = "d"
83
+
84
+ # ============================== StationSide ============================== #
85
+
86
+ # export const stationSides: { [string]: StationSide } = {
87
+ # F: 'from',
88
+ # T: 'to',
89
+ # }
90
+
91
+ class StationSide(CustomEnum):
92
+ FROM = "F"
93
+ TO = "T"
94
+
95
+
96
+ # ============================== ShotFlag ============================== #
97
+
98
+ class ShotFlag(CustomEnum):
99
+ EXCLUDE_PLOTING = "P"
100
+ EXCLUDE_CLOSURE = "C"
101
+ EXCLUDE_LENGTH = "L"
102
+ TOTAL_EXCLUSION = "X"
103
+ SPLAY = "S"
104
+
105
+ __start_token__ = r"#\|"
106
+ __end_token__ = r"#"
107
+
108
+
109
+
110
+ if __name__ == "__main__":
111
+ print(StationSide.FROM.value)
112
+ print(StationSide.reverse("F"))
compass_lib/parser.py ADDED
@@ -0,0 +1,282 @@
1
+ #!/usr/bin/env python
2
+
3
+ import re
4
+ import datetime
5
+ import hashlib
6
+ import json
7
+ from typing import Optional, Union
8
+
9
+ from pathlib import Path
10
+ from compass_lib.enums import ShotFlag
11
+
12
+ from compass_lib.section import SurveySection
13
+ from compass_lib.shot import SurveyShot
14
+
15
+ from functools import cached_property
16
+
17
+
18
+ import dataclasses
19
+ from dataclasses import dataclass
20
+
21
+ # ============================== CompassFileFormat ============================== #
22
+
23
+ # _formatFormat(): string {
24
+ # const {
25
+ # displayAzimuthUnit,
26
+ # displayLengthUnit,
27
+ # displayLrudUnit,
28
+ # displayInclinationUnit,
29
+ # lrudOrder,
30
+ # shotMeasurementOrder,
31
+ # hasBacksights,
32
+ # lrudAssociation,
33
+ # } = this
34
+ # return `${inverseAzimuthUnits[displayAzimuthUnit]}${
35
+ # inverseLengthUnits[displayLengthUnit]
36
+ # }${inverseLengthUnits[displayLrudUnit]}${
37
+ # inverseInclinationUnits[displayInclinationUnit]
38
+ # }${lrudOrder
39
+ # .map(i => inverseLrudItems[i])
40
+ # .join('')}${shotMeasurementOrder
41
+ # .map(i => inverseShotMeasurementItems[i])
42
+ # .join('')}${hasBacksights ? 'B' : 'N'}${
43
+ # lrudAssociation != null ? inverseStationSides[lrudAssociation] : ''
44
+ # }`
45
+ # }
46
+
47
+ @dataclass
48
+ class CompassFileFormat:
49
+ displayAzimuthUnit: str
50
+ displayLengthUnit: str
51
+ displayLrudUnit: str
52
+ displayInclinationUnit: str
53
+ lrudOrder: str
54
+ shotMeasurementOrder: str
55
+ hasBacksights: str
56
+ lrudAssociation: str
57
+
58
+ @classmethod
59
+ def from_str(cls, input):
60
+ return cls(
61
+ displayAzimuthUnit="",
62
+ displayLengthUnit="",
63
+ displayLrudUnit="",
64
+ displayInclinationUnit="",
65
+ lrudOrder="",
66
+ shotMeasurementOrder="",
67
+ hasBacksights="",
68
+ lrudAssociation="",
69
+ )
70
+
71
+
72
+
73
+ class EnhancedJSONEncoder(json.JSONEncoder):
74
+ def default(self, obj):
75
+
76
+ if dataclasses.is_dataclass(obj):
77
+ return dataclasses.asdict(obj)
78
+
79
+ if isinstance(obj, datetime.date):
80
+ return obj.isoformat()
81
+
82
+ if isinstance(obj, ShotFlag):
83
+ return obj.value
84
+
85
+ return super().default(obj)
86
+
87
+
88
+ class CompassParser:
89
+ SEPARATOR = "\f" # Form_feed: https://www.ascii-code.com/12
90
+ END_OF_FILE = "\x1A" # Substitute: https://www.ascii-code.com/26
91
+
92
+ def __init__(self, filepath: str) -> None:
93
+
94
+ self._filepath = Path(filepath)
95
+
96
+ if not self.filepath.is_file():
97
+ raise FileNotFoundError(f"File not found: {filepath}")
98
+
99
+ # Ensure at least that the file type is valid
100
+ _ = self._data
101
+
102
+ # =================== Data Loading =================== #
103
+
104
+ @cached_property
105
+ def _data(self):
106
+
107
+ with self.filepath.open(mode="r") as f:
108
+ data = f.read()
109
+
110
+ return [
111
+ activity.strip()
112
+ for activity in data.split(CompassParser.SEPARATOR)
113
+ if CompassParser.END_OF_FILE not in activity
114
+ ]
115
+
116
+ # =================== File Properties =================== #
117
+
118
+ def __repr__(self) -> str:
119
+ repr = f"[CompassSurveyFile {self.filetype.upper()}] `{self.filepath}`:"
120
+ # for key in self._KEY_MAP.keys():
121
+ # if key.startswith("_"):
122
+ # continue
123
+ # repr += f"\n\t- {key}: {getattr(self, key)}"
124
+ # repr += f"\n\t- shots: Total Shots: {len(self.shots)}"
125
+ # repr += f"\n\t- hash: {self.hash}"
126
+ return repr
127
+
128
+ @cached_property
129
+ def __hash__(self):
130
+ # return hashlib.sha256(self._as_binary()).hexdigest()
131
+ return hashlib.sha256("0".encode()).hexdigest()
132
+
133
+ @property
134
+ def hash(self):
135
+ return self.__hash__
136
+
137
+ # =============== Descriptive Properties =============== #
138
+
139
+ @property
140
+ def filepath(self):
141
+ return self._filepath
142
+
143
+ @property
144
+ def filetype(self):
145
+ return self.filepath.suffix[1:]
146
+ # try:
147
+ # return ArianeFileType.from_str(self.filepath.suffix[1:])
148
+ # except ValueError as e:
149
+ # raise TypeError(e) from e
150
+
151
+ @property
152
+ def lstat(self):
153
+ return self.filepath.lstat()
154
+
155
+ @property
156
+ def date_created(self):
157
+ return self.lstat.st_ctime
158
+
159
+ @property
160
+ def date_last_modified(self):
161
+ return self.lstat.st_mtime
162
+
163
+ @property
164
+ def date_last_opened(self):
165
+ return self.lstat.st_atime
166
+
167
+ # =================== Data Processing =================== #
168
+
169
+ @cached_property
170
+ def data(self):
171
+ sections = []
172
+ for activity in self._data:
173
+ entries = activity.splitlines()
174
+
175
+ cave_name = entries[0].strip()
176
+
177
+ if "SURVEY NAME: " not in entries[1]:
178
+ raise RuntimeError
179
+ survey_name = entries[1].split(":")[-1].strip()
180
+
181
+ date_str, comment_str = entries[2].split(" ", maxsplit=1)
182
+
183
+ if "SURVEY DATE: " not in date_str:
184
+ raise RuntimeError
185
+ date = date_str.split(":")[-1].strip()
186
+
187
+ if "COMMENT:" not in comment_str:
188
+ raise RuntimeError
189
+ survey_comment = comment_str.split(":")[-1].strip()
190
+
191
+ if "SURVEY TEAM:" != entries[3].strip():
192
+ raise RuntimeError
193
+
194
+ surveyors = [suveyor.strip() for suveyor in entries[4].split(",") if suveyor.strip() != ""]
195
+
196
+ if "DECLINATION:" not in entries[5]:
197
+ raise RuntimeError
198
+ if "FORMAT:" not in entries[5]:
199
+ raise RuntimeError
200
+ if "CORRECTIONS:" not in entries[5]:
201
+ raise RuntimeError
202
+
203
+ _, declination_str, _, format_str, _, correct_A, correct_B, correct_C = entries[5].split()
204
+
205
+ shots = list()
206
+ for shot in entries[9:]:
207
+ shot_data = shot.split(maxsplit=9)
208
+ from_id, to_id, length, bearing, incl, left, up, down, right = shot_data[:9]
209
+
210
+ try:
211
+ flags_comment = shot_data[9]
212
+
213
+ flag_regex = rf"({ShotFlag.__start_token__}([{''.join(ShotFlag._value2member_map_.keys())}]*){ShotFlag.__end_token__})*(.*)"
214
+ _, flag_str, comment = re.search(flag_regex, flags_comment).groups()
215
+
216
+ flags = [ShotFlag._value2member_map_[f] for f in flag_str] if flag_str else None
217
+
218
+ except IndexError:
219
+ flags = None
220
+ comment = None
221
+
222
+ shots.append(SurveyShot(
223
+ from_id=from_id,
224
+ to_id=to_id,
225
+ length=float(length),
226
+ bearing=float(bearing),
227
+ inclination=float(incl),
228
+ left=float(left),
229
+ up=float(up),
230
+ down=float(down),
231
+ right=float(right),
232
+ flags=sorted(set(flags), key=lambda f: f.value) if flags else None,
233
+ comment=comment.strip() if comment else None
234
+ ))
235
+
236
+ section = SurveySection(
237
+ cave_name=cave_name,
238
+ survey_name=survey_name,
239
+ date=datetime.datetime.strptime(date, "%m %d %Y").date(),
240
+ comment=survey_comment,
241
+ surveyors=surveyors,
242
+ declination=float(declination_str),
243
+ format=format_str,
244
+ correction=(float(correct_A), float(correct_B), float(correct_C)),
245
+ shots=shots
246
+ )
247
+ sections.append(section)
248
+
249
+ return sections
250
+
251
+
252
+ # =================== Export Formats =================== #
253
+
254
+ def to_json(self, filepath: Optional[Union[str, Path]] = None) -> str:
255
+ json_str = json.dumps(self.data, indent=4, sort_keys=True, cls=EnhancedJSONEncoder)
256
+
257
+ if filepath is not None:
258
+ with open(filepath, mode="w") as file:
259
+ file.write(json_str)
260
+
261
+ return json_str
262
+
263
+ # ==================== Public APIs ====================== #
264
+
265
+ @cached_property
266
+ def shots(self):
267
+ return []
268
+ # return [
269
+ # SurveyShot(data=survey_shot)
270
+ # for survey_shot in self._KEY_MAP.fetch(self._shots_list, "_shots")
271
+ # ]
272
+
273
+ @cached_property
274
+ def sections(self):
275
+ return []
276
+ # section_map = dict()
277
+ # for shot in self.shots:
278
+ # try:
279
+ # section_map[shot.section].add_shot(shot)
280
+ # except KeyError:
281
+ # section_map[shot.section] = SurveySection(shot=shot)
282
+ # return list(section_map.values())
compass_lib/section.py ADDED
@@ -0,0 +1,18 @@
1
+ #!/usr/bin/env python
2
+
3
+ from datetime import date
4
+ from dataclasses import dataclass
5
+ from compass_lib.shot import SurveyShot
6
+
7
+
8
+ @dataclass
9
+ class SurveySection:
10
+ cave_name: str
11
+ survey_name: str
12
+ date: date
13
+ comment: str
14
+ surveyors: list[str]
15
+ declination: float
16
+ format: str
17
+ correction: tuple[float, float, float]
18
+ shots: list[SurveyShot]
compass_lib/shot.py ADDED
@@ -0,0 +1,21 @@
1
+ #!/usr/bin/env python
2
+
3
+ from dataclasses import dataclass
4
+
5
+ from compass_lib.enums import ShotFlag
6
+
7
+ @dataclass
8
+ class SurveyShot:
9
+ # FROM TO LENGTH BEARING INC LEFT UP DOWN RIGHT FLAGS COMMENTS
10
+ # A1 A2 21.75 63.50 -28.00 2.60 2.60 2.60 2.60#
11
+ from_id: str
12
+ to_id: str
13
+ length: float
14
+ bearing: float
15
+ inclination: float
16
+ left: float
17
+ up: float
18
+ down: float
19
+ right: float
20
+ flags: list[ShotFlag]
21
+ comment: str
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,268 @@
1
+ Metadata-Version: 2.1
2
+ Name: compass_lib
3
+ Version: 0.0.1
4
+ Summary: A library to read Compass Survey files
5
+ Author-email: Jonathan Dekhtiar <jonathan@dekhtiar.com>
6
+ Maintainer-email: Jonathan Dekhtiar <jonathan@dekhtiar.com>
7
+ License: Apache License
8
+ Version 2.0, January 2004
9
+ http://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ APPENDIX: How to apply the Apache License to your work.
185
+
186
+ To apply the Apache License to your work, attach the following
187
+ boilerplate notice, with the fields enclosed by brackets "[]"
188
+ replaced with your own identifying information. (Don't include
189
+ the brackets!) The text should be enclosed in the appropriate
190
+ comment syntax for the file format. We also recommend that a
191
+ file or class name and description of purpose be included on the
192
+ same "printed page" as the copyright notice for easier
193
+ identification within third-party archives.
194
+
195
+ Copyright [yyyy] [name of copyright owner]
196
+
197
+ Licensed under the Apache License, Version 2.0 (the "License");
198
+ you may not use this file except in compliance with the License.
199
+ You may obtain a copy of the License at
200
+
201
+ http://www.apache.org/licenses/LICENSE-2.0
202
+
203
+ Unless required by applicable law or agreed to in writing, software
204
+ distributed under the License is distributed on an "AS IS" BASIS,
205
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
206
+ See the License for the specific language governing permissions and
207
+ limitations under the License.
208
+
209
+ Project-URL: Homepage, https://pypi.org/project/compass-lib/
210
+ Project-URL: Bug Reports, https://github.com/SpeleoDB/pytool_compass_lib/issues
211
+ Project-URL: Source, https://github.com/SpeleoDB/pytool_compass_lib
212
+ Keywords: cave,survey,karst
213
+ Classifier: Development Status :: 3 - Alpha
214
+ Classifier: Intended Audience :: Developers
215
+ Classifier: Intended Audience :: Science/Research
216
+ Classifier: Intended Audience :: Information Technology
217
+ Classifier: Topic :: Software Development :: Build Tools
218
+ Classifier: Topic :: Scientific/Engineering
219
+ Classifier: Topic :: Software Development :: Libraries
220
+ Classifier: Topic :: Utilities
221
+ Classifier: License :: OSI Approved :: Apache Software License
222
+ Classifier: Operating System :: OS Independent
223
+ Classifier: Programming Language :: Python :: 3
224
+ Classifier: Programming Language :: Python :: 3.8
225
+ Classifier: Programming Language :: Python :: 3.9
226
+ Classifier: Programming Language :: Python :: 3.10
227
+ Classifier: Programming Language :: Python :: 3.11
228
+ Classifier: Programming Language :: Python :: 3.12
229
+ Classifier: Programming Language :: Python :: 3 :: Only
230
+ Requires-Python: >=3.8
231
+ Description-Content-Type: text/markdown
232
+ License-File: LICENSE
233
+ Provides-Extra: dev
234
+ Requires-Dist: check-manifest ; extra == 'dev'
235
+ Requires-Dist: pre-commit <3.7,>=3.6.0 ; extra == 'dev'
236
+ Requires-Dist: ruff <0.4,>=0.3 ; extra == 'dev'
237
+ Provides-Extra: test
238
+ Requires-Dist: pytest <9.0.0,>=8.0.0 ; extra == 'test'
239
+ Requires-Dist: pytest-cov <6.0.0,>=5.0.0 ; extra == 'test'
240
+ Requires-Dist: pytest-dotenv <1.0.0,>=0.5.0 ; extra == 'test'
241
+ Requires-Dist: pytest-env <2.0.0,>=1.1.3 ; extra == 'test'
242
+ Requires-Dist: pytest-runner <7.0.0,>=6.0.0 ; extra == 'test'
243
+ Requires-Dist: pytest-ordering <1.0.0,>=0.6 ; extra == 'test'
244
+ Requires-Dist: parameterized <0.10,>=0.9.0 ; extra == 'test'
245
+
246
+ # Compass Python Lib
247
+
248
+ Short instructions
249
+
250
+ ```bash
251
+ python demo.py
252
+ ```
253
+
254
+ --------------------
255
+
256
+ ## Conversion commands:
257
+
258
+ ```bash
259
+ # Install in dev mod
260
+ pip install -e ".[dev,test]"
261
+
262
+ # Install latest stable version
263
+ pip install compass_lib
264
+
265
+ # run some commands
266
+ compass convert --input_file=./tests/artifacts/fulford.dat --output_file=fulford.json --format=json --overwrite
267
+ compass convert --input_file=./tests/artifacts/random.dat --output_file=random.json --format=json --overwrite
268
+ ```
@@ -0,0 +1,14 @@
1
+ compass_lib/__init__.py,sha256=yHxn8lduqYphGF88ClXGAhslWdVhjfc2gpOLvpH0NzM,106
2
+ compass_lib/enums.py,sha256=nWEbsp7IPalsB6XAaP4M4qJ-3nj0CDLzqSm8y93Z41I,2495
3
+ compass_lib/parser.py,sha256=-wqFJrW1j5ihfl1vSZIzyJvWqsgwQClsItzvWg5FOJE,8469
4
+ compass_lib/section.py,sha256=spx4VYO4_CYz58_CP3otVyKFTVkWJzhEo7kY0JuUP0k,364
5
+ compass_lib/shot.py,sha256=ZfQL-O78iHKhZ1O3xt4W4oS9-hNXncfJmRyu4-48_UI,534
6
+ compass_lib/commands/__init__.py,sha256=-JIt3g1eBf4bVQNNQd4JBeQNA7o0LK0W9tYKKX_r5s8,22
7
+ compass_lib/commands/convert.py,sha256=xe238ZHBakuP1FWbK27HnUyhHx67Mee0fHOhvtzE8Hk,1411
8
+ compass_lib/commands/main.py,sha256=JPzd6QgR0PvIR-o_rkBqD9rqns1m279vjE1-oSdLte4,746
9
+ compass_lib-0.0.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
10
+ compass_lib-0.0.1.dist-info/METADATA,sha256=3t2SBMQv_miAVHJXVexy8DbE5jj2XVi-mxB9Q1Y_qgg,15425
11
+ compass_lib-0.0.1.dist-info/WHEEL,sha256=_4XEmVmaBFWtekSGrbfOGNjC2I5lUr0lZSRblBllIFA,109
12
+ compass_lib-0.0.1.dist-info/entry_points.txt,sha256=QFMLYULXSM-MMNVLvX6Rwtn95yLq799Xcdp9jBvfgoI,125
13
+ compass_lib-0.0.1.dist-info/top_level.txt,sha256=DJLZHUWROEzHJlSb0PjDMimCJlHx1VelsQiojQy4M_k,12
14
+ compass_lib-0.0.1.dist-info/RECORD,,
@@ -0,0 +1,6 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (70.1.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py2-none-any
5
+ Tag: py3-none-any
6
+
@@ -0,0 +1,5 @@
1
+ [compass.actions]
2
+ convert = compass_lib.commands.convert:convert
3
+
4
+ [console_scripts]
5
+ compass = compass_lib.commands.main:main
@@ -0,0 +1 @@
1
+ compass_lib