New build system#36
Open
ryanketzner wants to merge 3 commits intomainfrom
Open
Conversation
…able. Modified: eosimutils/spicekernels.py: Modified to change directory for spice kernels to ~. Necessary for conda install. pyproject.toml: Fixed to add prereqs. New: conda-recipe/meta.yaml: File needed for conda build.
… and added into dev. Modified: README.md: Describe new pip install. pyproject.toml: Moved docs dependencies into dev build option.
There was a problem hiding this comment.
Pull request overview
This PR updates packaging and installation so eosimutils can be installed via pip with runtime dependencies handled automatically, and adjusts SPICE kernel storage to avoid long installation paths (notably in conda environments).
Changes:
- Modernize
pyproject.tomlmetadata and move runtime vs. dev tooling dependencies into core vs. optionaldevextras. - Change SPICE kernel download/load directory to
~/.eosimutils_spiceinstead of a path under the installed package. - Update README installation instructions for the new pip-based workflow.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| pyproject.toml | Defines build requirements, project metadata, runtime dependencies, and dev optional dependencies. |
| eosimutils/spicekernels.py | Redirects kernel storage to the user home directory to reduce path length issues. |
| README.md | Documents pip install flow and mentions dev install/tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| To install the development version, which includes the docs, tests, and code formatting tools, run: | ||
|
|
||
| ``` | ||
| pip install "[.dev]" |
Comment on lines
+28
to
31
| kernel_dir = os.path.join(os.path.expanduser("~"), ".eosimutils_spice") | ||
| os.makedirs( | ||
| kernel_dir, exist_ok=True | ||
| ) # do not create the directory if it already exists |
Comment on lines
+72
to
+73
| # kernel_dir = os.path.join(os.path.dirname(__file__), "spice_kernels") | ||
| kernel_dir = os.path.join(os.path.expanduser("~"), ".eosimutils_spice") |
Comment on lines
+27
to
31
| Unit tests for the project are run using: | ||
|
|
||
| ``` | ||
| make test | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added new build system so package can be installed using only pip with a single pip install, with automatic dependency handling.
Modified: