Skip to content

Separate sim module from main package#248

Merged
thopkins32 merged 8 commits intomainfrom
rework-sim
Feb 24, 2026
Merged

Separate sim module from main package#248
thopkins32 merged 8 commits intomainfrom
rework-sim

Conversation

@thopkins32
Copy link
Copy Markdown
Collaborator

@thopkins32 thopkins32 commented Feb 23, 2026

Summary

  • blop_sim is now a separate Python package that can only be locally installed
  • Removed integration tests since they are duplicated by docs tutorials
  • Removed docs extra from pyproject since it requires a local blop-sim package, you must use Pixi docs env to build the docs

Reason for change

  • Shipping a sim submodule with Blop is not useful to end-users, it bloats the package
  • Most simulation code is auto-generated and doesn't need test coverage (reducing the statistic's accuracy)
  • Integration tests are duplicated in the tutorials, both of which are executed on every push in CI

@thopkins32
Copy link
Copy Markdown
Collaborator Author

thopkins32 commented Feb 23, 2026

FYI @jessica-moylan @josephhanrahan , I will merge soon

@thopkins32 thopkins32 merged commit 965e2c5 into main Feb 24, 2026
20 checks passed
@thopkins32 thopkins32 deleted the rework-sim branch February 24, 2026 14:45
jessica-moylan pushed a commit to jessica-moylan/blop that referenced this pull request Mar 4, 2026
@thopkins32 @jessica-moylan
Separate sim module from main package (bluesky#248)
f9f1d2f 
* Move sim module to examples/simulations

* Add separate sim local package

* Rename to blop_sim; Remove integration tests; Remove docs env in favor of Pixi-only build

* Remove extra info from README.md

* Update testing workflow

* pre-commit & update README.md

* Update to use bluesky-tiled-plugins TiledWriter
jessica-moylan added a commit to jessica-moylan/blop that referenced this pull request Mar 4, 2026
@jessica-moylan
Squashed commit of the following:
775c753 
commit c499718
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Tue Mar 3 16:44:42 2026 -0500

    Move plans to base of package (bluesky#259)

    * Move plans to base of package

    * Fixes from file moves

commit 87104c6
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Tue Mar 3 16:25:01 2026 -0500

    Markdown linting config (bluesky#258)

    * Start work on refactor of sim devices

    * Use async

    * Remove summary file

    * Update XRT tutorial

    * Remove test files

    * Update sim/README.md

    * Cleanup devices and sim backends

    * Small fixes; Move XRT model files

    * Fixed issues with docs

    * Lint markdown files

    * Fixed some lingering issues with XRT tutorial

commit 38aba23
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Tue Mar 3 16:08:10 2026 -0500

    Rewrite simulation code (bluesky#256)

    * Start work on refactor of sim devices

    * Use async

    * Remove summary file

    * Update XRT tutorial

    * Remove test files

    * Update sim/README.md

    * Cleanup devices and sim backends

    * Small fixes; Move XRT model files

    * Fixed issues with docs

    * pre-commit

    * Fixed some lingering issues with XRT tutorial

commit d08b199
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Fri Feb 27 12:56:01 2026 -0500

    opencode agent skills (bluesky#255)

    * opencode agent skills

    * blop-overview skill

commit 2e530ec
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Fri Feb 27 11:43:07 2026 -0500

    Add devcontainer and script to launch (bluesky#254)

commit 0e73894
Author: josephhanrahan <79729091+josephhanrahan@users.noreply.github.com>
Date:   Fri Feb 27 11:24:02 2026 -0500

    add osx-arm64 platform to pixi toml (bluesky#253)

commit d2af482
Author: josephhanrahan <79729091+josephhanrahan@users.noreply.github.com>
Date:   Fri Feb 27 09:29:11 2026 -0500

    Add support for `fixed_parameters` (bluesky#252)

    * Add support for fixed_parameters in AxOptimizer

    * linting

    * changed name to fixed_dofs for blop context and fixed_parameters for ax context

    * take fixed_dofs out of init

    * DOF or str can be used

    * small fixes

    * fix testcase and type errors

    * Fix type checking

    * pre-commit

    ---------

    Co-authored-by: thomashopkins32 <thopkins1@bnl.gov>

commit 64601dd
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Tue Feb 24 16:59:27 2026 -0500

    Remove pin of fastapi (tiled v0.2.6) (bluesky#251)

commit 965e2c5
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Tue Feb 24 09:45:56 2026 -0500

    Separate sim module from main package (bluesky#248)

    * Move sim module to examples/simulations

    * Add separate sim local package

    * Rename to blop_sim; Remove integration tests; Remove docs env in favor of Pixi-only build

    * Remove extra info from README.md

    * Update testing workflow

    * pre-commit & update README.md

    * Update to use bluesky-tiled-plugins TiledWriter

commit 9f8f1d1
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Tue Feb 24 09:35:48 2026 -0500

    Temporarily pin fastapi to fix breaking change (bluesky#249)

    * Temporarily pin fastapi to fix breaking change

    * pin for dev and dev-cpu too

commit 52e952d
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Fri Feb 20 17:11:08 2026 -0500

    Update docs workflow (bluesky#247)

commit 2ff92fe
Author: Thomas Hopkins <thopkins1@bnl.gov>
Date:   Fri Feb 20 17:00:07 2026 -0500

    Add codecoverage (bluesky#246)

    * Add codecoverage

    * Use commit hash for codecov action; Get report on py313

    * Use bluesky/blop links for badges

commit 6c49af2
Author: Jessica Moylan <107206455+jessica-moylan@users.noreply.github.com>
Date:   Fri Feb 20 16:18:06 2026 -0500

    Interactive optimizer agent (bluesky#235)

    * adding interactive agent with how-to-guide

    * fixed build_docs

    * making code easier to read

    * fixed bug with interactive agent and jupyter notebook + fixed docstrings

    * fix build_docs

    * prevented interactive agent when running build-docs

    * changes from code review

    * fixing how-to guide to reflect changes

    * fix build docs

    * Rework suggestion workflow to use Bluesky and IPython as the main interaction point

    * Add docs for manual suggestion workflow; Add Ax optimizer register for manual suggestions

    * pre-commit

    * Fix unit tests

    * Use doctest for how-to

    ---------

    Co-authored-by: thomashopkins32 <thopkins1@bnl.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@josephhanrahan josephhanrahan Awaiting requested review from josephhanrahan

@jessica-moylan jessica-moylan Awaiting requested review from jessica-moylan

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@thopkins32