Compare commits
No commits in common. "master" and "72ba33898995d261f5746ba843a07d8b1c75811c" have entirely different histories.
master
...
72ba338989
36 changed files with 1584 additions and 1316 deletions
|
|
@ -1,2 +0,0 @@
|
||||||
# See https://domluna.github.io/JuliaFormatter.jl/stable/ for a list of options
|
|
||||||
style = "blue"
|
|
||||||
96
.gitignore
vendored
96
.gitignore
vendored
|
|
@ -1,96 +0,0 @@
|
||||||
### Linux gitignore ###
|
|
||||||
*~
|
|
||||||
|
|
||||||
# temporary files which can be created if a process still has a handle open of a deleted file
|
|
||||||
.fuse_hidden*
|
|
||||||
|
|
||||||
# Metadata left by Dolphin file manager, which comes with KDE Plasma
|
|
||||||
.directory
|
|
||||||
|
|
||||||
# Linux trash folder which might appear on any partition or disk
|
|
||||||
.Trash-*
|
|
||||||
|
|
||||||
# .nfs files are created when an open file is removed but is still being accessed
|
|
||||||
.nfs*
|
|
||||||
|
|
||||||
# Log files created by default by the nohup command
|
|
||||||
nohup.out
|
|
||||||
|
|
||||||
### MacOS gitignore ###
|
|
||||||
# General
|
|
||||||
.DS_Store
|
|
||||||
__MACOSX/
|
|
||||||
.AppleDouble
|
|
||||||
.LSOverride
|
|
||||||
Icon[]
|
|
||||||
|
|
||||||
# Thumbnails
|
|
||||||
._*
|
|
||||||
|
|
||||||
# Files that might appear in the root of a volume
|
|
||||||
.DocumentRevisions-V100
|
|
||||||
.fseventsd
|
|
||||||
.Spotlight-V100
|
|
||||||
.TemporaryItems
|
|
||||||
.Trashes
|
|
||||||
.VolumeIcon.icns
|
|
||||||
.com.apple.timemachine.donotpresent
|
|
||||||
|
|
||||||
# Directories potentially created on remote AFP share
|
|
||||||
.AppleDB
|
|
||||||
.AppleDesktop
|
|
||||||
Network Trash Folder
|
|
||||||
Temporary Items
|
|
||||||
.apdisk
|
|
||||||
|
|
||||||
### Vim gitignore ###
|
|
||||||
# Swap
|
|
||||||
[._]*.s[a-v][a-z]
|
|
||||||
# comment out the next line if you don't need vector files
|
|
||||||
!*.svg
|
|
||||||
[._]*.sw[a-p]
|
|
||||||
[._]s[a-rt-v][a-z]
|
|
||||||
[._]ss[a-gi-z]
|
|
||||||
[._]sw[a-p]
|
|
||||||
|
|
||||||
# Session
|
|
||||||
Session.vim
|
|
||||||
Sessionx.vim
|
|
||||||
|
|
||||||
# Temporary
|
|
||||||
.netrwhist
|
|
||||||
*~
|
|
||||||
# Auto-generated tag files
|
|
||||||
tags
|
|
||||||
# Persistent undo
|
|
||||||
[._]*.un~
|
|
||||||
|
|
||||||
### Julia gitignore ###
|
|
||||||
# Files generated by invoking Julia with --code-coverage
|
|
||||||
*.jl.cov
|
|
||||||
*.jl.*.cov
|
|
||||||
|
|
||||||
# Files generated by invoking Julia with --track-allocation
|
|
||||||
*.jl.mem
|
|
||||||
|
|
||||||
# System-specific files and directories generated by the BinaryProvider and BinDeps packages
|
|
||||||
# They contain absolute paths specific to the host computer, and so should not be committed
|
|
||||||
deps/deps.jl
|
|
||||||
deps/build.log
|
|
||||||
deps/downloads/
|
|
||||||
deps/usr/
|
|
||||||
deps/src/
|
|
||||||
|
|
||||||
# Build artifacts for creating documentation generated by the Documenter package
|
|
||||||
docs/build/
|
|
||||||
docs/site/
|
|
||||||
|
|
||||||
# File generated by Pkg, the package manager, based on a corresponding Project.toml
|
|
||||||
# It records a fixed state of all packages used by the project. As such, it should not be
|
|
||||||
# committed for packages, but should be committed for applications that require a static
|
|
||||||
# environment.
|
|
||||||
Manifest*.toml
|
|
||||||
|
|
||||||
# File generated by the Preferences package to store local preferences
|
|
||||||
LocalPreferences.toml
|
|
||||||
JuliaLocalPreferences.toml
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
when:
|
|
||||||
branch: master
|
|
||||||
event: push
|
|
||||||
|
|
||||||
clone:
|
|
||||||
git:
|
|
||||||
image: woodpeckerci/plugin-git
|
|
||||||
settings:
|
|
||||||
partial: false
|
|
||||||
depth: 0
|
|
||||||
|
|
||||||
steps:
|
|
||||||
docs:
|
|
||||||
image: julia:1
|
|
||||||
commands:
|
|
||||||
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
|
|
||||||
- julia --project=docs/ docs/make.jl
|
|
||||||
environment:
|
|
||||||
JULIA_NUM_THREADS: "1"
|
|
||||||
PROJECT_ACCESS_TOKEN:
|
|
||||||
from_secret: project_access_token
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
matrix:
|
|
||||||
JULIA_VERSION:
|
|
||||||
- "1.12"
|
|
||||||
- "1"
|
|
||||||
- "rc"
|
|
||||||
|
|
||||||
when:
|
|
||||||
event: [pull_request, push]
|
|
||||||
|
|
||||||
steps:
|
|
||||||
test:
|
|
||||||
image: julia:${JULIA_VERSION}
|
|
||||||
pull: true
|
|
||||||
commands:
|
|
||||||
- julia -e 'using InteractiveUtils; versioninfo()'
|
|
||||||
- julia --project=@. -e 'using Pkg; Pkg.instantiate(); Pkg.build(); Pkg.test();'
|
|
||||||
environment:
|
|
||||||
JULIA_NUM_THREADS: "1"
|
|
||||||
690
LICENSE
690
LICENSE
|
|
@ -1,690 +0,0 @@
|
||||||
Copyright (C) 2026 Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
|
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
17
Project.toml
17
Project.toml
|
|
@ -1,17 +0,0 @@
|
||||||
name = "CualerID"
|
|
||||||
uuid = "a4892dd5-cee5-4429-912e-1922c40e7f9b"
|
|
||||||
version = "0.0.1"
|
|
||||||
authors = ["Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors"]
|
|
||||||
|
|
||||||
[deps]
|
|
||||||
ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"
|
|
||||||
FilePathsBase = "48062228-2e41-5def-b9a4-89aafe57970f"
|
|
||||||
UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
|
|
||||||
|
|
||||||
[compat]
|
|
||||||
ArgParse = "1.2.0"
|
|
||||||
FilePathsBase = "0.9.24"
|
|
||||||
UUIDs = "1.11.0"
|
|
||||||
julia = "1.12"
|
|
||||||
|
|
||||||
[apps.cualer-id]
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
# CualerID
|
|
||||||
|
|
||||||
[](https://github.com/invenia/BlueStyle)
|
|
||||||
[](https://github.com/JuliaTesting/Aqua.jl)
|
|
||||||
1
dev/.documenter-siteinfo.json
Normal file
1
dev/.documenter-siteinfo.json
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
{"documenter":{"julia_version":"1.12.5","generation_timestamp":"2026-02-13T03:53:22","documenter_version":"1.16.1"}}
|
||||||
1376
dev/assets/documenter.js
Normal file
1376
dev/assets/documenter.js
Normal file
File diff suppressed because it is too large
Load diff
1
dev/assets/themes/catppuccin-frappe.css
Normal file
1
dev/assets/themes/catppuccin-frappe.css
Normal file
File diff suppressed because one or more lines are too long
1
dev/assets/themes/catppuccin-latte.css
Normal file
1
dev/assets/themes/catppuccin-latte.css
Normal file
File diff suppressed because one or more lines are too long
1
dev/assets/themes/catppuccin-macchiato.css
Normal file
1
dev/assets/themes/catppuccin-macchiato.css
Normal file
File diff suppressed because one or more lines are too long
1
dev/assets/themes/catppuccin-mocha.css
Normal file
1
dev/assets/themes/catppuccin-mocha.css
Normal file
File diff suppressed because one or more lines are too long
7
dev/assets/themes/documenter-dark.css
Normal file
7
dev/assets/themes/documenter-dark.css
Normal file
File diff suppressed because one or more lines are too long
9
dev/assets/themes/documenter-light.css
Normal file
9
dev/assets/themes/documenter-light.css
Normal file
File diff suppressed because one or more lines are too long
84
dev/assets/themeswap.js
Normal file
84
dev/assets/themeswap.js
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
// Small function to quickly swap out themes. Gets put into the <head> tag..
|
||||||
|
function set_theme_from_local_storage() {
|
||||||
|
// Initialize the theme to null, which means default
|
||||||
|
var theme = null;
|
||||||
|
// If the browser supports the localstorage and is not disabled then try to get the
|
||||||
|
// documenter theme
|
||||||
|
if (window.localStorage != null) {
|
||||||
|
// Get the user-picked theme from localStorage. May be `null`, which means the default
|
||||||
|
// theme.
|
||||||
|
theme = window.localStorage.getItem("documenter-theme");
|
||||||
|
}
|
||||||
|
// Check if the users preference is for dark color scheme
|
||||||
|
var darkPreference =
|
||||||
|
window.matchMedia("(prefers-color-scheme: dark)").matches === true;
|
||||||
|
// Initialize a few variables for the loop:
|
||||||
|
//
|
||||||
|
// - active: will contain the index of the theme that should be active. Note that there
|
||||||
|
// is no guarantee that localStorage contains sane values. If `active` stays `null`
|
||||||
|
// we either could not find the theme or it is the default (primary) theme anyway.
|
||||||
|
// Either way, we then need to stick to the primary theme.
|
||||||
|
//
|
||||||
|
// - disabled: style sheets that should be disabled (i.e. all the theme style sheets
|
||||||
|
// that are not the currently active theme)
|
||||||
|
var active = null;
|
||||||
|
var disabled = [];
|
||||||
|
var primaryLightTheme = null;
|
||||||
|
var primaryDarkTheme = null;
|
||||||
|
for (var i = 0; i < document.styleSheets.length; i++) {
|
||||||
|
var ss = document.styleSheets[i];
|
||||||
|
// The <link> tag of each style sheet is expected to have a data-theme-name attribute
|
||||||
|
// which must contain the name of the theme. The names in localStorage much match this.
|
||||||
|
var themename = ss.ownerNode.getAttribute("data-theme-name");
|
||||||
|
// attribute not set => non-theme stylesheet => ignore
|
||||||
|
if (themename === null) continue;
|
||||||
|
// To distinguish the default (primary) theme, it needs to have the data-theme-primary
|
||||||
|
// attribute set.
|
||||||
|
if (ss.ownerNode.getAttribute("data-theme-primary") !== null) {
|
||||||
|
primaryLightTheme = themename;
|
||||||
|
}
|
||||||
|
// Check if the theme is primary dark theme so that we could store its name in darkTheme
|
||||||
|
if (ss.ownerNode.getAttribute("data-theme-primary-dark") !== null) {
|
||||||
|
primaryDarkTheme = themename;
|
||||||
|
}
|
||||||
|
// If we find a matching theme (and it's not the default), we'll set active to non-null
|
||||||
|
if (themename === theme) active = i;
|
||||||
|
// Store the style sheets of inactive themes so that we could disable them
|
||||||
|
if (themename !== theme) disabled.push(ss);
|
||||||
|
}
|
||||||
|
var activeTheme = null;
|
||||||
|
if (active !== null) {
|
||||||
|
// If we did find an active theme, we'll (1) add the theme--$(theme) class to <html>
|
||||||
|
document.getElementsByTagName("html")[0].className = "theme--" + theme;
|
||||||
|
activeTheme = theme;
|
||||||
|
} else {
|
||||||
|
// If we did _not_ find an active theme, then we need to fall back to the primary theme
|
||||||
|
// which can either be dark or light, depending on the user's OS preference.
|
||||||
|
var activeTheme = darkPreference ? primaryDarkTheme : primaryLightTheme;
|
||||||
|
// In case it somehow happens that the relevant primary theme was not found in the
|
||||||
|
// preceding loop, we abort without doing anything.
|
||||||
|
if (activeTheme === null) {
|
||||||
|
console.error("Unable to determine primary theme.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// When switching to the primary light theme, then we must not have a class name
|
||||||
|
// for the <html> tag. That's only for non-primary or the primary dark theme.
|
||||||
|
if (darkPreference) {
|
||||||
|
document.getElementsByTagName("html")[0].className =
|
||||||
|
"theme--" + activeTheme;
|
||||||
|
} else {
|
||||||
|
document.getElementsByTagName("html")[0].className = "";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (var i = 0; i < document.styleSheets.length; i++) {
|
||||||
|
var ss = document.styleSheets[i];
|
||||||
|
// The <link> tag of each style sheet is expected to have a data-theme-name attribute
|
||||||
|
// which must contain the name of the theme. The names in localStorage much match this.
|
||||||
|
var themename = ss.ownerNode.getAttribute("data-theme-name");
|
||||||
|
// attribute not set => non-theme stylesheet => ignore
|
||||||
|
if (themename === null) continue;
|
||||||
|
// we'll disable all the stylesheets, except for the active one
|
||||||
|
ss.disabled = !(themename == activeTheme);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
set_theme_from_local_storage();
|
||||||
68
dev/assets/warner.js
Normal file
68
dev/assets/warner.js
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
function maybeAddWarning() {
|
||||||
|
// DOCUMENTER_NEWEST is defined in versions.js, DOCUMENTER_CURRENT_VERSION and DOCUMENTER_STABLE
|
||||||
|
// in siteinfo.js. DOCUMENTER_IS_DEV_VERSION is optional and defined in siteinfo.js.
|
||||||
|
// If the required variables are undefined something went horribly wrong, so we abort.
|
||||||
|
if (
|
||||||
|
window.DOCUMENTER_NEWEST === undefined ||
|
||||||
|
window.DOCUMENTER_CURRENT_VERSION === undefined ||
|
||||||
|
window.DOCUMENTER_STABLE === undefined
|
||||||
|
) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Current version is not a version number, so we can't tell if it's the newest version. Abort.
|
||||||
|
if (!/v(\d+\.)*\d+/.test(window.DOCUMENTER_CURRENT_VERSION)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Current version is newest version, so no need to add a warning.
|
||||||
|
if (window.DOCUMENTER_NEWEST === window.DOCUMENTER_CURRENT_VERSION) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add a noindex meta tag (unless one exists) so that search engines don't index this version of the docs.
|
||||||
|
if (document.body.querySelector('meta[name="robots"]') === null) {
|
||||||
|
const meta = document.createElement("meta");
|
||||||
|
meta.name = "robots";
|
||||||
|
meta.content = "noindex";
|
||||||
|
|
||||||
|
document.getElementsByTagName("head")[0].appendChild(meta);
|
||||||
|
}
|
||||||
|
|
||||||
|
const div = document.createElement("div");
|
||||||
|
// Base class is added by default
|
||||||
|
div.classList.add("warning-overlay-base");
|
||||||
|
const closer = document.createElement("button");
|
||||||
|
closer.classList.add("outdated-warning-closer", "delete");
|
||||||
|
closer.addEventListener("click", function () {
|
||||||
|
document.body.removeChild(div);
|
||||||
|
});
|
||||||
|
const href = window.documenterBaseURL + "/../" + window.DOCUMENTER_STABLE;
|
||||||
|
|
||||||
|
// Determine if this is a development version or an older release
|
||||||
|
let warningMessage = "";
|
||||||
|
if (window.DOCUMENTER_IS_DEV_VERSION === true) {
|
||||||
|
div.classList.add("dev-warning-overlay");
|
||||||
|
warningMessage =
|
||||||
|
"This documentation is for the <strong>development version</strong> and may contain unstable or unreleased features.<br>";
|
||||||
|
} else {
|
||||||
|
div.classList.add("outdated-warning-overlay");
|
||||||
|
warningMessage =
|
||||||
|
"This documentation is for an <strong>older version</strong> that may be missing recent changes.<br>";
|
||||||
|
}
|
||||||
|
|
||||||
|
warningMessage +=
|
||||||
|
'<a href="' +
|
||||||
|
href +
|
||||||
|
'">Click here to go to the documentation for the latest stable release.</a>';
|
||||||
|
|
||||||
|
div.innerHTML = warningMessage;
|
||||||
|
div.appendChild(closer);
|
||||||
|
document.body.appendChild(div);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (document.readyState === "loading") {
|
||||||
|
document.addEventListener("DOMContentLoaded", maybeAddWarning);
|
||||||
|
} else {
|
||||||
|
maybeAddWarning();
|
||||||
|
}
|
||||||
23
dev/index.html
Normal file
23
dev/index.html
Normal file
File diff suppressed because one or more lines are too long
BIN
dev/objects.inv
Normal file
BIN
dev/objects.inv
Normal file
Binary file not shown.
3
dev/search_index.js
Normal file
3
dev/search_index.js
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
var documenterSearchIndex = {"docs":
|
||||||
|
[{"location":"#CualerID","page":"Home","title":"CualerID","text":"Documentation for CualerID.\n\n","category":"section"},{"location":"#CualerID.BASE30_ALPHABET","page":"Home","title":"CualerID.BASE30_ALPHABET","text":"BASE30_ALPHABET::Vector{UInt8}\n\nAn alphabet designed for unambiguous representation of values in either upper- or lower-case. The alphabet was formed by taking the numbers 0-9 and the Latin alphabet and removing characters that are considered easy to confuse. Excluded characters are\n\nI => easily confused for lowercase L or the digit 1\nL => easily confused for uppercase I or the digit 1\nO => easily confused for the digit 0\nQ => easily confused with uppercase O or lowercase g\nV => easily confused with U\n\nThis array contains the ASCII index of the characters included in the base30 alphabet starting with 0 at position BASE30_ALPHABET[1]. Use String() to convert an array of these indices to a base30 string.\n\n\n\n\n\n","category":"constant"},{"location":"#CualerID.ResultCode","page":"Home","title":"CualerID.ResultCode","text":"ResultCode::UInt8\n\nEncodes a result of attempting to correct a CualerID\n\nThe valid codes are\n\nD: duplicate\nF: fixed\nN: not fixable\nV: valid (no need for correction)\n\n\n\n\n\n","category":"type"},{"location":"#CualerID.ResultCodeOption","page":"Home","title":"CualerID.ResultCodeOption","text":"ResultCodeOption\n\nEncodes potential corrected id codes.\n\nThe valid codes are\n\nD: duplicate\nF: fixed\nN: not fixable\nV: valid (no need for correction)\n\nThe codes are implemented exactly as from cual-id and in that order\n\nConstructors\n\nResultCodeOption(str::AbstractString)\n\nCreate a ResultCodeOption based on a the character codes contained within str. str is case insensitive, may contain an arbitrary number of valid codes (as specified above), and may contain duplicates. A ResultCodeOption cannot be constructed from a combination of strings and bitmasks/integers.\n\nExtended help\n\nThe struct stores values as a bitmask\n\nBit (Int) Bit (UInt) Description\n1 0x01 D - duplicate\n2 0x02 F - fixed\n4 0x04 N - not fixable\n8 0x08 V - valid\n\n\n\n\n\n","category":"type"},{"location":"#CualerID.base30encode-Tuple{Integer}","page":"Home","title":"CualerID.base30encode","text":"base30encode(v::Integer)\nbase30encode(v::UUID)\n\nCreates a base30 representation of v. If v is a UUID, then the UInt128 value of the UUID is passed directly into the method.\n\nExamples\n\njulia> base30encode(30)\n\"10\"\n\njulia> using UUIDs\n\njulia> base30encode(UUIDs.uuid1())\n\"7ZK00JECBDF2H7GNBXN59C6S9S\"\n\nwarning: Warning\nJust like rebase, this method is not tested on negative integers and may produce incorrect output when passed negative numbers\n\n\n\n\n\n","category":"method"},{"location":"#CualerID.has_duplicate-Tuple{ResultCodeOption}","page":"Home","title":"CualerID.has_duplicate","text":"has_duplicate(r::ResultCodeOption)\n\nDetermines if r contains a duplicate result (ResultCode D)\n\n\n\n\n\n","category":"method"},{"location":"#CualerID.has_fixed-Tuple{ResultCodeOption}","page":"Home","title":"CualerID.has_fixed","text":"has_fixed(r::ResultCodeOption)\n\nDetermines if r contains a fixed result (ResultCode F)\n\n\n\n\n\n","category":"method"},{"location":"#CualerID.has_not_fixable-Tuple{ResultCodeOption}","page":"Home","title":"CualerID.has_not_fixable","text":"has_not_fixable(r::ResultCodeOption)\n\nDetermines if r contains a not fixable result (ResultCode N)\n\n\n\n\n\n","category":"method"},{"location":"#CualerID.has_valid-Tuple{ResultCodeOption}","page":"Home","title":"CualerID.has_valid","text":"has_valid(r::ResultCodeOption)\n\nDetermines if r contains a valid (not corrected) result (ResultCode V)\n\n\n\n\n\n","category":"method"},{"location":"#CualerID.rebase-Tuple{Integer, Integer}","page":"Home","title":"CualerID.rebase","text":"rebase(v::Integer, base::Integer)\n\nRebase v into the base system of base. v can be any integer type, and can be represented in base 10 (decimal) or base 16 (hexadecimal) based on Julia's treatment of that integer type. Returns a Vector{UInt8} containing the indices of each digit in the rebased number. Since Julia is 1-indexed, this means that rebase(0, base)[1] actually returns a value of UInt8[1], since the first index of a numeral system's alphabet is assumed to be its 0 value.\n\nExamples\n\njulia> rebase(0, 10)\n1-element Vector{UInt8}:\n 0x01\n\njulia> # Two plus two is ten... IN BASE FOUR! I'M FINE!\n\njulia> rebase(2 + 2, 4)\n2-element Vector{UInt8}:\n 0x02\n 0x01\n\njulia> base_4_alphabet = ['0', '1', '2', '3'];\n\njulia> String([base_4_alphabet[i] for i in rebase(2 + 2, 4)])\n\"10\"\n\nwarning: Warning\nThis method is not tested on negative integers and may produce incorrect output when passed negative numbers\n\n\n\n\n\n","category":"method"}]
|
||||||
|
}
|
||||||
2
dev/siteinfo.js
Normal file
2
dev/siteinfo.js
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
var DOCUMENTER_CURRENT_VERSION = "dev";
|
||||||
|
var DOCUMENTER_IS_DEV_VERSION = true;
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
[deps]
|
|
||||||
CualerID = "a4892dd5-cee5-4429-912e-1922c40e7f9b"
|
|
||||||
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
|
|
||||||
46
docs/make.jl
46
docs/make.jl
|
|
@ -1,46 +0,0 @@
|
||||||
using CualerID
|
|
||||||
using Documenter
|
|
||||||
|
|
||||||
DocMeta.setdocmeta!(CualerID, :DocTestSetup, :(using CualerID); recursive = true)
|
|
||||||
|
|
||||||
struct Gitea <: Documenter.Remote
|
|
||||||
host::String
|
|
||||||
user::String
|
|
||||||
repo::String
|
|
||||||
end #struct
|
|
||||||
|
|
||||||
function Documenter.Remotes.repourl(remote::Gitea)
|
|
||||||
return "https://$(remote.host)/$(remote.user)/$(remote.repo)"
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function Documenter.Remotes.fileurl(remote::Gitea, ref, filename, linerange = nothing)
|
|
||||||
linerange_addition = if !isnothing(linerange)
|
|
||||||
if first(linerange) == last(linerange)
|
|
||||||
"#L$(first(linerange))"
|
|
||||||
else
|
|
||||||
"#L$(first(linerange))-L$(last(linerange))"
|
|
||||||
end #if
|
|
||||||
else
|
|
||||||
""
|
|
||||||
end #if
|
|
||||||
return "https://$(remote.host)/$(remote.user)/$(remote.repo)/src/commit/$ref/$filename$linerange_addition"
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function Documenter.Remotes.issueurl(remote::Gitea, issuenumber)
|
|
||||||
return "https://$(remote.host)/$(remote.user)/$(remote.repo)/issues/$issuenumber"
|
|
||||||
end #function
|
|
||||||
|
|
||||||
makedocs(;
|
|
||||||
modules = [CualerID],
|
|
||||||
authors = "Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com> and contributors",
|
|
||||||
sitename = "CualerID.jl",
|
|
||||||
repo = Gitea("code.millironx.com", "millironx", "CualerID.jl"),
|
|
||||||
format = Documenter.HTML(; edit_link = "", assets = String[]),
|
|
||||||
pages = ["Home" => "index.md"],
|
|
||||||
)
|
|
||||||
|
|
||||||
deploydocs(;
|
|
||||||
repo = "code.millironx.com/millironx/CualerID.jl",
|
|
||||||
devbranch = "master",
|
|
||||||
branch = "pages",
|
|
||||||
)
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
```@meta
|
|
||||||
CurrentModule = CualerID
|
|
||||||
```
|
|
||||||
|
|
||||||
# CualerID
|
|
||||||
|
|
||||||
Documentation for [CualerID](https://code.millironx.com/millironx/CualerID.jl).
|
|
||||||
|
|
||||||
```@index
|
|
||||||
```
|
|
||||||
|
|
||||||
```@autodocs
|
|
||||||
Modules = [CualerID]
|
|
||||||
```
|
|
||||||
2
index.html
Normal file
2
index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
<!--This file is automatically generated by Documenter.jl-->
|
||||||
|
<meta http-equiv="refresh" content="0; url=./dev/"/>
|
||||||
|
|
@ -1,54 +0,0 @@
|
||||||
"""
|
|
||||||
BASE30_ALPHABET::Vector{UInt8}
|
|
||||||
|
|
||||||
An alphabet designed for unambiguous representation of values in either upper-
|
|
||||||
or lower-case. The alphabet was formed by taking the numbers 0-9 and the Latin
|
|
||||||
alphabet and removing characters that are considered easy to confuse. Excluded
|
|
||||||
characters are
|
|
||||||
|
|
||||||
- ``I`` => easily confused for lowercase ``L`` or the digit ``1``
|
|
||||||
- ``L`` => easily confused for uppercase ``I`` or the digit ``1``
|
|
||||||
- ``O`` => easily confused for the digit ``0``
|
|
||||||
- ``Q`` => easily confused with uppercase ``O`` or lowercase ``g``
|
|
||||||
- ``V`` => easily confused with ``U``
|
|
||||||
|
|
||||||
This array contains the ASCII index of the characters included in the base30
|
|
||||||
alphabet starting with 0 at position `BASE30_ALPHABET[1]`. Use `String()` to
|
|
||||||
convert an array of these indices to a base30 string.
|
|
||||||
"""
|
|
||||||
const BASE30_ALPHABET = UInt8.([
|
|
||||||
48:57..., #0-9
|
|
||||||
65:72..., #A-H
|
|
||||||
74:75..., #J-K
|
|
||||||
77:78..., #M-N
|
|
||||||
80, #P
|
|
||||||
83:85..., #S-U
|
|
||||||
87:90..., #W-Z
|
|
||||||
])
|
|
||||||
|
|
||||||
"""
|
|
||||||
base30encode(v::Integer)
|
|
||||||
base30encode(v::UUID)
|
|
||||||
|
|
||||||
Creates a base30 representation of `v`. If `v` is a `UUID`, then the `UInt128`
|
|
||||||
value of the `UUID` is passed directly into the method.
|
|
||||||
|
|
||||||
# Examples
|
|
||||||
|
|
||||||
```jldoctest
|
|
||||||
julia> base30encode(30)
|
|
||||||
"10"
|
|
||||||
```
|
|
||||||
|
|
||||||
```julia-repl
|
|
||||||
julia> using UUIDs; base30encode(uuid1())
|
|
||||||
"7ZK00JECBDF2H7GNBXN59C6S9S"
|
|
||||||
```
|
|
||||||
"""
|
|
||||||
function base30encode(v::Integer)
|
|
||||||
return String([BASE30_ALPHABET[i] for i in reverse(digits(v; base = 30) .+ 1)])
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function base30encode(v::UUID)
|
|
||||||
return base30encode(v.value)
|
|
||||||
end #function
|
|
||||||
174
src/CualerID.jl
174
src/CualerID.jl
|
|
@ -1,174 +0,0 @@
|
||||||
module CualerID
|
|
||||||
|
|
||||||
using ArgParse: ArgParse, ArgParseSettings, parse_args, parse_item, @add_arg_table!
|
|
||||||
using FilePathsBase: AbstractPath, Path, exists, isfile
|
|
||||||
using UUIDs: UUID
|
|
||||||
|
|
||||||
include("Base30.jl")
|
|
||||||
include("ResultCodeOption.jl")
|
|
||||||
include("Minting.jl")
|
|
||||||
|
|
||||||
export ResultCode
|
|
||||||
export ResultCodeOption
|
|
||||||
export base30encode
|
|
||||||
export has_duplicate
|
|
||||||
export has_fixed
|
|
||||||
export has_not_fixable
|
|
||||||
export has_valid
|
|
||||||
|
|
||||||
function _create_arg_table()
|
|
||||||
s = ArgParseSettings(autofix_names = true)
|
|
||||||
|
|
||||||
#! format: off
|
|
||||||
@add_arg_table! s begin
|
|
||||||
"create"
|
|
||||||
help = "Create CualerID sample ids or barcode labels"
|
|
||||||
action = :command
|
|
||||||
"fix"
|
|
||||||
help = "Compare a set of possibly invalid IDs against a correct set of IDs to identify errors in the IDs"
|
|
||||||
action = :command
|
|
||||||
"convert"
|
|
||||||
help = "Convert CualID sample ids to CualerID sample ids or vice-versa"
|
|
||||||
action = :command
|
|
||||||
end #add_arg_table
|
|
||||||
|
|
||||||
@add_arg_table! s["create"] begin
|
|
||||||
"ids"
|
|
||||||
help = "Generate sample ids"
|
|
||||||
action = :command
|
|
||||||
"labels"
|
|
||||||
help = "Generate a pdf of barcodes (NOT YET IMPLEMENTED)"
|
|
||||||
action = :command
|
|
||||||
end #add_arg_table
|
|
||||||
|
|
||||||
@add_arg_table! s["create"]["ids"] begin
|
|
||||||
"--length", "-l"
|
|
||||||
help = "The length of the printed sample ids"
|
|
||||||
arg_type = UInt64
|
|
||||||
default = UInt64(5)
|
|
||||||
"--fail-threshold", "-f"
|
|
||||||
help = "NOT IMPLEMENTED: The rate at which similar ids will fail the process"
|
|
||||||
arg_type = Float64
|
|
||||||
range_tester = x -> x >= 0 && x <= 1.0
|
|
||||||
default = 0.99
|
|
||||||
"number_of_ids"
|
|
||||||
help = "The number of sample ids to print"
|
|
||||||
arg_type = UInt64
|
|
||||||
range_tester = x -> x >= 1
|
|
||||||
required = true
|
|
||||||
end #add_arg_table
|
|
||||||
|
|
||||||
@add_arg_table! s["fix"] begin
|
|
||||||
"--correct-ids"
|
|
||||||
help = "Path to the list of correct ids"
|
|
||||||
arg_type = AbstractPath
|
|
||||||
range_tester = x -> exists(x) && isfile(x)
|
|
||||||
required = true
|
|
||||||
"--show", "-s"
|
|
||||||
help = """
|
|
||||||
Which types of fixes should be printed to output. Can be a
|
|
||||||
combination of D for duplicate, F for fixed, N for not fixable,
|
|
||||||
and V for valid.
|
|
||||||
"""
|
|
||||||
arg_type = ResultCodeOption
|
|
||||||
default = ResultCodeOption("DFN")
|
|
||||||
"--all", "-a"
|
|
||||||
help = "Show all ids regardless of fixed status"
|
|
||||||
action = :store_true
|
|
||||||
"ids_to_be_corrected"
|
|
||||||
help = "File containing CualerIDs that need correction"
|
|
||||||
arg_type = AbstractPath
|
|
||||||
range_tester = x -> exists(x) && isfile(x)
|
|
||||||
required = true
|
|
||||||
end #add_arg_table
|
|
||||||
|
|
||||||
@add_arg_table! s["convert"] begin
|
|
||||||
"--length", "-l"
|
|
||||||
help = "The length of the printed sample ids"
|
|
||||||
arg_type = UInt64
|
|
||||||
default = UInt64(5)
|
|
||||||
"--fail-threshold", "-f"
|
|
||||||
help = "NOT IMPLEMENTED: The rate at which similar ids will fail the process"
|
|
||||||
arg_type = Float64
|
|
||||||
range_tester = x -> x >= 0 && x <= 1.0
|
|
||||||
default = 0.99
|
|
||||||
"--to-cual-id"
|
|
||||||
help = "Convert from CualerID to CualID"
|
|
||||||
action = :store_true
|
|
||||||
"ids_to_be_converted"
|
|
||||||
help = "TSV file containing CualIDs or CualerIDs to be converted"
|
|
||||||
arg_type = AbstractPath
|
|
||||||
range_tester = x -> exists(x) && isfile(x)
|
|
||||||
required = true
|
|
||||||
end #@add_arg_table!
|
|
||||||
|
|
||||||
#! format: on
|
|
||||||
|
|
||||||
return s
|
|
||||||
|
|
||||||
end #function
|
|
||||||
|
|
||||||
const ARG_PARSE_TABLE = _create_arg_table()
|
|
||||||
|
|
||||||
function _create(parsed_args::Dict{Symbol,Any})
|
|
||||||
if parsed_args[:_COMMAND_] == :ids
|
|
||||||
_create_ids(parsed_args[:ids])
|
|
||||||
elseif parsed_args[:_COMMAND_] == :labels
|
|
||||||
_create_labels(parsed_args[:labels])
|
|
||||||
end #if
|
|
||||||
|
|
||||||
return 0
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function _create_ids(parsed_args::Dict{Symbol,Any})
|
|
||||||
println("COMMAND:\tcreate ids")
|
|
||||||
for (key, val) in parsed_args
|
|
||||||
println("\t$key:\t$val")
|
|
||||||
end #function
|
|
||||||
|
|
||||||
return 0
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function _create_labels(parsed_args::Dict{Symbol,Any})
|
|
||||||
println("COMMAND:\tcreate labels")
|
|
||||||
for (key, val) in parsed_args
|
|
||||||
println("\t$key:\t$val")
|
|
||||||
end #function
|
|
||||||
|
|
||||||
return 0
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function _fix(parsed_args::Dict{Symbol,Any})
|
|
||||||
println("COMMAND:\tfix")
|
|
||||||
for (key, val) in parsed_args
|
|
||||||
println("\t$key:\t$val")
|
|
||||||
end #function
|
|
||||||
|
|
||||||
return 0
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function _convert(parsed_args::Dict{Symbol,Any})
|
|
||||||
println("COMMAND:\tconvert")
|
|
||||||
for (key, val) in parsed_args
|
|
||||||
println("\t$key:\t$val")
|
|
||||||
end #function
|
|
||||||
|
|
||||||
return 0
|
|
||||||
end #function
|
|
||||||
|
|
||||||
|
|
||||||
function (@main)()
|
|
||||||
parsed_args = parse_args(ARG_PARSE_TABLE; as_symbols = true)
|
|
||||||
|
|
||||||
if parsed_args[:_COMMAND_] == :create
|
|
||||||
_create(parsed_args[:create])
|
|
||||||
elseif parsed_args[:_COMMAND_] == :fix
|
|
||||||
_fix(parsed_args[:fix])
|
|
||||||
elseif parsed_args[:_COMMAND_] == :convert
|
|
||||||
_convert(parsed_args[:convert])
|
|
||||||
end #if
|
|
||||||
|
|
||||||
return 0
|
|
||||||
end #function
|
|
||||||
|
|
||||||
end #module
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
"""
|
|
||||||
_hamming(str1::AbstractString, str2::AbstractString)
|
|
||||||
|
|
||||||
Computes the [Hamming distance](https://en.wikipedia.org/wiki/Hamming_distance) between
|
|
||||||
`str1` and `str2`.
|
|
||||||
"""
|
|
||||||
function _hamming(str1::AbstractString, str2::AbstractString)
|
|
||||||
length(str1) != length(str2) &&
|
|
||||||
throw(DimensionMismatch("strings must be of equal length"))
|
|
||||||
return sum(c -> first(c) != last(c), zip(str1, str2))
|
|
||||||
end #function
|
|
||||||
|
|
@ -1,120 +0,0 @@
|
||||||
"""
|
|
||||||
ResultCode::UInt8
|
|
||||||
|
|
||||||
Encodes a result of attempting to correct a CualerID
|
|
||||||
|
|
||||||
The valid codes are
|
|
||||||
|
|
||||||
- **D**: duplicate
|
|
||||||
- **F**: fixed
|
|
||||||
- **N**: not fixable
|
|
||||||
- **V**: valid (no need for correction)
|
|
||||||
"""
|
|
||||||
@enum ResultCode::UInt8 begin
|
|
||||||
D = UInt8(1)
|
|
||||||
F = UInt8(2)
|
|
||||||
N = UInt8(4)
|
|
||||||
V = UInt8(8)
|
|
||||||
end #enum
|
|
||||||
|
|
||||||
"""
|
|
||||||
ResultCodeOption
|
|
||||||
|
|
||||||
Encodes potential corrected id codes.
|
|
||||||
|
|
||||||
The valid codes are
|
|
||||||
|
|
||||||
- **D**: duplicate
|
|
||||||
- **F**: fixed
|
|
||||||
- **N**: not fixable
|
|
||||||
- **V**: valid (no need for correction)
|
|
||||||
|
|
||||||
The codes are implemented exactly as from cual-id and in that order
|
|
||||||
|
|
||||||
# Constructors
|
|
||||||
|
|
||||||
ResultCodeOption(str::AbstractString)
|
|
||||||
|
|
||||||
Create a `ResultCodeOption` based on a the character codes contained within
|
|
||||||
`str`. `str` is case insensitive, may contain an arbitrary number of valid codes
|
|
||||||
(as specified above), and may contain duplicates. A `ResultCodeOption` cannot be
|
|
||||||
constructed from a combination of strings and bitmasks/integers.
|
|
||||||
|
|
||||||
# Extended help
|
|
||||||
|
|
||||||
The struct stores values as a bitmask
|
|
||||||
|
|
||||||
| Bit (Int) | Bit (UInt) | Description |
|
|
||||||
| ---------:| ----------:| --------------- |
|
|
||||||
| 1 | 0x01 | D - duplicate |
|
|
||||||
| 2 | 0x02 | F - fixed |
|
|
||||||
| 4 | 0x04 | N - not fixable |
|
|
||||||
| 8 | 0x08 | V - valid |
|
|
||||||
|
|
||||||
"""
|
|
||||||
struct ResultCodeOption
|
|
||||||
val::UInt8
|
|
||||||
end #struct
|
|
||||||
|
|
||||||
ResultCodeOption(str::AbstractString) = Base.parse(ResultCodeOption, str)
|
|
||||||
|
|
||||||
function Base.parse(::Type{ResultCodeOption}, str::AbstractString)
|
|
||||||
upper_str = uppercase(str)
|
|
||||||
|
|
||||||
# Throw if there are any invalid codes
|
|
||||||
occursin(r"[^DFNV]", upper_str) &&
|
|
||||||
throw(DomainError("Valid `ResultCodeOption` must contain D, F, N, or V only"))
|
|
||||||
|
|
||||||
# Throw if there are no valid codes
|
|
||||||
occursin(r"[DFNV]", upper_str) || throw(
|
|
||||||
DomainError("Valid `ResultCodeOption` must contain at least one of D, F, N, or V"),
|
|
||||||
)
|
|
||||||
|
|
||||||
result_code = sum(
|
|
||||||
c -> occursin(string(Symbol(c)), upper_str) ? UInt8(c) : UInt8(0),
|
|
||||||
instances(ResultCode),
|
|
||||||
)
|
|
||||||
|
|
||||||
return ResultCodeOption(result_code)
|
|
||||||
|
|
||||||
end #function
|
|
||||||
|
|
||||||
function Base.show(io::IO, r::ResultCodeOption)
|
|
||||||
print_code = ""
|
|
||||||
|
|
||||||
print(io, summary(r), " (")
|
|
||||||
foreach(
|
|
||||||
c -> r.val & UInt8(c) != 0 && print(io, string(Symbol(c))),
|
|
||||||
instances(ResultCode),
|
|
||||||
)
|
|
||||||
print(io, ")")
|
|
||||||
end #function
|
|
||||||
|
|
||||||
"""
|
|
||||||
has_duplicate(r::ResultCodeOption)
|
|
||||||
|
|
||||||
Determines if `r` contains a duplicate result ([`ResultCode`](@ref) D)
|
|
||||||
"""
|
|
||||||
has_duplicate(r::ResultCodeOption) = r.val & UInt8(D) != 0
|
|
||||||
|
|
||||||
"""
|
|
||||||
has_fixed(r::ResultCodeOption)
|
|
||||||
|
|
||||||
Determines if `r` contains a fixed result ([`ResultCode`](@ref) F)
|
|
||||||
"""
|
|
||||||
has_fixed(r::ResultCodeOption) = r.val & UInt8(F) != 0
|
|
||||||
|
|
||||||
"""
|
|
||||||
has_not_fixable(r::ResultCodeOption)
|
|
||||||
|
|
||||||
Determines if `r` contains a not fixable result ([`ResultCode`](@ref) N)
|
|
||||||
"""
|
|
||||||
has_not_fixable(r::ResultCodeOption) = r.val & UInt8(N) != 0
|
|
||||||
|
|
||||||
"""
|
|
||||||
has_valid(r::ResultCodeOption)
|
|
||||||
|
|
||||||
Determines if `r` contains a valid (not corrected) result
|
|
||||||
([`ResultCode`](@ref) V)
|
|
||||||
"""
|
|
||||||
has_valid(r::ResultCodeOption) = r.val & UInt8(V) != 0
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
using Aqua
|
|
||||||
|
|
||||||
@testset "Aqua" begin
|
|
||||||
Aqua.test_all(CualerID)
|
|
||||||
end #@testset
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
using CualerID: base30encode, rebase
|
|
||||||
|
|
||||||
@testset "base30encode" begin
|
|
||||||
@test base30encode(0) == "0"
|
|
||||||
@test base30encode(1) == "1"
|
|
||||||
@test base30encode(29) == "Z"
|
|
||||||
@test base30encode(30) == "10"
|
|
||||||
@test base30encode(31) == "11"
|
|
||||||
@test base30encode(59) == "1Z"
|
|
||||||
end
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
using Documenter
|
|
||||||
|
|
||||||
@testset "doctests" begin
|
|
||||||
DocMeta.setdocmeta!(CualerID, :DocTestSetup, :(using CualerID); recursive = true)
|
|
||||||
doctest(CualerID)
|
|
||||||
end
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
[deps]
|
|
||||||
Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
|
|
||||||
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
|
|
||||||
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
|
|
||||||
UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
|
|
||||||
|
|
||||||
[compat]
|
|
||||||
Aqua = "0.8"
|
|
||||||
Documenter = "1.16"
|
|
||||||
UUIDs = "1.11.0"
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
@testset "ResultCode" begin
|
|
||||||
@test_throws DomainError ResultCodeOption("A")
|
|
||||||
@test_throws DomainError ResultCodeOption("")
|
|
||||||
@test has_duplicate(ResultCodeOption("D"))
|
|
||||||
@test has_fixed(ResultCodeOption("F"))
|
|
||||||
@test has_not_fixable(ResultCodeOption("N"))
|
|
||||||
@test has_valid(ResultCodeOption("V"))
|
|
||||||
end #@testset
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
using CualerID
|
|
||||||
using Test
|
|
||||||
|
|
||||||
include("Doctests.jl")
|
|
||||||
include("Aqua.jl")
|
|
||||||
include("Base30.jl")
|
|
||||||
include("ResultCodeOption.jl")
|
|
||||||
5
versions.js
Normal file
5
versions.js
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
var DOC_VERSIONS = [
|
||||||
|
"dev",
|
||||||
|
];
|
||||||
|
var DOCUMENTER_NEWEST = "dev";
|
||||||
|
var DOCUMENTER_STABLE = "dev";
|
||||||
Loading…
Add table
Add a link
Reference in a new issue