SkySim

See this page and the developer documentation at taiwithers.github.io/SkySim

General Installation & Usage

Using pip

1. Confirm you have the required dependencies:
   • Git
   • pip
   • ffmpeg
   • libstdc++.so.6 (libstdc++6)
   • libz.so.1 (zlib)
2. Install the package with pip: pip install git+https://github.com/taiwithers/SkySim.git
3. Create a configuration TOML file (see the examples directory).
4. Run skysim <path to your config.toml>

Using Poetry

1. Confirm you have the required dependencies:
   • Git
   • Poetry (SkySim is built with version 1.8)
   • ffmpeg
   • libstdc++.so.6 (libstdc++6)
   • libz.so.1 (zlib)
2. Clone and enter the git repo: git clone https://github.com/taiwithers/SkySim.git && cd SkySim (disregard the warning from direnv if it appears).
3. Install the script and its dependencies with poetry install.
4. Create a configuration TOML file (see the examples directory).
5. Run poetry run skysim <path to your config.toml>

Development Installation

SkySim is developed using Nix as a general package manager to control the development environment, and direnv to activate that environment automatically. If you'd prefer to manage your development environment manually, consult the flake.nix for a list of dependencies, and .envrc for the environment activation scripts.

git clone https://github.com/taiwithers/SkySim.git
cd SkySim
direnv allow # let direnv use the .envrc file
poetry install # install python and dependencies
direnv reload # set up and activate the environment
pre-commit install # install pre-commit checks
source $JCOMP_PATH # add completions for `just` commands
just # list the `just` commands and their usage

# copy-paste version
git clone https://github.com/taiwithers/SkySim.git && cd SkySim && direnv allow
poetry install && direnv reload && pre-commit install && source $JCOMP_PATH

Copyright & License

License GPLv3+ (see COPYING)

Copyright (C) 2025 Tai Withers

SkySim 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.

SkySim 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 SkySim. If not, see https://www.gnu.org/licenses/.