From e10068321fd593760ccee06a7b4bde26d2b2a3c6 Mon Sep 17 00:00:00 2001 From: Ross Allen Date: Mon, 16 Dec 2024 10:01:26 -0800 Subject: [PATCH] bumping to v0.11.0 --- CHANGELOG.md | 20 +++++++++++++++++++- src/kspdg/__init__.py | 2 +- src/kspdg/scripts/install_ksp_files.py | 4 ++-- 3 files changed, 22 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 00102fe..2a0a81c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [UNRELEASED] - XXXX.XX.XX +## [v0.11.0] - 2024.12.16 ### Added @@ -44,6 +44,24 @@ kspdg-evaluate path/to/cfg.yml optional/path/to/results/ ### 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: +```bash +# 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 +``` ## [v0.10.0] - 2024.12.09 diff --git a/src/kspdg/__init__.py b/src/kspdg/__init__.py index 6006b95..03a2ca4 100644 --- a/src/kspdg/__init__.py +++ b/src/kspdg/__init__.py @@ -5,7 +5,7 @@ # Single-sourcing package version # https://packaging.python.org/guides/single-sourcing-package-version/ -__version__ = "0.10.0" +__version__ = "0.11.0" # these imports make the individual environments accessible at the top-level # of the library and assign an environment version number diff --git a/src/kspdg/scripts/install_ksp_files.py b/src/kspdg/scripts/install_ksp_files.py index 87d2e65..8878d13 100644 --- a/src/kspdg/scripts/install_ksp_files.py +++ b/src/kspdg/scripts/install_ksp_files.py @@ -103,9 +103,9 @@ def setup_kspdg_game_data_dir(kspdg_path_in, ksp_game_path_in): raise FileNotFoundError(f"Example eval config not found in kspdg install: {kspdg_example_eval_cfg_path}") shutil.copy(kspdg_example_eval_cfg_path, ksp_example_eval_cfg_path) - print(f"Copied example.yaml from '{kspdg_example_eval_cfg_path}' to '{ksp_example_eval_cfg_path}'.") + print(f"Copied example_eval_cfg.yamlfrom '{kspdg_example_eval_cfg_path}' to '{ksp_example_eval_cfg_path}'.") else: - print(f"File 'example.yaml' already exists in '{ksp_example_eval_cfg_path}'. It will not be overwritten.") + print(f"File 'example_eval_cfg.yaml' already exists in '{ksp_example_eval_cfg_path}'. It will not be overwritten.") def main():