Skip to content

[DRAFT] Iterate on setup - config, CLI, and README updates#62

Draft
elliott-ruebush wants to merge 12 commits into
fix/src_layoutfrom
feature/iterate_on_setup
Draft

[DRAFT] Iterate on setup - config, CLI, and README updates#62
elliott-ruebush wants to merge 12 commits into
fix/src_layoutfrom
feature/iterate_on_setup

Conversation

@elliott-ruebush
Copy link
Copy Markdown
Collaborator

@elliott-ruebush elliott-ruebush commented May 28, 2026

Summary

Stacks on #63. Pydantic config + dependency injection, nps-* CLI entry points, TOML template, subprocess fixes, and tests.

Recent commits on this branch:

  • Packaging: Runtime and dev deps live in pyproject.toml (pip install -e . / .[dev]). requirements.txt removed. This allows you to pull in your dependencies via just pip installing rather than also having to install the requirements explicitly. The goal is that this gets us closer to a state where you can just pip install NPS-ActiveSpace and run it (assuming you have GDAL and a binary for NMSIM/AAM)
  • Config module: nps_active_space.config replaces utils.config — Pydantic models for enforcing config structure, TOML, proper Python Path objects
    • TODO: replace empty template with a runnable template config (although confirm what we want to do for DB credentials)
    • TODO: validation see issue Add configuration validation #64
  • CLI: nps-init-config -e <name> creates a new config file {name}.toml under ~/.nps_active_space (or NPS_ACTIVE_SPACE_CONFIG_DIR environment variable dir). Pipeline scripts import nps_active_space.config.
  • Tests & docs: tests/config/ unit tests; root and package READMEs updated to reflect changes/try to clarify structure in some cases

Test plan

  • Merge [DRAFT] Move package tree under src/ #63 first (or test against fix/src_layout)
  • pytest (includes tests/config/)
    • TODO add more test
  • pip install -e ".[dev]" then nps-init-config -e TEST and nps-ground-truthing --help

@elliott-ruebush elliott-ruebush changed the base branch from main to fix/src_layout May 28, 2026 22:57
@elliott-ruebush elliott-ruebush changed the title [DRAFT] Iterate on setup procedure Config, CLI, and install docs May 28, 2026
@elliott-ruebush elliott-ruebush changed the title Config, CLI, and install docs [DRAFT] Iterate on setup - config, CLI, and README updates May 28, 2026
elliott-ruebush and others added 6 commits May 29, 2026 15:53
Single-source install via pip install -e . (and .[dev] for pytest); drop
requirements.txt files and ignore setuptools build/ output.

Co-authored-by: Cursor <cursoragent@cursor.com>
Replace utils.config with nps_active_space.config; bundle template.toml
via setuptools package-data.

Co-authored-by: Cursor <cursoragent@cursor.com>
Update imports from the removed utils.config module across CLIs and legacy code.

Co-authored-by: Cursor <cursoragent@cursor.com>
Copies the bundled template into the user config directory with -e naming.

Co-authored-by: Cursor <cursoragent@cursor.com>
Mirror config layout under tests/config; remove obsolete setup.cfg.

Co-authored-by: Cursor <cursoragent@cursor.com>
Update root and package READMEs for pyproject deps, nps-init-config, and config layout.

Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread README.md

The toolkit also requires basic sound source and weather profile data to operate. The provided (`.data`) are a widely applicable example: a fixed-wing propeller aircraft source and a standard "acoustician's atmosphere" with dry adiabatic lapse conditions. The toolkit may be run using alternative, custom sound sources or weather profiles.

### Data and File Directory Setup
Copy link
Copy Markdown
Collaborator Author

@elliott-ruebush elliott-ruebush May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved this section to config/README.md since I felt like it fit in well with a more detailed overview of the other setup you would do to run active space workflows

@elliott-ruebush elliott-ruebush force-pushed the feature/iterate_on_setup branch 2 times, most recently from 660e289 to 3a27be4 Compare May 30, 2026 00:21
@elliott-ruebush elliott-ruebush force-pushed the feature/iterate_on_setup branch from 3a27be4 to 4a1eed4 Compare May 30, 2026 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant