kshana 0.18.0 → 0.19.0
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.
- package/LICENSE +661 -202
- package/README.md +87 -43
- package/kshana_bg.wasm +0 -0
- package/package.json +2 -2
package/LICENSE
CHANGED
|
@@ -1,202 +1,661 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
1
|
+
GNU AFFERO GENERAL PUBLIC LICENSE
|
|
2
|
+
Version 3, 19 November 2007
|
|
3
|
+
|
|
4
|
+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
5
|
+
Everyone is permitted to copy and distribute verbatim copies
|
|
6
|
+
of this license document, but changing it is not allowed.
|
|
7
|
+
|
|
8
|
+
Preamble
|
|
9
|
+
|
|
10
|
+
The GNU Affero General Public License is a free, copyleft license for
|
|
11
|
+
software and other kinds of works, specifically designed to ensure
|
|
12
|
+
cooperation with the community in the case of network server software.
|
|
13
|
+
|
|
14
|
+
The licenses for most software and other practical works are designed
|
|
15
|
+
to take away your freedom to share and change the works. By contrast,
|
|
16
|
+
our General Public Licenses are intended to guarantee your freedom to
|
|
17
|
+
share and change all versions of a program--to make sure it remains free
|
|
18
|
+
software for all its users.
|
|
19
|
+
|
|
20
|
+
When we speak of free software, we are referring to freedom, not
|
|
21
|
+
price. Our General Public Licenses are designed to make sure that you
|
|
22
|
+
have the freedom to distribute copies of free software (and charge for
|
|
23
|
+
them if you wish), that you receive source code or can get it if you
|
|
24
|
+
want it, that you can change the software or use pieces of it in new
|
|
25
|
+
free programs, and that you know you can do these things.
|
|
26
|
+
|
|
27
|
+
Developers that use our General Public Licenses protect your rights
|
|
28
|
+
with two steps: (1) assert copyright on the software, and (2) offer
|
|
29
|
+
you this License which gives you legal permission to copy, distribute
|
|
30
|
+
and/or modify the software.
|
|
31
|
+
|
|
32
|
+
A secondary benefit of defending all users' freedom is that
|
|
33
|
+
improvements made in alternate versions of the program, if they
|
|
34
|
+
receive widespread use, become available for other developers to
|
|
35
|
+
incorporate. Many developers of free software are heartened and
|
|
36
|
+
encouraged by the resulting cooperation. However, in the case of
|
|
37
|
+
software used on network servers, this result may fail to come about.
|
|
38
|
+
The GNU General Public License permits making a modified version and
|
|
39
|
+
letting the public access it on a server without ever releasing its
|
|
40
|
+
source code to the public.
|
|
41
|
+
|
|
42
|
+
The GNU Affero General Public License is designed specifically to
|
|
43
|
+
ensure that, in such cases, the modified source code becomes available
|
|
44
|
+
to the community. It requires the operator of a network server to
|
|
45
|
+
provide the source code of the modified version running there to the
|
|
46
|
+
users of that server. Therefore, public use of a modified version, on
|
|
47
|
+
a publicly accessible server, gives the public access to the source
|
|
48
|
+
code of the modified version.
|
|
49
|
+
|
|
50
|
+
An older license, called the Affero General Public License and
|
|
51
|
+
published by Affero, was designed to accomplish similar goals. This is
|
|
52
|
+
a different license, not a version of the Affero GPL, but Affero has
|
|
53
|
+
released a new version of the Affero GPL which permits relicensing under
|
|
54
|
+
this license.
|
|
55
|
+
|
|
56
|
+
The precise terms and conditions for copying, distribution and
|
|
57
|
+
modification follow.
|
|
58
|
+
|
|
59
|
+
TERMS AND CONDITIONS
|
|
60
|
+
|
|
61
|
+
0. Definitions.
|
|
62
|
+
|
|
63
|
+
"This License" refers to version 3 of the GNU Affero General Public License.
|
|
64
|
+
|
|
65
|
+
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
66
|
+
works, such as semiconductor masks.
|
|
67
|
+
|
|
68
|
+
"The Program" refers to any copyrightable work licensed under this
|
|
69
|
+
License. Each licensee is addressed as "you". "Licensees" and
|
|
70
|
+
"recipients" may be individuals or organizations.
|
|
71
|
+
|
|
72
|
+
To "modify" a work means to copy from or adapt all or part of the work
|
|
73
|
+
in a fashion requiring copyright permission, other than the making of an
|
|
74
|
+
exact copy. The resulting work is called a "modified version" of the
|
|
75
|
+
earlier work or a work "based on" the earlier work.
|
|
76
|
+
|
|
77
|
+
A "covered work" means either the unmodified Program or a work based
|
|
78
|
+
on the Program.
|
|
79
|
+
|
|
80
|
+
To "propagate" a work means to do anything with it that, without
|
|
81
|
+
permission, would make you directly or secondarily liable for
|
|
82
|
+
infringement under applicable copyright law, except executing it on a
|
|
83
|
+
computer or modifying a private copy. Propagation includes copying,
|
|
84
|
+
distribution (with or without modification), making available to the
|
|
85
|
+
public, and in some countries other activities as well.
|
|
86
|
+
|
|
87
|
+
To "convey" a work means any kind of propagation that enables other
|
|
88
|
+
parties to make or receive copies. Mere interaction with a user through
|
|
89
|
+
a computer network, with no transfer of a copy, is not conveying.
|
|
90
|
+
|
|
91
|
+
An interactive user interface displays "Appropriate Legal Notices"
|
|
92
|
+
to the extent that it includes a convenient and prominently visible
|
|
93
|
+
feature that (1) displays an appropriate copyright notice, and (2)
|
|
94
|
+
tells the user that there is no warranty for the work (except to the
|
|
95
|
+
extent that warranties are provided), that licensees may convey the
|
|
96
|
+
work under this License, and how to view a copy of this License. If
|
|
97
|
+
the interface presents a list of user commands or options, such as a
|
|
98
|
+
menu, a prominent item in the list meets this criterion.
|
|
99
|
+
|
|
100
|
+
1. Source Code.
|
|
101
|
+
|
|
102
|
+
The "source code" for a work means the preferred form of the work
|
|
103
|
+
for making modifications to it. "Object code" means any non-source
|
|
104
|
+
form of a work.
|
|
105
|
+
|
|
106
|
+
A "Standard Interface" means an interface that either is an official
|
|
107
|
+
standard defined by a recognized standards body, or, in the case of
|
|
108
|
+
interfaces specified for a particular programming language, one that
|
|
109
|
+
is widely used among developers working in that language.
|
|
110
|
+
|
|
111
|
+
The "System Libraries" of an executable work include anything, other
|
|
112
|
+
than the work as a whole, that (a) is included in the normal form of
|
|
113
|
+
packaging a Major Component, but which is not part of that Major
|
|
114
|
+
Component, and (b) serves only to enable use of the work with that
|
|
115
|
+
Major Component, or to implement a Standard Interface for which an
|
|
116
|
+
implementation is available to the public in source code form. A
|
|
117
|
+
"Major Component", in this context, means a major essential component
|
|
118
|
+
(kernel, window system, and so on) of the specific operating system
|
|
119
|
+
(if any) on which the executable work runs, or a compiler used to
|
|
120
|
+
produce the work, or an object code interpreter used to run it.
|
|
121
|
+
|
|
122
|
+
The "Corresponding Source" for a work in object code form means all
|
|
123
|
+
the source code needed to generate, install, and (for an executable
|
|
124
|
+
work) run the object code and to modify the work, including scripts to
|
|
125
|
+
control those activities. However, it does not include the work's
|
|
126
|
+
System Libraries, or general-purpose tools or generally available free
|
|
127
|
+
programs which are used unmodified in performing those activities but
|
|
128
|
+
which are not part of the work. For example, Corresponding Source
|
|
129
|
+
includes interface definition files associated with source files for
|
|
130
|
+
the work, and the source code for shared libraries and dynamically
|
|
131
|
+
linked subprograms that the work is specifically designed to require,
|
|
132
|
+
such as by intimate data communication or control flow between those
|
|
133
|
+
subprograms and other parts of the work.
|
|
134
|
+
|
|
135
|
+
The Corresponding Source need not include anything that users
|
|
136
|
+
can regenerate automatically from other parts of the Corresponding
|
|
137
|
+
Source.
|
|
138
|
+
|
|
139
|
+
The Corresponding Source for a work in source code form is that
|
|
140
|
+
same work.
|
|
141
|
+
|
|
142
|
+
2. Basic Permissions.
|
|
143
|
+
|
|
144
|
+
All rights granted under this License are granted for the term of
|
|
145
|
+
copyright on the Program, and are irrevocable provided the stated
|
|
146
|
+
conditions are met. This License explicitly affirms your unlimited
|
|
147
|
+
permission to run the unmodified Program. The output from running a
|
|
148
|
+
covered work is covered by this License only if the output, given its
|
|
149
|
+
content, constitutes a covered work. This License acknowledges your
|
|
150
|
+
rights of fair use or other equivalent, as provided by copyright law.
|
|
151
|
+
|
|
152
|
+
You may make, run and propagate covered works that you do not
|
|
153
|
+
convey, without conditions so long as your license otherwise remains
|
|
154
|
+
in force. You may convey covered works to others for the sole purpose
|
|
155
|
+
of having them make modifications exclusively for you, or provide you
|
|
156
|
+
with facilities for running those works, provided that you comply with
|
|
157
|
+
the terms of this License in conveying all material for which you do
|
|
158
|
+
not control copyright. Those thus making or running the covered works
|
|
159
|
+
for you must do so exclusively on your behalf, under your direction
|
|
160
|
+
and control, on terms that prohibit them from making any copies of
|
|
161
|
+
your copyrighted material outside their relationship with you.
|
|
162
|
+
|
|
163
|
+
Conveying under any other circumstances is permitted solely under
|
|
164
|
+
the conditions stated below. Sublicensing is not allowed; section 10
|
|
165
|
+
makes it unnecessary.
|
|
166
|
+
|
|
167
|
+
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
168
|
+
|
|
169
|
+
No covered work shall be deemed part of an effective technological
|
|
170
|
+
measure under any applicable law fulfilling obligations under article
|
|
171
|
+
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
172
|
+
similar laws prohibiting or restricting circumvention of such
|
|
173
|
+
measures.
|
|
174
|
+
|
|
175
|
+
When you convey a covered work, you waive any legal power to forbid
|
|
176
|
+
circumvention of technological measures to the extent such circumvention
|
|
177
|
+
is effected by exercising rights under this License with respect to
|
|
178
|
+
the covered work, and you disclaim any intention to limit operation or
|
|
179
|
+
modification of the work as a means of enforcing, against the work's
|
|
180
|
+
users, your or third parties' legal rights to forbid circumvention of
|
|
181
|
+
technological measures.
|
|
182
|
+
|
|
183
|
+
4. Conveying Verbatim Copies.
|
|
184
|
+
|
|
185
|
+
You may convey verbatim copies of the Program's source code as you
|
|
186
|
+
receive it, in any medium, provided that you conspicuously and
|
|
187
|
+
appropriately publish on each copy an appropriate copyright notice;
|
|
188
|
+
keep intact all notices stating that this License and any
|
|
189
|
+
non-permissive terms added in accord with section 7 apply to the code;
|
|
190
|
+
keep intact all notices of the absence of any warranty; and give all
|
|
191
|
+
recipients a copy of this License along with the Program.
|
|
192
|
+
|
|
193
|
+
You may charge any price or no price for each copy that you convey,
|
|
194
|
+
and you may offer support or warranty protection for a fee.
|
|
195
|
+
|
|
196
|
+
5. Conveying Modified Source Versions.
|
|
197
|
+
|
|
198
|
+
You may convey a work based on the Program, or the modifications to
|
|
199
|
+
produce it from the Program, in the form of source code under the
|
|
200
|
+
terms of section 4, provided that you also meet all of these conditions:
|
|
201
|
+
|
|
202
|
+
a) The work must carry prominent notices stating that you modified
|
|
203
|
+
it, and giving a relevant date.
|
|
204
|
+
|
|
205
|
+
b) The work must carry prominent notices stating that it is
|
|
206
|
+
released under this License and any conditions added under section
|
|
207
|
+
7. This requirement modifies the requirement in section 4 to
|
|
208
|
+
"keep intact all notices".
|
|
209
|
+
|
|
210
|
+
c) You must license the entire work, as a whole, under this
|
|
211
|
+
License to anyone who comes into possession of a copy. This
|
|
212
|
+
License will therefore apply, along with any applicable section 7
|
|
213
|
+
additional terms, to the whole of the work, and all its parts,
|
|
214
|
+
regardless of how they are packaged. This License gives no
|
|
215
|
+
permission to license the work in any other way, but it does not
|
|
216
|
+
invalidate such permission if you have separately received it.
|
|
217
|
+
|
|
218
|
+
d) If the work has interactive user interfaces, each must display
|
|
219
|
+
Appropriate Legal Notices; however, if the Program has interactive
|
|
220
|
+
interfaces that do not display Appropriate Legal Notices, your
|
|
221
|
+
work need not make them do so.
|
|
222
|
+
|
|
223
|
+
A compilation of a covered work with other separate and independent
|
|
224
|
+
works, which are not by their nature extensions of the covered work,
|
|
225
|
+
and which are not combined with it such as to form a larger program,
|
|
226
|
+
in or on a volume of a storage or distribution medium, is called an
|
|
227
|
+
"aggregate" if the compilation and its resulting copyright are not
|
|
228
|
+
used to limit the access or legal rights of the compilation's users
|
|
229
|
+
beyond what the individual works permit. Inclusion of a covered work
|
|
230
|
+
in an aggregate does not cause this License to apply to the other
|
|
231
|
+
parts of the aggregate.
|
|
232
|
+
|
|
233
|
+
6. Conveying Non-Source Forms.
|
|
234
|
+
|
|
235
|
+
You may convey a covered work in object code form under the terms
|
|
236
|
+
of sections 4 and 5, provided that you also convey the
|
|
237
|
+
machine-readable Corresponding Source under the terms of this License,
|
|
238
|
+
in one of these ways:
|
|
239
|
+
|
|
240
|
+
a) Convey the object code in, or embodied in, a physical product
|
|
241
|
+
(including a physical distribution medium), accompanied by the
|
|
242
|
+
Corresponding Source fixed on a durable physical medium
|
|
243
|
+
customarily used for software interchange.
|
|
244
|
+
|
|
245
|
+
b) Convey the object code in, or embodied in, a physical product
|
|
246
|
+
(including a physical distribution medium), accompanied by a
|
|
247
|
+
written offer, valid for at least three years and valid for as
|
|
248
|
+
long as you offer spare parts or customer support for that product
|
|
249
|
+
model, to give anyone who possesses the object code either (1) a
|
|
250
|
+
copy of the Corresponding Source for all the software in the
|
|
251
|
+
product that is covered by this License, on a durable physical
|
|
252
|
+
medium customarily used for software interchange, for a price no
|
|
253
|
+
more than your reasonable cost of physically performing this
|
|
254
|
+
conveying of source, or (2) access to copy the
|
|
255
|
+
Corresponding Source from a network server at no charge.
|
|
256
|
+
|
|
257
|
+
c) Convey individual copies of the object code with a copy of the
|
|
258
|
+
written offer to provide the Corresponding Source. This
|
|
259
|
+
alternative is allowed only occasionally and noncommercially, and
|
|
260
|
+
only if you received the object code with such an offer, in accord
|
|
261
|
+
with subsection 6b.
|
|
262
|
+
|
|
263
|
+
d) Convey the object code by offering access from a designated
|
|
264
|
+
place (gratis or for a charge), and offer equivalent access to the
|
|
265
|
+
Corresponding Source in the same way through the same place at no
|
|
266
|
+
further charge. You need not require recipients to copy the
|
|
267
|
+
Corresponding Source along with the object code. If the place to
|
|
268
|
+
copy the object code is a network server, the Corresponding Source
|
|
269
|
+
may be on a different server (operated by you or a third party)
|
|
270
|
+
that supports equivalent copying facilities, provided you maintain
|
|
271
|
+
clear directions next to the object code saying where to find the
|
|
272
|
+
Corresponding Source. Regardless of what server hosts the
|
|
273
|
+
Corresponding Source, you remain obligated to ensure that it is
|
|
274
|
+
available for as long as needed to satisfy these requirements.
|
|
275
|
+
|
|
276
|
+
e) Convey the object code using peer-to-peer transmission, provided
|
|
277
|
+
you inform other peers where the object code and Corresponding
|
|
278
|
+
Source of the work are being offered to the general public at no
|
|
279
|
+
charge under subsection 6d.
|
|
280
|
+
|
|
281
|
+
A separable portion of the object code, whose source code is excluded
|
|
282
|
+
from the Corresponding Source as a System Library, need not be
|
|
283
|
+
included in conveying the object code work.
|
|
284
|
+
|
|
285
|
+
A "User Product" is either (1) a "consumer product", which means any
|
|
286
|
+
tangible personal property which is normally used for personal, family,
|
|
287
|
+
or household purposes, or (2) anything designed or sold for incorporation
|
|
288
|
+
into a dwelling. In determining whether a product is a consumer product,
|
|
289
|
+
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
290
|
+
product received by a particular user, "normally used" refers to a
|
|
291
|
+
typical or common use of that class of product, regardless of the status
|
|
292
|
+
of the particular user or of the way in which the particular user
|
|
293
|
+
actually uses, or expects or is expected to use, the product. A product
|
|
294
|
+
is a consumer product regardless of whether the product has substantial
|
|
295
|
+
commercial, industrial or non-consumer uses, unless such uses represent
|
|
296
|
+
the only significant mode of use of the product.
|
|
297
|
+
|
|
298
|
+
"Installation Information" for a User Product means any methods,
|
|
299
|
+
procedures, authorization keys, or other information required to install
|
|
300
|
+
and execute modified versions of a covered work in that User Product from
|
|
301
|
+
a modified version of its Corresponding Source. The information must
|
|
302
|
+
suffice to ensure that the continued functioning of the modified object
|
|
303
|
+
code is in no case prevented or interfered with solely because
|
|
304
|
+
modification has been made.
|
|
305
|
+
|
|
306
|
+
If you convey an object code work under this section in, or with, or
|
|
307
|
+
specifically for use in, a User Product, and the conveying occurs as
|
|
308
|
+
part of a transaction in which the right of possession and use of the
|
|
309
|
+
User Product is transferred to the recipient in perpetuity or for a
|
|
310
|
+
fixed term (regardless of how the transaction is characterized), the
|
|
311
|
+
Corresponding Source conveyed under this section must be accompanied
|
|
312
|
+
by the Installation Information. But this requirement does not apply
|
|
313
|
+
if neither you nor any third party retains the ability to install
|
|
314
|
+
modified object code on the User Product (for example, the work has
|
|
315
|
+
been installed in ROM).
|
|
316
|
+
|
|
317
|
+
The requirement to provide Installation Information does not include a
|
|
318
|
+
requirement to continue to provide support service, warranty, or updates
|
|
319
|
+
for a work that has been modified or installed by the recipient, or for
|
|
320
|
+
the User Product in which it has been modified or installed. Access to a
|
|
321
|
+
network may be denied when the modification itself materially and
|
|
322
|
+
adversely affects the operation of the network or violates the rules and
|
|
323
|
+
protocols for communication across the network.
|
|
324
|
+
|
|
325
|
+
Corresponding Source conveyed, and Installation Information provided,
|
|
326
|
+
in accord with this section must be in a format that is publicly
|
|
327
|
+
documented (and with an implementation available to the public in
|
|
328
|
+
source code form), and must require no special password or key for
|
|
329
|
+
unpacking, reading or copying.
|
|
330
|
+
|
|
331
|
+
7. Additional Terms.
|
|
332
|
+
|
|
333
|
+
"Additional permissions" are terms that supplement the terms of this
|
|
334
|
+
License by making exceptions from one or more of its conditions.
|
|
335
|
+
Additional permissions that are applicable to the entire Program shall
|
|
336
|
+
be treated as though they were included in this License, to the extent
|
|
337
|
+
that they are valid under applicable law. If additional permissions
|
|
338
|
+
apply only to part of the Program, that part may be used separately
|
|
339
|
+
under those permissions, but the entire Program remains governed by
|
|
340
|
+
this License without regard to the additional permissions.
|
|
341
|
+
|
|
342
|
+
When you convey a copy of a covered work, you may at your option
|
|
343
|
+
remove any additional permissions from that copy, or from any part of
|
|
344
|
+
it. (Additional permissions may be written to require their own
|
|
345
|
+
removal in certain cases when you modify the work.) You may place
|
|
346
|
+
additional permissions on material, added by you to a covered work,
|
|
347
|
+
for which you have or can give appropriate copyright permission.
|
|
348
|
+
|
|
349
|
+
Notwithstanding any other provision of this License, for material you
|
|
350
|
+
add to a covered work, you may (if authorized by the copyright holders of
|
|
351
|
+
that material) supplement the terms of this License with terms:
|
|
352
|
+
|
|
353
|
+
a) Disclaiming warranty or limiting liability differently from the
|
|
354
|
+
terms of sections 15 and 16 of this License; or
|
|
355
|
+
|
|
356
|
+
b) Requiring preservation of specified reasonable legal notices or
|
|
357
|
+
author attributions in that material or in the Appropriate Legal
|
|
358
|
+
Notices displayed by works containing it; or
|
|
359
|
+
|
|
360
|
+
c) Prohibiting misrepresentation of the origin of that material, or
|
|
361
|
+
requiring that modified versions of such material be marked in
|
|
362
|
+
reasonable ways as different from the original version; or
|
|
363
|
+
|
|
364
|
+
d) Limiting the use for publicity purposes of names of licensors or
|
|
365
|
+
authors of the material; or
|
|
366
|
+
|
|
367
|
+
e) Declining to grant rights under trademark law for use of some
|
|
368
|
+
trade names, trademarks, or service marks; or
|
|
369
|
+
|
|
370
|
+
f) Requiring indemnification of licensors and authors of that
|
|
371
|
+
material by anyone who conveys the material (or modified versions of
|
|
372
|
+
it) with contractual assumptions of liability to the recipient, for
|
|
373
|
+
any liability that these contractual assumptions directly impose on
|
|
374
|
+
those licensors and authors.
|
|
375
|
+
|
|
376
|
+
All other non-permissive additional terms are considered "further
|
|
377
|
+
restrictions" within the meaning of section 10. If the Program as you
|
|
378
|
+
received it, or any part of it, contains a notice stating that it is
|
|
379
|
+
governed by this License along with a term that is a further
|
|
380
|
+
restriction, you may remove that term. If a license document contains
|
|
381
|
+
a further restriction but permits relicensing or conveying under this
|
|
382
|
+
License, you may add to a covered work material governed by the terms
|
|
383
|
+
of that license document, provided that the further restriction does
|
|
384
|
+
not survive such relicensing or conveying.
|
|
385
|
+
|
|
386
|
+
If you add terms to a covered work in accord with this section, you
|
|
387
|
+
must place, in the relevant source files, a statement of the
|
|
388
|
+
additional terms that apply to those files, or a notice indicating
|
|
389
|
+
where to find the applicable terms.
|
|
390
|
+
|
|
391
|
+
Additional terms, permissive or non-permissive, may be stated in the
|
|
392
|
+
form of a separately written license, or stated as exceptions;
|
|
393
|
+
the above requirements apply either way.
|
|
394
|
+
|
|
395
|
+
8. Termination.
|
|
396
|
+
|
|
397
|
+
You may not propagate or modify a covered work except as expressly
|
|
398
|
+
provided under this License. Any attempt otherwise to propagate or
|
|
399
|
+
modify it is void, and will automatically terminate your rights under
|
|
400
|
+
this License (including any patent licenses granted under the third
|
|
401
|
+
paragraph of section 11).
|
|
402
|
+
|
|
403
|
+
However, if you cease all violation of this License, then your
|
|
404
|
+
license from a particular copyright holder is reinstated (a)
|
|
405
|
+
provisionally, unless and until the copyright holder explicitly and
|
|
406
|
+
finally terminates your license, and (b) permanently, if the copyright
|
|
407
|
+
holder fails to notify you of the violation by some reasonable means
|
|
408
|
+
prior to 60 days after the cessation.
|
|
409
|
+
|
|
410
|
+
Moreover, your license from a particular copyright holder is
|
|
411
|
+
reinstated permanently if the copyright holder notifies you of the
|
|
412
|
+
violation by some reasonable means, this is the first time you have
|
|
413
|
+
received notice of violation of this License (for any work) from that
|
|
414
|
+
copyright holder, and you cure the violation prior to 30 days after
|
|
415
|
+
your receipt of the notice.
|
|
416
|
+
|
|
417
|
+
Termination of your rights under this section does not terminate the
|
|
418
|
+
licenses of parties who have received copies or rights from you under
|
|
419
|
+
this License. If your rights have been terminated and not permanently
|
|
420
|
+
reinstated, you do not qualify to receive new licenses for the same
|
|
421
|
+
material under section 10.
|
|
422
|
+
|
|
423
|
+
9. Acceptance Not Required for Having Copies.
|
|
424
|
+
|
|
425
|
+
You are not required to accept this License in order to receive or
|
|
426
|
+
run a copy of the Program. Ancillary propagation of a covered work
|
|
427
|
+
occurring solely as a consequence of using peer-to-peer transmission
|
|
428
|
+
to receive a copy likewise does not require acceptance. However,
|
|
429
|
+
nothing other than this License grants you permission to propagate or
|
|
430
|
+
modify any covered work. These actions infringe copyright if you do
|
|
431
|
+
not accept this License. Therefore, by modifying or propagating a
|
|
432
|
+
covered work, you indicate your acceptance of this License to do so.
|
|
433
|
+
|
|
434
|
+
10. Automatic Licensing of Downstream Recipients.
|
|
435
|
+
|
|
436
|
+
Each time you convey a covered work, the recipient automatically
|
|
437
|
+
receives a license from the original licensors, to run, modify and
|
|
438
|
+
propagate that work, subject to this License. You are not responsible
|
|
439
|
+
for enforcing compliance by third parties with this License.
|
|
440
|
+
|
|
441
|
+
An "entity transaction" is a transaction transferring control of an
|
|
442
|
+
organization, or substantially all assets of one, or subdividing an
|
|
443
|
+
organization, or merging organizations. If propagation of a covered
|
|
444
|
+
work results from an entity transaction, each party to that
|
|
445
|
+
transaction who receives a copy of the work also receives whatever
|
|
446
|
+
licenses to the work the party's predecessor in interest had or could
|
|
447
|
+
give under the previous paragraph, plus a right to possession of the
|
|
448
|
+
Corresponding Source of the work from the predecessor in interest, if
|
|
449
|
+
the predecessor has it or can get it with reasonable efforts.
|
|
450
|
+
|
|
451
|
+
You may not impose any further restrictions on the exercise of the
|
|
452
|
+
rights granted or affirmed under this License. For example, you may
|
|
453
|
+
not impose a license fee, royalty, or other charge for exercise of
|
|
454
|
+
rights granted under this License, and you may not initiate litigation
|
|
455
|
+
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
456
|
+
any patent claim is infringed by making, using, selling, offering for
|
|
457
|
+
sale, or importing the Program or any portion of it.
|
|
458
|
+
|
|
459
|
+
11. Patents.
|
|
460
|
+
|
|
461
|
+
A "contributor" is a copyright holder who authorizes use under this
|
|
462
|
+
License of the Program or a work on which the Program is based. The
|
|
463
|
+
work thus licensed is called the contributor's "contributor version".
|
|
464
|
+
|
|
465
|
+
A contributor's "essential patent claims" are all patent claims
|
|
466
|
+
owned or controlled by the contributor, whether already acquired or
|
|
467
|
+
hereafter acquired, that would be infringed by some manner, permitted
|
|
468
|
+
by this License, of making, using, or selling its contributor version,
|
|
469
|
+
but do not include claims that would be infringed only as a
|
|
470
|
+
consequence of further modification of the contributor version. For
|
|
471
|
+
purposes of this definition, "control" includes the right to grant
|
|
472
|
+
patent sublicenses in a manner consistent with the requirements of
|
|
473
|
+
this License.
|
|
474
|
+
|
|
475
|
+
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
476
|
+
patent license under the contributor's essential patent claims, to
|
|
477
|
+
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
478
|
+
propagate the contents of its contributor version.
|
|
479
|
+
|
|
480
|
+
In the following three paragraphs, a "patent license" is any express
|
|
481
|
+
agreement or commitment, however denominated, not to enforce a patent
|
|
482
|
+
(such as an express permission to practice a patent or covenant not to
|
|
483
|
+
sue for patent infringement). To "grant" such a patent license to a
|
|
484
|
+
party means to make such an agreement or commitment not to enforce a
|
|
485
|
+
patent against the party.
|
|
486
|
+
|
|
487
|
+
If you convey a covered work, knowingly relying on a patent license,
|
|
488
|
+
and the Corresponding Source of the work is not available for anyone
|
|
489
|
+
to copy, free of charge and under the terms of this License, through a
|
|
490
|
+
publicly available network server or other readily accessible means,
|
|
491
|
+
then you must either (1) cause the Corresponding Source to be so
|
|
492
|
+
available, or (2) arrange to deprive yourself of the benefit of the
|
|
493
|
+
patent license for this particular work, or (3) arrange, in a manner
|
|
494
|
+
consistent with the requirements of this License, to extend the patent
|
|
495
|
+
license to downstream recipients. "Knowingly relying" means you have
|
|
496
|
+
actual knowledge that, but for the patent license, your conveying the
|
|
497
|
+
covered work in a country, or your recipient's use of the covered work
|
|
498
|
+
in a country, would infringe one or more identifiable patents in that
|
|
499
|
+
country that you have reason to believe are valid.
|
|
500
|
+
|
|
501
|
+
If, pursuant to or in connection with a single transaction or
|
|
502
|
+
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
503
|
+
covered work, and grant a patent license to some of the parties
|
|
504
|
+
receiving the covered work authorizing them to use, propagate, modify
|
|
505
|
+
or convey a specific copy of the covered work, then the patent license
|
|
506
|
+
you grant is automatically extended to all recipients of the covered
|
|
507
|
+
work and works based on it.
|
|
508
|
+
|
|
509
|
+
A patent license is "discriminatory" if it does not include within
|
|
510
|
+
the scope of its coverage, prohibits the exercise of, or is
|
|
511
|
+
conditioned on the non-exercise of one or more of the rights that are
|
|
512
|
+
specifically granted under this License. You may not convey a covered
|
|
513
|
+
work if you are a party to an arrangement with a third party that is
|
|
514
|
+
in the business of distributing software, under which you make payment
|
|
515
|
+
to the third party based on the extent of your activity of conveying
|
|
516
|
+
the work, and under which the third party grants, to any of the
|
|
517
|
+
parties who would receive the covered work from you, a discriminatory
|
|
518
|
+
patent license (a) in connection with copies of the covered work
|
|
519
|
+
conveyed by you (or copies made from those copies), or (b) primarily
|
|
520
|
+
for and in connection with specific products or compilations that
|
|
521
|
+
contain the covered work, unless you entered into that arrangement,
|
|
522
|
+
or that patent license was granted, prior to 28 March 2007.
|
|
523
|
+
|
|
524
|
+
Nothing in this License shall be construed as excluding or limiting
|
|
525
|
+
any implied license or other defenses to infringement that may
|
|
526
|
+
otherwise be available to you under applicable patent law.
|
|
527
|
+
|
|
528
|
+
12. No Surrender of Others' Freedom.
|
|
529
|
+
|
|
530
|
+
If conditions are imposed on you (whether by court order, agreement or
|
|
531
|
+
otherwise) that contradict the conditions of this License, they do not
|
|
532
|
+
excuse you from the conditions of this License. If you cannot convey a
|
|
533
|
+
covered work so as to satisfy simultaneously your obligations under this
|
|
534
|
+
License and any other pertinent obligations, then as a consequence you may
|
|
535
|
+
not convey it at all. For example, if you agree to terms that obligate you
|
|
536
|
+
to collect a royalty for further conveying from those to whom you convey
|
|
537
|
+
the Program, the only way you could satisfy both those terms and this
|
|
538
|
+
License would be to refrain entirely from conveying the Program.
|
|
539
|
+
|
|
540
|
+
13. Remote Network Interaction; Use with the GNU General Public License.
|
|
541
|
+
|
|
542
|
+
Notwithstanding any other provision of this License, if you modify the
|
|
543
|
+
Program, your modified version must prominently offer all users
|
|
544
|
+
interacting with it remotely through a computer network (if your version
|
|
545
|
+
supports such interaction) an opportunity to receive the Corresponding
|
|
546
|
+
Source of your version by providing access to the Corresponding Source
|
|
547
|
+
from a network server at no charge, through some standard or customary
|
|
548
|
+
means of facilitating copying of software. This Corresponding Source
|
|
549
|
+
shall include the Corresponding Source for any work covered by version 3
|
|
550
|
+
of the GNU General Public License that is incorporated pursuant to the
|
|
551
|
+
following paragraph.
|
|
552
|
+
|
|
553
|
+
Notwithstanding any other provision of this License, you have
|
|
554
|
+
permission to link or combine any covered work with a work licensed
|
|
555
|
+
under version 3 of the GNU General Public License into a single
|
|
556
|
+
combined work, and to convey the resulting work. The terms of this
|
|
557
|
+
License will continue to apply to the part which is the covered work,
|
|
558
|
+
but the work with which it is combined will remain governed by version
|
|
559
|
+
3 of the GNU General Public License.
|
|
560
|
+
|
|
561
|
+
14. Revised Versions of this License.
|
|
562
|
+
|
|
563
|
+
The Free Software Foundation may publish revised and/or new versions of
|
|
564
|
+
the GNU Affero General Public License from time to time. Such new versions
|
|
565
|
+
will be similar in spirit to the present version, but may differ in detail to
|
|
566
|
+
address new problems or concerns.
|
|
567
|
+
|
|
568
|
+
Each version is given a distinguishing version number. If the
|
|
569
|
+
Program specifies that a certain numbered version of the GNU Affero General
|
|
570
|
+
Public License "or any later version" applies to it, you have the
|
|
571
|
+
option of following the terms and conditions either of that numbered
|
|
572
|
+
version or of any later version published by the Free Software
|
|
573
|
+
Foundation. If the Program does not specify a version number of the
|
|
574
|
+
GNU Affero General Public License, you may choose any version ever published
|
|
575
|
+
by the Free Software Foundation.
|
|
576
|
+
|
|
577
|
+
If the Program specifies that a proxy can decide which future
|
|
578
|
+
versions of the GNU Affero General Public License can be used, that proxy's
|
|
579
|
+
public statement of acceptance of a version permanently authorizes you
|
|
580
|
+
to choose that version for the Program.
|
|
581
|
+
|
|
582
|
+
Later license versions may give you additional or different
|
|
583
|
+
permissions. However, no additional obligations are imposed on any
|
|
584
|
+
author or copyright holder as a result of your choosing to follow a
|
|
585
|
+
later version.
|
|
586
|
+
|
|
587
|
+
15. Disclaimer of Warranty.
|
|
588
|
+
|
|
589
|
+
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
590
|
+
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
591
|
+
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
592
|
+
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
593
|
+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
594
|
+
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
595
|
+
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
596
|
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
597
|
+
|
|
598
|
+
16. Limitation of Liability.
|
|
599
|
+
|
|
600
|
+
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
601
|
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
602
|
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
603
|
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
604
|
+
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
605
|
+
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
606
|
+
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
607
|
+
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
608
|
+
SUCH DAMAGES.
|
|
609
|
+
|
|
610
|
+
17. Interpretation of Sections 15 and 16.
|
|
611
|
+
|
|
612
|
+
If the disclaimer of warranty and limitation of liability provided
|
|
613
|
+
above cannot be given local legal effect according to their terms,
|
|
614
|
+
reviewing courts shall apply local law that most closely approximates
|
|
615
|
+
an absolute waiver of all civil liability in connection with the
|
|
616
|
+
Program, unless a warranty or assumption of liability accompanies a
|
|
617
|
+
copy of the Program in return for a fee.
|
|
618
|
+
|
|
619
|
+
END OF TERMS AND CONDITIONS
|
|
620
|
+
|
|
621
|
+
How to Apply These Terms to Your New Programs
|
|
622
|
+
|
|
623
|
+
If you develop a new program, and you want it to be of the greatest
|
|
624
|
+
possible use to the public, the best way to achieve this is to make it
|
|
625
|
+
free software which everyone can redistribute and change under these terms.
|
|
626
|
+
|
|
627
|
+
To do so, attach the following notices to the program. It is safest
|
|
628
|
+
to attach them to the start of each source file to most effectively
|
|
629
|
+
state the exclusion of warranty; and each file should have at least
|
|
630
|
+
the "copyright" line and a pointer to where the full notice is found.
|
|
631
|
+
|
|
632
|
+
<one line to give the program's name and a brief idea of what it does.>
|
|
633
|
+
Copyright (C) <year> <name of author>
|
|
634
|
+
|
|
635
|
+
This program is free software: you can redistribute it and/or modify
|
|
636
|
+
it under the terms of the GNU Affero General Public License as published by
|
|
637
|
+
the Free Software Foundation, either version 3 of the License, or
|
|
638
|
+
(at your option) any later version.
|
|
639
|
+
|
|
640
|
+
This program is distributed in the hope that it will be useful,
|
|
641
|
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
642
|
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
643
|
+
GNU Affero General Public License for more details.
|
|
644
|
+
|
|
645
|
+
You should have received a copy of the GNU Affero General Public License
|
|
646
|
+
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
647
|
+
|
|
648
|
+
Also add information on how to contact you by electronic and paper mail.
|
|
649
|
+
|
|
650
|
+
If your software can interact with users remotely through a computer
|
|
651
|
+
network, you should also make sure that it provides a way for users to
|
|
652
|
+
get its source. For example, if your program is a web application, its
|
|
653
|
+
interface could display a "Source" link that leads users to an archive
|
|
654
|
+
of the code. There are many ways you could offer source, and different
|
|
655
|
+
solutions will be better for different programs; see section 13 for the
|
|
656
|
+
specific requirements.
|
|
657
|
+
|
|
658
|
+
You should also get your employer (if you work as a programmer) or school,
|
|
659
|
+
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
660
|
+
For more information on this, and how to apply and follow the GNU AGPL, see
|
|
661
|
+
<https://www.gnu.org/licenses/>.
|
package/README.md
CHANGED
|
@@ -12,11 +12,14 @@
|
|
|
12
12
|
<p align="center">
|
|
13
13
|
<a href="https://ashfordeou.github.io/kshana/"><img src="https://img.shields.io/badge/playground-try%20in%20browser-c79e63" alt="Live playground — run in your browser, no install"></a>
|
|
14
14
|
<a href="tests/sgp4_verification.rs"><img src="https://img.shields.io/badge/SGP4-666%2F666%20AIAA%20vectors%20%C2%B7%204.12mm-3fb950" alt="SGP4 validated against all 666 AIAA 2006-6753 vectors, worst 4.12 mm"></a>
|
|
15
|
+
<a href="#validation-at-a-glance"><img src="https://img.shields.io/badge/validated-13%20external%20oracles-3fb950" alt="13 capabilities validated against independent external oracles (real data, independent libraries, or published reference vectors); 12 more are honestly labelled MODELLED — see Validation at a glance"></a>
|
|
15
16
|
<a href="https://github.com/ashfordeOU/kshana/actions/workflows/ci.yml"><img src="https://img.shields.io/badge/coverage-~96%25%20line-3fb950" alt="~96% line coverage on src/ (cargo-tarpaulin LLVM engine), gated at 85% in CI"></a>
|
|
16
17
|
<a href="https://github.com/ashfordeOU/kshana/actions/workflows/ci.yml"><img src="https://github.com/ashfordeOU/kshana/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
|
|
17
|
-
<a href="https://github.com/ashfordeOU/kshana/releases"><img src="https://img.shields.io/badge/release-v0.
|
|
18
|
+
<a href="https://github.com/ashfordeOU/kshana/releases"><img src="https://img.shields.io/badge/release-v0.19.0-c79e63" alt="Release v0.19.0"></a>
|
|
18
19
|
<a href="https://plugins.jetbrains.com/plugin/32181-kshana--pnt-simulator"><img src="https://img.shields.io/badge/JetBrains-Marketplace-c79e63" alt="Kshana on the JetBrains Marketplace"></a>
|
|
19
|
-
<a href="
|
|
20
|
+
<a href="https://glama.ai/mcp/servers/ashfordeOU/kshana"><img src="https://glama.ai/mcp/servers/ashfordeOU/kshana/badges/score.svg" alt="kshana-mcp on Glama — MCP server quality score"></a>
|
|
21
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg" alt="License: AGPL-3.0-only"></a>
|
|
22
|
+
<a href="LICENSING.md"><img src="https://img.shields.io/badge/commercial_licence-available-2ea043" alt="Commercial licence available from Ashforde OÜ"></a>
|
|
20
23
|
<a href="Cargo.toml"><img src="https://img.shields.io/badge/rust-1.75%2B-orange.svg" alt="Rust 1.75+"></a>
|
|
21
24
|
<a href="https://doi.org/10.5281/zenodo.20528627"><img src="https://img.shields.io/badge/DOI-10.5281%2Fzenodo.20528627-blue.svg" alt="DOI 10.5281/zenodo.20528627"></a>
|
|
22
25
|
</p>
|
|
@@ -41,10 +44,12 @@ navigation. Every result is reproducible from `scenario + seed + engine version`
|
|
|
41
44
|
and every sensor parameter is traceable to a published source — consolidated in one
|
|
42
45
|
citable table in [`docs/PROVENANCE.md`](docs/PROVENANCE.md).
|
|
43
46
|
|
|
44
|
-
*Free and open source under
|
|
45
|
-
Ashforde OÜ
|
|
47
|
+
*Free and open source under the GNU AGPL-3.0 — with a commercial licence available
|
|
48
|
+
from Ashforde OÜ for proprietary/closed integration (see [`LICENSING.md`](LICENSING.md)).
|
|
49
|
+
Professionally developed and maintained by Ashforde OÜ; commercial support,
|
|
50
|
+
integration, and proprietary extensions available.*
|
|
46
51
|
|
|
47
|
-
> **Status: v0.
|
|
52
|
+
> **Status: v0.19.0 · a simulation substrate, not yet a product.** A validated,
|
|
48
53
|
> fully reproducible engine spanning the PNT stack — orbit geometry and constellation
|
|
49
54
|
> design, a numerical (Cowell) propagator with a six-perturbation force model, maneuver
|
|
50
55
|
> and trajectory design, time systems, inertial navigation (incl. map-aided and
|
|
@@ -52,8 +57,11 @@ Ashforde OÜ — commercial support, integration, and proprietary extensions ava
|
|
|
52
57
|
> clock+position, 17-state), orbit determination, ARAIM integrity, clocks, advanced
|
|
53
58
|
> time-and-frequency transfer, the GNSS measurement domain, resilience (jamming +
|
|
54
59
|
> multi-layer spoofing), and an open **deep-space / Mars radiometric navigation**
|
|
55
|
-
> engine (light-time + Shapiro, CCSDS-TDM, reduced-dynamic SRIF, one-/two-way fusion)
|
|
56
|
-
>
|
|
60
|
+
> engine (light-time + Shapiro, CCSDS-TDM, reduced-dynamic SRIF, one-/two-way fusion);
|
|
61
|
+
> plus first-order **mission-analysis** budgets (launch / re-entry / EO-coverage / pointing /
|
|
62
|
+
> ground-station passes / link), a **space-weather** environment model, an **AI/ML
|
|
63
|
+
> RF-impairment** evaluation testbed, and the versioned **Kshana Interchange Format (KIF)**.
|
|
64
|
+
> Honest by design: every figure of merit is labelled *validated* or *modelled*, and
|
|
57
65
|
> optical-clock figures are space goals on ground hardware (no strontium optical clock has flown).
|
|
58
66
|
>
|
|
59
67
|
> **Validation ladder** (maturity is *not* uniform across domains — and saying so is the point):
|
|
@@ -140,7 +148,7 @@ the P2 roadmap and [get in touch](#support--professional-services) to collaborat
|
|
|
140
148
|
|
|
141
149
|
| Domain | Capability |
|
|
142
150
|
|--------|------------|
|
|
143
|
-
| **Orbit & geometry** | SGP4/SDP4 propagation (validated to 4.12 mm against all 666 AIAA 2006-6753 vectors); real two-line elements (a committed, date-stamped Celestrak `gps-ops` snapshot) or synthetic Walker-delta constellations whose mean elements realise the `i:T/P/F` formula to under 1 km over a 24 h propagation; multi-constellation visibility, dilution of precision, and GNSS availability; a gradient-free constellation-design optimiser, streets-of-coverage minimum-satellite sizing, a multi-constellation comparison tool, and a Walker **design sweep** that tabulates coverage / PDOP / revisit-time over a planes × satellites grid and reports the Pareto-optimal designs. |
|
|
151
|
+
| **Orbit & geometry** | SGP4/SDP4 propagation (validated to 4.12 mm against all 666 AIAA 2006-6753 vectors); real two-line elements (a committed, date-stamped Celestrak `gps-ops` snapshot) or synthetic Walker-delta constellations whose mean elements realise the `i:T/P/F` formula to under 1 km over a 24 h propagation; multi-constellation visibility, **dilution of precision (GDOP/PDOP/HDOP/VDOP/TDOP, validated to 1e-6 against gnss_lib_py 1.0.4, Stanford NAV Lab)**, and GNSS availability; a gradient-free constellation-design optimiser, streets-of-coverage minimum-satellite sizing, a multi-constellation comparison tool, and a Walker **design sweep** that tabulates coverage / PDOP / revisit-time over a planes × satellites grid and reports the Pareto-optimal designs. |
|
|
144
152
|
| **Numerical propagator** | A **Cowell** numerical propagator (`src/propagator.rs`) complementing the analytic SGP4/SDP4 path, with a hierarchical **six-perturbation** force model (`src/forces.rs`): two-body + the full **J2–J6 zonal** field (the exact analytic gradient of its disturbing potential), an optional **EGM2008 tesseral spherical-harmonic geopotential to degree/order 70** (`src/gravity_sh.rs`; real NGA coefficients, Holmes–Featherstone normalized-Legendre recurrence, cross-checked against the closed-form Legendre functions and the analytic ∇V identity), **epoch-driven Sun and Moon third-body** gravity (a built-in low-precision ephemeris, no DE/SPK kernel), **solar-radiation pressure** (cannonball model with a conical umbra+penumbra shadow), **atmospheric drag** (Vallado piecewise-exponential density, co-rotating atmosphere), the **post-Newtonian Schwarzschild relativistic correction**, and the **Lense–Thirring frame-dragging** term (IERS 2010 §10, linear in Earth's angular momentum, ~1–2 orders below Schwarzschild) — driven by a choice of two adaptive integrators (RK4 step-doubling or the **Dormand–Prince RK5(4)** embedded pair). Validated against analytic truth stronger than a cross-tool would give: the unperturbed orbit matches the exact universal-variable Kepler solution to **sub-metre over 24 h**, energy/angular-momentum conserve to ~1e-9, and each perturbation matches a hand-derived closed-form signature. |
|
|
145
153
|
| **Maneuvers & trajectory design** | Impulsive ΔV nodes with 6×6 covariance propagation (ECI / LVLH execution-error frames), finite-burn integration checked against the closed-form **Tsiolkovsky** rocket equation to < 0.01 %, an **Izzo-2015** single-revolution **Lambert** solver, an exact universal-variable **Kepler** propagator, and a **porkchop** (launch × arrival) C3 / arrival-V∞ sweep emitted as a JSON contour grid — the performance-simulation layer above GMAT/Orekit, with every Lambert output round-tripped against two-body truth and the porkchop minimum checked against the analytic Hohmann floor. |
|
|
146
154
|
| **Time systems & reference frames** | IERS leap-second **UTC / TAI / TT / UT1** scales, a Julian-date API, the IAU-2000 **Earth Rotation Angle**, GMST-based **TEME ↔ ECEF** with WGS-84 geodetic frames, IAU 2006 precession (Fukushima–Williams), full **IAU 2000A/2000B nutation**, IERS **polar motion**, and the equinox-free **CIO-based IAU 2006/2000A GCRS↔ITRS** reduction — all validated **bit-for-bit** against the SOFA/ERFA vectors, and **independently cross-checked against ANISE** (the pure-Rust NAIF/SPICE reimplementation): kshana's GCRS→ITRS vs ANISE's ITRF93 from JPL's `earth_latest_high_prec.bpc`, the same IERS Earth-orientation parameters fed to both, agree to **≤ 0.86 m on the ground / ≤ 3.6 m at GNSS orbit** (max 0.028″) across eight epochs 2020–2023. |
|
|
@@ -150,13 +158,18 @@ the P2 roadmap and [get in touch](#support--professional-services) to collaborat
|
|
|
150
158
|
| **Orbit determination** | Recovery of an orbital state `[r, v]` from ground-station range tracking, composing the two-body + J2 force model and RK4 integrator with a **Gauss–Newton batch** corrector (`determine_orbit_batch`, sub-metre / mm·s⁻¹ from noiseless ranges, ~2 m at a 5 m noise floor) and a **sequential** unscented-filter variant (`determine_orbit_sequential`). |
|
|
151
159
|
| **Lunar & cislunar** | An Earth–Moon **circular restricted three-body (CR3BP)** propagator in the rotating frame — conserved Jacobi constant and all five Lagrange points (`src/cr3bp.rs`) — now with a **6×6 state-transition matrix and a single-shooting differential corrector** (`cr3bp_jacobian`, `propagate_state_stm`, `differential_correct_halo`) that produces genuinely periodic **halo / NRHO** orbits: the STM is validated against finite differences, corrected orbits close to machine precision, and seeding the published apolune state reproduces the **L2 southern 9:2 NRHO** (the Gateway orbit) at period ≈ 6.57 d / perilune ≈ 3,250 km, consistent with the published ≈ 6.56 d / ≈ 3,370 km (a CR3BP — circular, Sun-free — solution, **not** validated against a real LANS/Gateway ephemeris; the selenocentric MCI/MCMF transform of the corrected orbit is a follow-on); plus **LunaNet / LNIS** cislunar PNT geometry (MCI↔MCMF reduction, selenographic coordinates) with a **lunar south-pole ARAIM** pass that honestly surfaces the integrity gap: a ~30 m σ_URE drives the protection level well above a 50 m alert limit (`src/lunar.rs`, `scenarios/lunanet-araim.toml`). |
|
|
152
160
|
| **Deep-space & Mars PNT** | An open **radiometric navigation engine**: iterative light-time + **Shapiro** relativistic delay, two-/one-/three-way **Doppler & range** (Moyer two-leg), coherent transponder turnaround ratios, regenerative/PN ranging (CCSDS 414), and **Δ-DOR** plane-of-sky (CCSDS 506), with solar-plasma/tropo/iono media; **CCSDS-TDM (503)** tracking-data-message parse + emit; a **reduced-dynamic Square-Root Information Filter** (RTN empirical accelerations + a 3-state onboard clock + Mars atmospheric drag) that does **Mars-LMO orbit determination to ≈ 0.2 m** in a synthetic closed loop; a joint **one-way + two-way fusion** estimator; a multi-body dynamics core (`Body{μ, re, zonals, gravity, IAU-pole}`, Mars GMM-3 gravity, an IAU body-fixed Mars frame, a pluggable `EphemerisProvider` seam, two-part Julian dates + TT↔TDB); and the **`mars-pnt`** relay-PNT scenario (a MARCONI areostationary relay constellation) with an end-to-end **GSE performance simulator** (geometry → link budget → observables → SRIF → covariance). **Simulation-validated** (covariance / closed-loop figures of merit); the Sun-central Mars dynamics are cross-checked against JPL **DE440** (137 m @ 1-day arc, `xval/anise-mars-od`). Real DSN/ESTRACK tracking-data validation is on the roadmap. |
|
|
153
|
-
| **Integrity** | Snapshot and solution-separation (ARAIM-style) RAIM with horizontal/vertical protection levels (HPL/VPL), fault detection & exclusion, and Stanford integrity diagrams; an explicit integrity-risk-budget (**MHSS**) protection level, including the **dual-/multi-constellation constellation-wide fault mode** (EU ARAIM / DO-316), exercised on a real GPS + Galileo snapshot (`scenarios/araim-gps-galileo.toml`). |
|
|
161
|
+
| **Integrity** | Snapshot and solution-separation (ARAIM-style) RAIM with horizontal/vertical protection levels (HPL/VPL), fault detection & exclusion, and Stanford integrity diagrams; an explicit integrity-risk-budget (**MHSS**) protection level, including the **dual-/multi-constellation constellation-wide fault mode** (EU ARAIM / DO-316), exercised on a real GPS + Galileo snapshot (`scenarios/araim-gps-galileo.toml`). The protection level applies the one-sided **nominal-bias** projection `b_k = Σ_i|s_i|·b_nom` per fault mode and the **integrity** sigma σ_URA (distinct from the accuracy σ_URE) from the Integrity Support Message — see [`docs/ARAIM_REFERENCE.md`](docs/ARAIM_REFERENCE.md). |
|
|
154
162
|
| **Augmentation (SBAS)** | **SBAS / WAAS protection levels** in the DO-229E weighted-least-squares form (precision-approach and en-route K-factors) and the **L1/L5 dual-frequency ionosphere-free** combination (IS-GPS-705, γ₁₅ ≈ 1.793) that underpins DO-316 — `src/sbas.rs`, with the protection-level geometry cross-checked against a NumPy `inv(GᵀG)` reference. |
|
|
155
163
|
| **Clock & timing** | Two-state Kalman holdover (Joseph-form covariance, NIS/NEES consistency health); Allan-family stability (ADEV / MDEV / TDEV / HDEV) with noise-type-specific confidence intervals and a full **IEEE-1139 five-coefficient power-law fit**; geometric corrections (Sagnac, GNSS common-view); and the operational transfer methods — **TWSTFT** with the BIPM Sagnac closed form, **GNSS common-view**, **PPP** ionosphere-free time transfer, a free-space **optical** link with turbulence scintillation, and an inverse-variance **clock-ensemble (paper) timescale** below the best contributing clock. A **GNSS-denied clock-holdover calculator** (`src/holdover.rs`) exposes the closed-form van-Loan coast-error growth as a *holdover-to-threshold* inversion — how long a clock free-runs before its timing error exceeds budget — across representative classical and quantum-clock classes; **modelled** (cross-checked against the multi-step `clock_state` covariance recursion), and honest that for a very stable clock the holdover to a tight threshold is set by the *assumed* long-tau noise floor, not the cited ADEV. |
|
|
156
164
|
| **GNSS measurement domain** | Forward pseudorange / Doppler synthesis with **Klobuchar** (broadcast) and **IONEX / TEC-grid** (measured) ionosphere — including an IONEX file parser, time interpolation between maps, and the thin-shell slant-obliquity mapping — **Saastamoinen + Niell** troposphere, and snapshot RAIM (HPL/VPL). |
|
|
157
165
|
| **Resilience** | Link-budget **jamming** (J/S → effective C/N₀ → loss of lock, with the anti-jam spectral-separation factor `Q` now **derived from the actual signal and jammer power spectra** via `src/navsignal.rs` — `Q = 1/(R_c·κ)`, cross-checked in CI against the previous representative constant); a stochastic **time-spoof detector** (Neyman–Pearson / χ²₁ energy test with closed-form and Monte-Carlo P_fa/P_md and a Security FoM of 1 − P_md); and a **multi-layer spoof detector** fusing a RAIM-consistency parity test (with the common-mode blind spot modelled honestly), an RF AGC-power monitor, and a signal-quality (SQM early-minus-late) monitor; and a **quantum-inertial dead-reckoning error budget** (`QuantumNavBudget`, `src/inertial/quantum_imu.rs`) composing the cold-atom-interferometer white-noise velocity-random-walk with residual bias (cross-checked against the independent `AccelModel` integrator) and scale-factor error into a position-drift-over-holdover figure — the inertial twin of the clock holdover. |
|
|
158
166
|
| **Nav-signal & code tracking** | The **signal level** between the link budget and the measurement domain (`src/navsignal.rs`): unit-area **power spectral densities** for **BPSK-R(n)** and **sine-BOC(m,n)**; the **spectral-separation coefficient** κ = ∫ G_s·G_i df, which **derives the anti-jam `Q`** the jamming model uses (`Q = 1/(R_c·κ)`) from the actual signal/jammer spectra instead of a representative constant; the **RMS (Gabor) bandwidth** (BOC > BPSK — the ranging-information / Cramér–Rao measure); the **coherent early–late DLL code-tracking thermal-noise jitter** (Kaplan & Hegarty; ~sub-metre for C/A at 45 dB-Hz); and the **multipath error envelope** (coherent EML — narrow-correlator suppression). Validated against closed-form anchors (BPSK self-SSC = 2/(3·R_c), unit-area PSDs, sub-metre C/A jitter). This is signal-**performance** analysis, **not** antenna / RF-payload hardware design (a payload partner's role). |
|
|
159
167
|
| **Interoperability** | **RINEX-3** multi-GNSS broadcast-ephemeris ingestion (GPS, Galileo, QZSS, BeiDou MEO/IGSO via IS-GPS-200; GLONASS via PZ-90 state-vector RK4) usable as a constellation source (RINEX in, PNT geometry out); a **RINEX-3/4** observation parser (pseudorange, carrier phase, Doppler, signal strength) that now **feeds a single-point-positioning solver** (`pvt`) — real code observations in, a real **receiver position** out, validated on IGS data; an **SP3-c/d** precise-ephemeris reader/writer with 9th-order Lagrange interpolation; and **CCSDS OEM 2.0 + OMM** (mean-elements) export for flight-dynamics tools (GMAT, Orekit, STK); and **CCSDS-TDM (503)** tracking-data-message parse + emit for deep-space radiometric tracking. |
|
|
168
|
+
| **Mission analysis (systems engineering)** | First-order mission-design budgets, each a runnable kind: two-body **launch & ascent geometry** (`launch-window` — launch azimuth `sin Az = cos i/cos lat`, minimum inclination, Earth-rotation bonus, dogleg plane-change Δv, daily opportunities; `src/launch.rs`); an **Allen–Eggers ballistic re-entry corridor** (`reentry` — peak deceleration, peak-g velocity/altitude, peak-heating velocity; `src/reentry.rs`); **Earth-observation coverage geometry** (`eo-coverage` — swath / nadir GSD / off-nadir access / revisit via the SMAD space triangle; `src/eo_payload.rs`); a **3-DOF attitude & pointing error budget** (`attitude-budget` — worst-case gravity-gradient torque + RSS pointing budget; `src/attitude_budget.rs`); **ground-station pass prediction** (`passes` — AOS/TCA/LOS, max elevation, access time; `src/passes.rs`); and a **one-way link budget** over the CCSDS 401 / DSN 810-005 link equation (`link-budget` — FSPL, C/N₀, Eb/N₀, margin, closure; `src/linkbudget.rs`). **MODELLED** first-order analytic budgets — the pre-hardware layer below STK/GMAT/Basilisk, not a 6-DoF or radiometric replacement. |
|
|
169
|
+
| **Space environment** | A **space-weather environment model** (`space-weather`, `src/space_weather.rs`): solar (F10.7 / centred-81-day F10.7a) and geomagnetic (Kp, with the definitional Kp↔ap table) activity indices, the **Jacchia-1971** exospheric temperature they drive (validated vs published solar min/mean/max), and the activity-corrected vs static thermospheric neutral density at altitude — the solar-cycle density dependence the static USSA76 atmosphere omits. **MODELLED**: a calibrated first-order scale-height coupling, **not** a data-validated (NRLMSISE) atmosphere. |
|
|
170
|
+
| **AI/ML evaluation & trade** | An **RF-impairment detection evaluation testbed** (`impairment-eval`, `src/impairment_eval.rs`): a labelled, parameter-grounded **synthetic** corpus (nominal / jamming / spoof-time / spoof-position / multipath), a detector-agnostic **ROC/AUC** harness scoring any detector (energy \| agc \| sqm \| parity \| fused) with per-class Pd at a target Pfa, and the in- vs out-of-distribution **optimism gap** (distribution-shift mode). Plus a **quantum-vs-classical PNT trade** (`quantum-trade`, `src/quantum_trade.rs`) quantifying a candidate clock's timing/inertial holdover benefit from a **measured-ADEV** curve vs a classical baseline, with the long-τ floor caveat carried on the artifact and a GNSS-denied resilience-vs-time envelope. The evaluation **metrics** (AUC / confusion / Pd-Pmd) are **validated to an exact match against scikit-learn 1.9.0**, and the trade engine's numerical **kernels** (ADEV NNLS fit, χ² consistency bands, van-Loan clock Q) **against scipy 1.17.1**; the device-benefit numbers built on top stay **MODELLED** operating characteristics — never field/IQ data, no good/bad verdict. |
|
|
171
|
+
| **Frugal engineering & integrity impact** | A **cost-per-coverage ROI** lens (`src/frugal.rs`) — cost per unit of delivered coverage for an architecture trade — and a **detection-miss → integrity-impact** mapping (`src/integrity_impact.rs`) that turns a monitor's missed-detection rate into its integrity-risk contribution. **MODELLED** decision-support budgets, additive. |
|
|
172
|
+
| **Artifact interchange** | The **Kshana Interchange Format (KIF)** (`src/interchange.rs`) — a versioned, self-describing envelope wrapping a scenario result with its kind, schema version, and MODELLED/VALIDATED labels, so a stored artifact stays self-documenting and older envelopes remain forward-compatibly readable. |
|
|
160
173
|
|
|
161
174
|
Each capability is reachable as a Rust API, a runnable scenario `kind`, or both.
|
|
162
175
|
Maturity per capability — *validated*, *runnable*, or *library* — is tracked in
|
|
@@ -345,6 +358,8 @@ console.log(version(), result.classical.fom.timing_p95_ns);
|
|
|
345
358
|
|
|
346
359
|
### AI agents (MCP)
|
|
347
360
|
|
|
361
|
+
[](https://glama.ai/mcp/servers/ashfordeOU/kshana)
|
|
362
|
+
|
|
348
363
|
Kshana ships an [MCP](https://modelcontextprotocol.io) server, [`kshana-mcp`](mcp/kshana-mcp/),
|
|
349
364
|
so AI assistants and agents can run the **validated** engine instead of guessing the
|
|
350
365
|
math — usable from **Cursor, JetBrains AI Assistant / Junie, and any MCP-compatible
|
|
@@ -746,6 +761,10 @@ kshana/
|
|
|
746
761
|
│ ├── navsignal.rs # nav-signal PSD (BPSK-R/BOC) · spectral-separation → anti-jam Q · DLL code-tracking jitter · multipath envelope
|
|
747
762
|
│ ├── gravimeter.rs · igrf.rs · mapmatch.rs · particle_filter.rs · altpnt/ # gravity/magnetic/terrain alt-PNT
|
|
748
763
|
│ ├── rinex.rs · rinex_obs.rs · glonass.rs · sp3.rs · oem.rs · omm.rs · permalink.rs # interop formats
|
|
764
|
+
│ ├── launch.rs · reentry.rs · eo_payload.rs · attitude_budget.rs · passes.rs · space_packet.rs # mission-analysis budgets + CCSDS Space Packet
|
|
765
|
+
│ ├── space_weather.rs · holdover.rs # space-weather environment · GNSS-denied clock-holdover calculator
|
|
766
|
+
│ ├── impairment_eval.rs · quantum_trade.rs · frugal.rs · integrity_impact.rs # AI/ML RF-impairment eval · PNT trade · cost-per-coverage ROI · integrity impact
|
|
767
|
+
│ ├── interchange.rs · verification.rs # KIF artifact envelope · machine-checked verification matrix
|
|
749
768
|
│ └── bin/validation_report.rs # builds the release validation-summary HTML
|
|
750
769
|
│
|
|
751
770
|
├── mcp/kshana-mcp/ # standalone, workspace-EXCLUDED crate — the MCP server (+ Dockerfile, server.json)
|
|
@@ -774,18 +793,25 @@ kshana/
|
|
|
774
793
|
| [Validation status](docs/VALIDATION.md) | reviewers / citers | what is `validated` vs `not modeled`, with evidence |
|
|
775
794
|
| [Provenance](docs/PROVENANCE.md) | reviewers / citers | every sensor parameter, model, and dataset traced to its published source, in one citable table |
|
|
776
795
|
| [Reproducibility & provenance](docs/REPRODUCIBILITY.md) | reviewers / packagers | determinism guarantees, golden-pinning, SBOM, build provenance |
|
|
796
|
+
| [Wheel platform tags](docs/WHEEL_TAGS.md) | packagers | the abi3 Python wheel matrix — which platform tag `pip install kshana` resolves |
|
|
777
797
|
| [Positioning](docs/POSITIONING.md) | evaluators | where Kshana sits vs RTKLIB/gLAB (complementary), and the zero-install browser tier |
|
|
778
798
|
| [Technical report](paper/kshana-technical-report.md) · [JOSS paper](paper/paper.md) | reviewers / citers / evaluators | the full extended research paper — architecture, per-domain models, validation, case studies, and limitations — plus the concise JOSS submission |
|
|
779
799
|
| [SGP4 validation](docs/SGP4-VALIDATION.md) | reviewers / citers | agreement with the AIAA 2006-6753 reference (666 states, ~4 mm) **and** a head-to-head against the independent `sgp4` crate (agree to sub-micron / 4.12 mm) |
|
|
800
|
+
| [Force-model validation](docs/AGENCY-ORBIT-VALIDATION.md) | reviewers / citers | the full-force engine (`src/precise_od.rs`) fit to agency ephemerides — methodology and validated residuals |
|
|
801
|
+
| [Real TLE guide](docs/REAL_TLE_GUIDE.md) | users | driving scenarios from real Celestrak / Space-Track constellation TLEs (vs the bundled synthetic Walker set) |
|
|
780
802
|
| [Integrity FoM](docs/INTEGRITY.md) | evaluators | what the `integrity` / `security` figures mean — and what they are **not** vs aviation HPL/VPL |
|
|
803
|
+
| [ARAIM reference](docs/ARAIM_REFERENCE.md) | reviewers / integrators | the open MHSS ARAIM protection-level implementation — the `b_k` nominal-bias projection, σ_URA vs σ_URE, and the fault-mode priors |
|
|
781
804
|
| [Quantum models](docs/QUANTUM.md) · [details](docs/QUANTUM-MODELS.md) | reviewers | the cold-atom-interferometer physics layer, and where coefficients are still looked up |
|
|
782
805
|
| [Compliance](docs/COMPLIANCE.md) | evaluators | DO-229E / DO-316 algorithm scope, and what is **not** a conformance claim |
|
|
806
|
+
| [Standards & interoperability](docs/STANDARDS.md) | integrators | the GNSS / flight-dynamics / agency interchange formats Kshana reads and writes (RINEX, SP3, CCSDS OEM/OMM/TDM/Space-Packet, …) |
|
|
783
807
|
| [Result schema](docs/SCHEMA.md) | integrators | every field of the result JSON, with units and a source pointer |
|
|
808
|
+
| [Python API](docs/PYTHON_API.md) | Python users | the PyO3 binding surface — calling the engine, the scenario/result types, and examples |
|
|
784
809
|
| [Claims vs reality](docs/CLAIMS-VS-REALITY.md) | reviewers | the overclaim-closure ledger + the CI guard (`tests/no_overclaims.rs`) that keeps it resolved |
|
|
785
810
|
| [Roadmap](ROADMAP.md) | everyone | the phased roadmap — what has shipped and what is next |
|
|
786
811
|
| [MCP server](mcp/kshana-mcp/README.md) · [JetBrains plugin](ide/jetbrains/README.md) | agents / IDE users | run Kshana from an AI assistant or a JetBrains IDE |
|
|
787
812
|
| [Changelog](CHANGELOG.md) | everyone | released history (Keep a Changelog + SemVer) |
|
|
788
813
|
| [Contributing](CONTRIBUTING.md) | contributors | build, guards, test/citation discipline, DCO |
|
|
814
|
+
| [Governance](GOVERNANCE.md) | contributors / community | how Kshana is governed — who decides, how, and the open/closed boundary |
|
|
789
815
|
| [Code of Conduct](CODE_OF_CONDUCT.md) | community | expected conduct (Contributor Covenant) |
|
|
790
816
|
| [Security policy](SECURITY.md) | reporters | how to report a vulnerability; dual-use note |
|
|
791
817
|
|
|
@@ -809,32 +835,37 @@ modelled) is in [`docs/VALIDATION.md`](docs/VALIDATION.md) and the per-release
|
|
|
809
835
|
[`kshana-validation-summary.html`](https://github.com/AshfordeOU/kshana/releases)
|
|
810
836
|
artifact (generated by `cargo run --bin validation_report`, SLSA-attested).
|
|
811
837
|
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
|
815
|
-
|
|
816
|
-
|
|
|
817
|
-
|
|
|
818
|
-
|
|
|
819
|
-
|
|
|
820
|
-
|
|
|
821
|
-
|
|
|
822
|
-
|
|
|
823
|
-
|
|
|
824
|
-
|
|
|
825
|
-
| Force-model fit vs
|
|
826
|
-
|
|
|
827
|
-
|
|
|
828
|
-
|
|
|
829
|
-
|
|
|
830
|
-
|
|
|
831
|
-
|
|
|
832
|
-
|
|
|
833
|
-
|
|
|
834
|
-
|
|
|
835
|
-
|
|
|
836
|
-
|
|
|
837
|
-
|
|
|
838
|
+
The **Status** column states the *kind* of evidence, matching the validation ladder above: **VALIDATED** = checked against an independent external oracle (real data, an independent library, or published reference vectors); **MODELLED** = checked against analytic truth or simulation self-consistency (no independent external dataset). VALIDATED describes the *method* of checking, not a pass/fail — an honest miss against real data (the LRO row) is still VALIDATED. `CI` rows are process guards, not figures of merit.
|
|
839
|
+
|
|
840
|
+
| Status | Capability | Agreement | Reference / oracle |
|
|
841
|
+
|--------|------------|-----------|--------------------|
|
|
842
|
+
| **VALIDATED** | SGP4/SDP4 propagation | 666/666 vectors, worst **4.12 mm** | AIAA 2006-6753 (Vallado `tcppver.out`) + head-to-head vs the independent `sgp4` crate |
|
|
843
|
+
| **VALIDATED** | Reference frames — IAU 2000A/B nutation, IAU 2006/2000A CIO chain, ERA | **bit-for-bit** (X,Y to 1e-14, s to 1e-18, ERA to 1e-12) | ERFA/SOFA `eraXys06a` · `eraC2ixys` · `eraEra00` · `eraNut00a/b` |
|
|
844
|
+
| **VALIDATED** | GCRS→ITRS vs an independent SPICE engine | max **0.028″** → ≤ 0.86 m ground, ≤ 3.6 m GNSS orbit | ANISE (pure-Rust NAIF/SPICE), same IERS `finals2000A` EOP, 8 epochs 2020–2023 |
|
|
845
|
+
| **MODELLED** | EGM2008 geopotential (degree/order 70) | acceleration = ∇V to **< 1e-6**; zonal collapse to validated J2 | NGA EGM2008 coefficients + analytic ∇V identity |
|
|
846
|
+
| **VALIDATED** | Allan estimators (ADEV/MDEV/TDEV/HDEV) + confidence bands | reproduce reference deviations; χ² bands match | NIST SP 1065 (Riley), 1000-point Table 31/32 |
|
|
847
|
+
| **MODELLED** | IMU error model — ARW / VRW / bias-instability | recovered to **< 5 %** (bias-instability < 15 %) | Analog Devices ADIS16465 datasheet; NaveGo reference profile |
|
|
848
|
+
| **MODELLED** | Numerical (Cowell) propagator, unperturbed | **sub-metre over 24 h**; energy/momentum conserve ~1e-9 | exact universal-variable Kepler |
|
|
849
|
+
| **MODELLED** | Lambert · Tsiolkovsky · porkchop | round-trip to two-body truth; ΔV **< 0.01 %** | Izzo 2015 · rocket equation · analytic Hohmann floor |
|
|
850
|
+
| **MODELLED** | Orbit determination (Gauss–Newton batch) | sub-m / mm·s⁻¹ noiseless; ~2 m at a 5 m noise floor | two-body + J2 over an RK4 arc |
|
|
851
|
+
| **VALIDATED** | Force-model fit vs Galileo precise ephemeris (full-arc) | **0.61 m** 3-D RMS, 24 h, d/o-70, force-only | ESA/ESOC `ESA0MGNFIN` final orbit (E11), real `finals2000A` EOP |
|
|
852
|
+
| **VALIDATED** | Force-model fit vs Swarm-A precise ephemeris (reduced-dynamic) | **0.10 m** 3-D RMS (empirical-tier bound, not a measure) | ESA `SW_OPER_SP3ACOM_2_` precise orbit |
|
|
853
|
+
| **VALIDATED** | Force-model fit vs LRO lunar (honest miss) | **6.6 m** reduced-dynamic, *above* the 5 m target | JPL Horizons LRO (NAIF −85) + GRAIL `GRGM660PRIM` |
|
|
854
|
+
| **MODELLED** | Deep-space Mars OD (reduced-dynamic SRIF) | **≈ 0.2 m** Mars-LMO (simulation FoM, *not* real-mission) | synthetic closed-loop OD — estimator-machinery validation |
|
|
855
|
+
| **VALIDATED** | Sun-central Mars dynamics vs JPL DE440 | **137 m @ 1-day arc** (grows with arc = unmodelled n-body) | JPL DE440 via ANISE (`xval/anise-mars-od`, kernel-gated) |
|
|
856
|
+
| **VALIDATED** | Single-point positioning vs a surveyed IGS coordinate (real observations) | **5.7 m** 3-D RMS / **1.1 m** horizontal, dual-frequency iono-free code SPP | IGS station ABMF survey + GPS broadcast ephemeris, 2018-05-13 (`tests/pvt_abmf.rs`) |
|
|
857
|
+
| **MODELLED** | Tightly-coupled GNSS/INS UKF | **0.77 m RMS** over a 30-min LEO pass incl. a 120 s outage | force-model coast, hand-derived |
|
|
858
|
+
| **MODELLED** | GPS-denied gravity-map navigation | ~70 km INS drift → **~145 m** recovered | ESA NAVISP *Quantum Wayfarer* target |
|
|
859
|
+
| **MODELLED** | Terrain-referenced navigation (TERCOM/SITAN) | 70 km drift → **< 500 m** (grid-resolution floor ~140 m) | SRTM `.hgt` DEM; hand-injected drift (non-circular check) |
|
|
860
|
+
| **MODELLED** | IGRF-14 main field (degree/order 13) | pole ~80.7°N, dipole ~29.7 µT, physical 22–67 µT band | IAGA `igrf14coeffs.txt` (Schmidt semi-normalised) |
|
|
861
|
+
| **MODELLED** | Nav-signal modulation & code tracking | BPSK self-SSC = **2/(3·R_c)**; unit-area PSDs; **sub-metre** C/A DLL jitter @ 45 dB-Hz | Closed-form SSC/PSD anchors + Kaplan & Hegarty DLL thermal-noise formula |
|
|
862
|
+
| **MODELLED** | CR3BP halo/NRHO differential corrector | STM = finite differences; orbit closes to **machine precision**; L2 9:2 NRHO **≈ 6.57 d / perilune ≈ 3,250 km** | finite-difference STM check + published L2 southern 9:2 NRHO (≈ 6.56 d / ≈ 3,370 km) — CR3BP, not a real Gateway ephemeris |
|
|
863
|
+
| **VALIDATED** | ARAIM dual-constellation integrity | constellation-wide fault mode on real GPS + Galileo | EU ARAIM TR / DO-316; Celestrak `gps-ops` 2021-07-28 |
|
|
864
|
+
| **VALIDATED** | GNSS geometry / DOP (GDOP/PDOP/HDOP/VDOP/TDOP) | match to **1e-6 relative** across 8 geometries (well-conditioned → near-singular) | gnss_lib_py 1.0.4 (Stanford NAV Lab) — independent library (`tests/dop_reference.rs`) |
|
|
865
|
+
| **VALIDATED** | ML detector-evaluation metrics (AUC/ROC/confusion/Pd-Pmd/precision/F1) | **exact counts + < 1e-9** over 5 datasets × 24 thresholds | scikit-learn 1.9.0 (Pedregosa et al., JMLR 2011) — independent library (`tests/eval_metrics_reference.rs`) |
|
|
866
|
+
| **VALIDATED** | Quantum-trade numerical kernels (ADEV NNLS fit · χ² consistency bands · van-Loan clock Q) | NNLS + Q **exact**; χ² **< 5e-4** at operating dof ≥ 48 | scipy 1.17.1 — `optimize.nnls` / `stats.chi2.ppf` / `linalg.expm` (`tests/scipy_reference.rs`) |
|
|
867
|
+
| CI | Cross-platform reproducibility | bit-identical input + shape goldens on 3 OSes | Linux / macOS / Windows CI matrix, SHA-256 goldens |
|
|
868
|
+
| CI | Test coverage | **~96 % line** on `src/`, gated ≥ 85 % | cargo-tarpaulin (LLVM engine) |
|
|
838
869
|
|
|
839
870
|
## FAQ
|
|
840
871
|
|
|
@@ -865,8 +896,12 @@ Write a scenario `.toml` with your sensor's published figures in the `provenance
|
|
|
865
896
|
fields. See [Scenario format](#scenario-format) and the examples in `scenarios/`.
|
|
866
897
|
|
|
867
898
|
**Is it free for commercial use?**
|
|
868
|
-
Yes
|
|
869
|
-
|
|
899
|
+
Yes — under the AGPL-3.0, including in commercial settings, as long as you honour the
|
|
900
|
+
AGPL's copyleft (notably: if you modify Kshana and offer it over a network, you must
|
|
901
|
+
offer those users your modified source). If that does not suit you — e.g. you need to
|
|
902
|
+
embed Kshana in a proprietary product or run a closed network service — a commercial
|
|
903
|
+
licence is available from Ashforde OÜ; see [`LICENSING.md`](LICENSING.md) and
|
|
904
|
+
[Support](#support--professional-services).
|
|
870
905
|
|
|
871
906
|
## Troubleshooting
|
|
872
907
|
|
|
@@ -928,7 +963,7 @@ entry for every user-visible change. Participation is governed by our
|
|
|
928
963
|
|
|
929
964
|
If you use Kshana in academic or technical work, please cite it. Machine-readable
|
|
930
965
|
metadata is in [`CITATION.cff`](CITATION.cff) (GitHub renders a "Cite this repository"
|
|
931
|
-
button from it); cite the version you used (e.g. `v0.
|
|
966
|
+
button from it); cite the version you used (e.g. `v0.19.0`) together with the
|
|
932
967
|
scenario and seed for full reproducibility. Every release is archived on Zenodo with
|
|
933
968
|
a citable DOI — the concept DOI [10.5281/zenodo.20528627](https://doi.org/10.5281/zenodo.20528627)
|
|
934
969
|
always resolves to the latest version.
|
|
@@ -963,16 +998,22 @@ library); the JetBrains plugin versions independently (it shells out to your ins
|
|
|
963
998
|
|
|
964
999
|
## License
|
|
965
1000
|
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
1001
|
+
**Dual-licensed.** Use Kshana under **either** the GNU **AGPL-3.0-only** (see
|
|
1002
|
+
[`LICENSE`](LICENSE)) **or** a **commercial licence** from Ashforde OÜ for
|
|
1003
|
+
proprietary/closed integration that the AGPL does not suit. Which one applies, and
|
|
1004
|
+
why it is set up this way, is explained in [`LICENSING.md`](LICENSING.md).
|
|
1005
|
+
|
|
1006
|
+
Contributions are licensed inbound under the AGPL **and** grant Ashforde OÜ the right
|
|
1007
|
+
to include them in the commercially-licensed edition (so the dual-licence keeps
|
|
1008
|
+
working) — see [`CONTRIBUTING.md`](CONTRIBUTING.md). Sign off each commit per the
|
|
1009
|
+
Developer Certificate of Origin with `git commit -s`.
|
|
969
1010
|
|
|
970
|
-
**Trademark.** "Kshana" and its marks are trademarks of Ashforde OÜ. The
|
|
1011
|
+
**Trademark.** "Kshana" and its marks are trademarks of Ashforde OÜ. The licence
|
|
971
1012
|
covers the code, not the name — please rename forks and derivative distributions.
|
|
972
1013
|
|
|
973
1014
|
## Support & professional services
|
|
974
1015
|
|
|
975
|
-
Kshana is free and open source under
|
|
1016
|
+
Kshana is free and open source under the AGPL-3.0 and **professionally developed and
|
|
976
1017
|
maintained by Ashforde OÜ** (Estonia). The open engine is complete and usable on its
|
|
977
1018
|
own. For organisations that need more, Ashforde OÜ offers:
|
|
978
1019
|
|
|
@@ -996,6 +1037,9 @@ Contact **contact@ashforde.org**.
|
|
|
996
1037
|
- IAU [SOFA](https://www.iausofa.org/) / [ERFA](https://github.com/liberfa/erfa) — the reference time and frame routines the IAU 2000A nutation and the CIO GCRS↔ITRS reduction are validated bit-for-bit against.
|
|
997
1038
|
- Petit & Luzum (eds.) — *IERS Conventions (2010)*, [IERS TN 36](https://www.iers.org/IERS/EN/Publications/TechnicalNotes/tn36.html) (Earth-orientation, polar motion, and frame standards).
|
|
998
1039
|
- Riley — *Handbook of Frequency Stability Analysis*, [NIST SP 1065](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication1065.pdf) (Allan-deviation relations and the NBS14 reference series).
|
|
1040
|
+
- Pedregosa et al. — *scikit-learn: Machine Learning in Python*, [JMLR 12 (2011)](https://jmlr.org/papers/v12/pedregosa11a.html): the reference ROC/AUC, confusion-matrix and precision/recall/F1 implementations the RF-impairment evaluation testbed is matched to exactly (`tests/eval_metrics_reference.rs`).
|
|
1041
|
+
- Virtanen et al. — *SciPy 1.0*, [Nature Methods 17 (2020)](https://doi.org/10.1038/s41592-019-0686-2): `optimize.nnls`, `stats.chi2` and `linalg.expm` — the reference routines the quantum-trade measured-ADEV NNLS fit, the χ² consistency bands, and the van-Loan clock process-noise covariance are validated against (`tests/scipy_reference.rs`).
|
|
1042
|
+
- Knowles, Kanhere, Neamati & Gao — *gnss_lib_py*, [SoftwareX 27 (2024)](https://doi.org/10.1016/j.softx.2024.101811): used both as open prior art (see *Comparison & open prior art* below) and as the **independent DOP oracle** the GDOP/PDOP/HDOP/VDOP/TDOP computation is matched to 1e-6 (`tests/dop_reference.rs`).
|
|
999
1043
|
- Montenbruck & Gill — *Satellite Orbits: Models, Methods and Applications* ([Springer](https://doi.org/10.1007/978-3-642-58351-3)): the force models behind the force-model fit to agency precise ephemerides.
|
|
1000
1044
|
- Howell — *Three-dimensional, periodic, halo orbits*, Celestial Mechanics 32(1) (1984), [doi:10.1007/BF01358403](https://doi.org/10.1007/BF01358403); Zimovan-Spreen, Howell & Davis — *Near rectilinear halo orbits and nearby higher-period dynamical structures*, Astrodynamics 6 (2022), [doi:10.1007/s42064-021-0125-x](https://doi.org/10.1007/s42064-021-0125-x) (the halo/NRHO families the CR3BP differential corrector reproduces).
|
|
1001
1045
|
|
package/kshana_bg.wasm
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
"Chakshu Baweja <contact@ashforde.org>"
|
|
6
6
|
],
|
|
7
7
|
"description": "Open, reproducible PNT-resilience simulator with quantum-sensor performance models",
|
|
8
|
-
"version": "0.
|
|
9
|
-
"license": "
|
|
8
|
+
"version": "0.19.0",
|
|
9
|
+
"license": "AGPL-3.0-only",
|
|
10
10
|
"repository": {
|
|
11
11
|
"type": "git",
|
|
12
12
|
"url": "https://github.com/AshfordeOU/kshana"
|