teamtomo / imodmodel

IMOD model files as pandas dataframes in Python
https://teamtomo.org/imodmodel/
Other
9 stars 7 forks source link

Slan to ImodModel attribute and IMAT to ImodModel.object attribute + testing & documentation #20

Closed braxtonowens closed 4 months ago

braxtonowens commented 4 months ago
  1. I incorrectly made Slicer angles an ImodModel.object attribute in #17. It is now an ImodModel attribute. IMAT is now an ImodModel.object attribute instead of an ImodModel attribute.

  2. Added mod file with multiple objects along with testing.

  3. Added documentation for using ImodModel.

alisterburt commented 4 months ago

Wonderful - while we're at it, do you think the attribute should be .slan or .slicer_angles?

I'm fine with either but prefer the aesthetics of slicer_angles - if we go with slicer_angles can we update the selector for annotation type where it's 'slan' too?

Great work as always @braxtonowens !

alisterburt commented 4 months ago

Looks like you have some merge conflicts, you'll have to rebase on main

braxtonowens commented 4 months ago

Yeah, I like slicer_angles better.

alisterburt commented 4 months ago

@braxtonowens I've given you maintenance powers on the repo - let's still discuss things over PRs with the other but you're doing a great job and should have the ability to move the project forward 🙂

Would you like to trigger the deployment workflow with this new code so that it's available on PyPI?

The deployment workflow is stored here: https://github.com/teamtomo/imodmodel/blob/5908efc1993ff076bc6196ac992a5bf20476c4c3/.github/workflows/test_and_deploy.yml#L1-L76

If you take a look at that workflow you'll see it is trigger when a 'tagged commit' matching 'v*' is pushed to the main branch. Deploying will look like:

one time things

deployment workflow

Once you do this, you should see things launch in the actions tab of the repository https://github.com/teamtomo/imodmodel/actions

If you don't want to do this let me know and I'm happy to do it too - only written up in case you would like to learn

braxtonowens commented 4 months ago

Great, I think everything went smooth for v0.0.13. Thanks for the help.

alisterburt commented 4 months ago

Great!!