Skip to content

Make decor mandatory and labels optional.#1978

Merged
thorstenhater merged 7 commits into
arbor-sim:masterfrom
thorstenhater:ux/simpler-cable-cell
Oct 20, 2022
Merged

Make decor mandatory and labels optional.#1978
thorstenhater merged 7 commits into
arbor-sim:masterfrom
thorstenhater:ux/simpler-cable-cell

Conversation

@thorstenhater
Copy link
Copy Markdown
Contributor

@thorstenhater thorstenhater commented Sep 14, 2022

  • Make decor mandatory
  • ...and label arguments to cable cell optional
  • Put the most optional argument (labels) last.

@brenthuisman
Copy link
Copy Markdown
Contributor

In which cases would a user want a cable cell without decoration?

@thorstenhater
Copy link
Copy Markdown
Contributor Author

Well, for one it's used quite often in our tests. Second, we had support for it before.

@brenthuisman
Copy link
Copy Markdown
Contributor

Tests are perhaps not what defaults should be based on. And I can't imagine a simulation of cells without any mechanisms. So unless there is an actual use case, I would like to require it such that people don't forget that cells without e.g. mechanisms are almost certainly not what they want.

@thorstenhater thorstenhater added interface Anything user-facing, including public C++ and Python APIs. AEP Arbor Enhancement Proposal Project: Fippa labels Sep 15, 2022
@thorstenhater
Copy link
Copy Markdown
Contributor Author

They could have always done that so far, but sure, I see the point. More breaking change then ;)

@thorstenhater thorstenhater removed AEP Arbor Enhancement Proposal Project: Fippa labels Sep 15, 2022
@thorstenhater thorstenhater changed the title Make decor and labels optional. Make decor mandatory and labels optional. Sep 20, 2022
@thorstenhater
Copy link
Copy Markdown
Contributor Author

Done.

Copy link
Copy Markdown
Contributor

@boeschf boeschf left a comment

Choose a reason for hiding this comment

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

Looks good - these small changes have quite a substantial ripple effect!
Please merge with master, there are a couple of recipes in the SDE tests that need to be updated.

Comment thread doc/python/cable_cell.rst
Comment thread python/cells.cpp Outdated
@brenthuisman
Copy link
Copy Markdown
Contributor

@thorstenhater If you could merge master and address @boeschf 's comments, we can merge these breaking changes before v0.8.

@thorstenhater thorstenhater requested a review from boeschf October 13, 2022 10:59
@thorstenhater
Copy link
Copy Markdown
Contributor Author

Done, I fixed two new warnings in test_sde along with it.

  • sde_recipe& add_probe(probe_tag tag, std::any address) hides a virtual on its base class
  • auto sampler_ = [ncells, nsteps] (std::vector<arb_value_type>& results, unsigned count, doesn't use its ncells capture.

@boeschf
Copy link
Copy Markdown
Contributor

boeschf commented Oct 13, 2022

there is one more recipe to fix in test_sde, line 826 (only enabled when compiling for GPU)

@thorstenhater
Copy link
Copy Markdown
Contributor Author

Also, there's the malloc_consolidate: invalid chunk size again.

@thorstenhater
Copy link
Copy Markdown
Contributor Author

bors try

bors Bot added a commit that referenced this pull request Oct 13, 2022
@bors
Copy link
Copy Markdown

bors Bot commented Oct 14, 2022

try

Build failed:

@brenthuisman
Copy link
Copy Markdown
Contributor

bors try

bors Bot added a commit that referenced this pull request Oct 17, 2022
@brenthuisman
Copy link
Copy Markdown
Contributor

ci/release/build.Dockerfile contains a hardcoded URL to CMake 3.16 (Bors failed on that line, not the tests this time). Since elsewhere there was a bump, we could do so here too.

@bors
Copy link
Copy Markdown

bors Bot commented Oct 17, 2022

try

Build failed:

@thorstenhater
Copy link
Copy Markdown
Contributor Author

That file hasn't changed in a while and I have this:

RUN wget -q "https://github.com/Kitware/CMake/releases/download/v3.18.6/cmake-3.18.6-Linux-x86_64.tar.gz" -O cmake.tar.gz && \
    echo "87136646867ed65e935d6bacd44d52a740c448ad0806f6897d8c3d47ce438c8b cmake.tar.gz" | sha256sum --check --quiet && \
    tar --strip-components=1 -xzf cmake.tar.gz -C /usr/local && \
    rm -rf cmake.tar.gz

@thorstenhater thorstenhater merged commit cef0d1d into arbor-sim:master Oct 20, 2022
@thorstenhater thorstenhater deleted the ux/simpler-cable-cell branch October 20, 2022 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

interface Anything user-facing, including public C++ and Python APIs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants