quicksat 0.1.0__py3-none-any.whl

quicksat/__init__.py

@@ -0,0 +1,36 @@
+# quicksat Basic satellite sizing tool
+#
+# Copyright (C) Egemen Imre
+#
+# Licensed under GNU GPL v3.0. See LICENSE.md for more info.
+"""
+Basic satellite sizing tool.
+
+"""
+
+__version__ = "0.1.0"
+
+from astropy import constants
+from astropy import units as u
+from astropy.units import Quantity
+
+__all__ = ["MU_EARTH", "Q_", "R_EARTH", "u"]
+
+Q_ = Quantity
+"""Shorthand for astropy's `Quantity`, exported the way opticks exports it.
+
+The package builds quantities with the constructor, `Q_(123, "m")`, and parses
+text with `Q_("123 m")`. The notebooks write `123 * u.m` instead.
+"""
+
+# astropy.constants creates its constants at import, so pyright cannot see them
+R_EARTH = constants.R_earth  # pyright: ignore[reportAttributeAccessIssue]
+"""Earth equatorial radius: astropy's default, the IAU 2015 nominal 6378.1 km."""
+
+MU_EARTH = constants.GM_earth  # pyright: ignore[reportAttributeAccessIssue]
+"""Earth gravitational parameter: astropy's default, the IAU 2015 nominal GM.
+
+A GM rather than G times astropy's `M_earth`. GM is the measured quantity, known
+to about nine significant figures, and G is known to about five. astropy itself
+derives `M_earth` from the two.
+"""

quicksat/__main__.py

@@ -0,0 +1,77 @@
+# quicksat Basic satellite sizing tool
+#
+# Copyright (C) Egemen Imre
+#
+# Licensed under GNU GPL v3.0. See LICENSE.md for more info.
+"""
+Copy quicksat's sample into a folder, from the command line:
+
+    python -m quicksat init my_satellite
+
+The sample comes from GitHub, for the installed version, with its data, its
+notebooks, and the viewers and editor pages written from them. `--from` takes a
+local copy of the repository instead, as a folder or as its zip. The folder must
+be empty, so nothing is overwritten. See `quicksat.sample`.
+
+"""
+
+import argparse
+from pathlib import Path
+
+from quicksat.sample import copy_sample
+
+
+def main(argv: list[str] | None = None) -> None:
+    """
+    Copy the sample, and print what to do next.
+
+    Parameters
+    ----------
+    argv : list of str, optional
+        The arguments, the command line's by default
+    """
+    parser = argparse.ArgumentParser(
+        prog="python -m quicksat",
+        description="Copy quicksat's sample into a folder.",
+    )
+    commands = parser.add_subparsers(dest="command", required=True)
+    init = commands.add_parser(
+        "init",
+        help="copy the sample into a folder",
+        description="Copy quicksat's sample, from GitHub, into an empty folder.",
+    )
+    init.add_argument("folder", help="the folder to copy into, made if missing")
+    init.add_argument(
+        "--from",
+        dest="source",
+        metavar="PATH",
+        help="a local copy of the repository, as a folder or as its zip",
+    )
+    args = parser.parse_args(argv)
+    try:
+        files, warnings = copy_sample(args.folder, args.source)
+    except (OSError, ValueError) as error:
+        parser.exit(1, f"error: {error}\n")
+    for warning in warnings:
+        print(f"warning: {warning}")
+    print(f"Copied {len(files)} files into {args.folder}.")
+    print(_next_steps(Path(args.folder)))
+
+
+def _next_steps(folder: Path) -> str:
+    """What to do with the copied sample, with its own paths."""
+    power = folder / "power"
+    sizing = folder / "sizing"
+    return f"""
+Next:
+  Open the power sample in the Scenario Editor, served from this computer:
+    python -m quicksat.editor serve {power / "data"} {power / "output"}
+  Or double-click a page written already, such as
+    {power / "output" / "power_viewer.html"}
+    {sizing / "editor" / "editor.html"}
+  The notebooks in {sizing}, {folder / "scenario"} and {power} are the worked
+  examples, for Jupyter."""
+
+
+if __name__ == "__main__":
+    main()

quicksat/agility/__init__.py

@@ -0,0 +1,9 @@
+# quicksat Basic satellite sizing tool
+#
+# Copyright (C) Egemen Imre
+#
+# Licensed under GNU GPL v3.0. See LICENSE.md for more info.
+"""
+Attitude agility: how long a rest-to-rest slew takes, and whether it fits.
+
+"""