Skip to content

add task for ui and update docs#10

Open
akhanf wants to merge 1 commit into
mainfrom
add-task
Open

add task for ui and update docs#10
akhanf wants to merge 1 commit into
mainfrom
add-task

Conversation

@akhanf

@akhanf akhanf commented Jun 26, 2026

Copy link
Copy Markdown
Member

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the project documentation to use Pixi-based commands and adds a Pixi task to launch the Streamlit UI, aligning day-to-day usage with a Pixi-managed environment.

Changes:

  • Update README CLI examples to use pixi run ... instead of invoking spimpack directly.
  • Remove the UI “Installation” subsection and change UI run instructions to pixi run spimpack-ui.
  • Add a Pixi task (spimpack-ui) in pyproject.toml to run streamlit run ui/app.py.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File Description
README.md Updates CLI/UI usage instructions to prefer Pixi commands.
pyproject.toml Adds a Pixi task for running the Streamlit UI.
pixi.lock Updates the lockfile to reflect the new/updated environment state.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

```bash
spimpack package \
pixi run spimpack package \
Comment thread README.md

```bash
streamlit run ui/app.py
pixi run spimpack-ui
Comment thread README.md

```bash
spimpack package \
pixi run spimpack package \
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.

2 participants