Skip to content

Comments

user workflow improvements and config updates #411

Merged
rugeli merged 18 commits intomainfrom
feature/user-workflow-improvement
Nov 10, 2025
Merged

user workflow improvements and config updates #411
rugeli merged 18 commits intomainfrom
feature/user-workflow-improvement

Conversation

@rugeli
Copy link
Collaborator

@rugeli rugeli commented Oct 13, 2025

Problem

closes #398

Solution

  • set upload_results and its dependent flag open_results_in_browser to default False
  • added an explicit config file examples/packing-configs/upload_and_open_result.json to enable upload and auto-open results feature. ORwe could add the options to existing config files and set them to true for dev use, open to suggestions
  • updated README to pack example recipes without configs, and added a section explaining config usage
  • updated recipe and config schemas
  • added a detection layer for non-interactive environments to prevent hangs when reaching input() prompt (we could refactor db selection logic more broadly after the production site is established)
  • fixed small typos in docs

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Steps to Verify:

  1. follow the updated README to test examples
  2. run the pack command with or without a config file using any recipe(v1, v2, firebase)

@github-actions
Copy link
Contributor

github-actions bot commented Oct 13, 2025

Packing analysis report

Analysis for packing results located at cellpack/tests/outputs/test_spheres/spheresSST

Ingredient name Encapsulating radius Average number packed
ext_A 25 236.0

Packing image

Packing image

Distance analysis

Expected minimum distance: 50.00
Actual minimum distance: 50.01

Ingredient key Pairwise distance distribution
ext_A Distance distribution ext_A

@rugeli rugeli requested review from meganrm and mogres October 13, 2025 18:59
Copy link
Collaborator

@mogres mogres left a comment

Choose a reason for hiding this comment

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

Thanks for updating the new user workflow!! I like the updated logs and the logic for setting up uploads and viewing in the browser -- it all looks so simplified! I wonder if we should add the cellpack website URL here somewhere or if it's better to wait until we have an updated landing page to do so?

@rugeli
Copy link
Collaborator Author

rugeli commented Oct 13, 2025

I wonder if we should add the cellpack website URL here somewhere or if it's better to wait until we have an updated landing page to do so?
Good reminder! Yeah I can totally include the website link in this pr. I think it's fine to add it now rather than wait, the current site is functional and serves a good reference point for users testing our tool within the institute.

@rugeli
Copy link
Collaborator Author

rugeli commented Oct 17, 2025

@mogres I've updated the example recipes and configs section with my current understanding(in this commit), happy to adjust if anything looks off or too wordy or the referenced publication link is wrong, etc. lmk!

@mogres
Copy link
Collaborator

mogres commented Oct 17, 2025

@mogres I've updated the example recipes and configs section with my current understanding(in this commit), happy to adjust if anything looks off or too wordy or the referenced publication link is wrong, etc. lmk!

Looks great, thanks!
Could we add (if not too much extra overhead, can also be tackled in a later PR) screenshots for example recipe simularium results? Not sure how this would work with the Sphinx autodocs...

@rugeli rugeli mentioned this pull request Oct 28, 2025
* add screenshots to readme

* Quick fix: update bbox value in recipes (#420)

* add randomness_seed to upload and download (#416)

* update bbox value in recipes

* add config option for plot display

* replace result screenshots and update readme

* update docs/index to display images correctly
@rugeli
Copy link
Collaborator Author

rugeli commented Oct 29, 2025

note 10/29/25: @meganrm @mogres merging this pr into main, it includes previously approved changes

key improvements:

  • readme updates: added instructions for running example recipes, updated result screenshots, clarified config file usage, and fixed typos

  • an explicit config for upload and open results

  • refined logging

@rugeli rugeli requested a review from mogres October 29, 2025 21:39
@rugeli rugeli merged commit 95ac24b into main Nov 10, 2025
10 checks passed
@rugeli rugeli deleted the feature/user-workflow-improvement branch November 10, 2025 18:10
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.

Improve upload_results workflow for new users without credentials

2 participants