Skip to content

v0.11.0
Compare
Choose a tag to compare
@rallen10 rallen10 released this 16 Dec 18:07
· 11 commits to main since this release
v0.11.0
e100683

Restructure to simplify end-user setup and execution

Added

  • Explicit pyyaml dependency (I think this used to be a sub-dependency of astropy)
  • In-package src/kspdg/scripts/ directory for holding command-line entry-point scripts (e.g. julia install, unit tests) so that full download/clone of kspdg is not needed for julia install and unit testing
  • MANIFEST.in to include tests in source distributions
  • Julia dependency entry point. Run with
kspdg-install-julia-deps
  • KSP files copy script entry point. This creates the GameData/KSPDG directory for easier management of evaluation configs and results and copies the KSPDG mission files into the KSP installation. Run with
kspdg-install-ksp-files
  • Serverless and in-game unit test entry points. Run with
kspdg-run-serverless-tests
kspdg-run-lbg1-i2-tests
kspdg-run-pe1-i3-tests
kspdg-run-sb1-i5-tests
  • evaluate.py command-line entry point. Run with
kspdg-evaluate path/to/cfg.yml optional/path/to/results/

Changed

  • Moving tests/, ksp_files/, and evaluation/ directories into src/kspdg/ so that they are considered package-data that is accessible at runtime by end users. This enables no-clone unit testing and ksp-file installation. For justification for avoiding use of non-package data, see: https://setuptools.pypa.io/en/latest/userguide/datafiles.html#non-package-data-files
  • Moving install_julia_deps.py into kspdg package and adding it as a command-line entry point within pyproject.toml to simplify install process
  • Updated readme with no-clone install instructions and added recommended graphics settings

Removed

  • Unused astropy dependency and related instructions in readme
  • environment.yml and developer instructions in readme as they are not needed by, and may confuse, end-users and are easy to reprodocue for developers. For example, developers can use the following process:
# create conda development environment
conda create --name kspdg_dev python=3.12 ipython
conda activate kspdg_dev

# clone kspdg repo and install as editable
git clone git@github.com:mit-ll/spacegym-kspdg.git
cd spacegym-kspdg
pip install -e .[full]

# copy necessary game files to KSP install
kspdg-install-ksp-files

# instal juliaup and julia dependencies
curl -fsSL https://install.julialang.org | sh
kspdg-install-julia-deps

Full Changelog: v0.10.0...v0.11.0

Assets 2
Loading