Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs mechabi #1610

Merged
merged 3 commits into from
Aug 2, 2021
Merged

Docs mechabi #1610

merged 3 commits into from
Aug 2, 2021

Conversation

brenthuisman
Copy link
Contributor

  • Bit of review on the copy of the mech abi docs.
  • Convert api/abi docs to C Domain directives.
  • 'the library' -> Arbor

Questions:

  • Why do the comments on the fields of arb_ion_info end in questions marks?
  • Mechanism Plugin: I removed the word plugin because it was not consistently used, but it maybe useful to describe it as such. Should we consistently use that term to separate user provided code from Arbor (formerly known as 'the library')?

Copy link
Contributor

@thorstenhater thorstenhater left a comment

Choose a reason for hiding this comment

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

lgtm

@thorstenhater
Copy link
Contributor

The question marks are indicating that these are binary flags.

@thorstenhater
Copy link
Contributor

I cannot comment on the CSS changes.

@brenthuisman brenthuisman merged commit 7945057 into arbor-sim:master Aug 2, 2021
max9901 added a commit to max9901/arbor that referenced this pull request Aug 5, 2021
* Ci/sanitize (arbor-sim#1521)

Add clang sanitizer passes to GH CI.

* Tutorial structure: remove deduplication, includify (arbor-sim#1575)

* added notes re literal_include to python examples
* merged changes in arbor-sim#1504 
* deduped and includified (arbor-sim#1558) tutorials.
* First divergence of tutorial and code spotted!
* Added some contrib documentation for examples and docs.

* Implement mechanism ABI

Implements arbor-sim#1376.

* Provide a common C linkage ABI for externally compiled mechanisms, for both CPU and GPU.
* Remove mechanism type hierarchy (`concrete_mechanism` etc.), and move corresponding functionality to the back-end shared state objects. Mechanism catalogue is no longer indexed by type id.
* Distinguish between SIMD optimal alignment and SIMD width with new `min_align` attribute. Mechanisms provide both pieces of information via ABI.

* update spack package to include fmt for [email protected]: (arbor-sim#1609)

* alles werkt weer allen smol_dend niet;'

* nu werkt het

* Docs mechabi (arbor-sim#1610)

* Bit of review on the copy of the mech abi docs.
* Convert api/abi docs to C Domain directives.

* Bug/assorted static analysis (arbor-sim#1615)

* Fix failure to return value in `py_mech_cat_value_iterator `.
* String butchered by formatting.
* Join unnecessary separation of string literals in `arborio/cabelio.cpp`
* Add missing throw in s_expr code.
* Return value, not reference, in `merge_iterator::operator++(int)`.
* Check for self-assignment in `mechanism_catalogue`.
* Initialize all members of `mechanism`.
* Fix index check order in `multi_event_stream` debug output.
* Use coordinator_ from base class in `memory::array`.

Co-authored-by: thorstenhater <[email protected]>
Co-authored-by: Brent Huisman <[email protected]>
Co-authored-by: Ben Cumming <[email protected]>
max9901 added a commit to max9901/arbor that referenced this pull request Aug 9, 2021
* Ci/sanitize (arbor-sim#1521)

Add clang sanitizer passes to GH CI.

* Tutorial structure: remove deduplication, includify (arbor-sim#1575)

* added notes re literal_include to python examples
* merged changes in arbor-sim#1504 
* deduped and includified (arbor-sim#1558) tutorials.
* First divergence of tutorial and code spotted!
* Added some contrib documentation for examples and docs.

* Implement mechanism ABI

Implements arbor-sim#1376.

* Provide a common C linkage ABI for externally compiled mechanisms, for both CPU and GPU.
* Remove mechanism type hierarchy (`concrete_mechanism` etc.), and move corresponding functionality to the back-end shared state objects. Mechanism catalogue is no longer indexed by type id.
* Distinguish between SIMD optimal alignment and SIMD width with new `min_align` attribute. Mechanisms provide both pieces of information via ABI.

* update spack package to include fmt for [email protected]: (arbor-sim#1609)

* Docs mechabi (arbor-sim#1610)

* Bit of review on the copy of the mech abi docs.
* Convert api/abi docs to C Domain directives.

* Bug/assorted static analysis (arbor-sim#1615)

* Fix failure to return value in `py_mech_cat_value_iterator `.
* String butchered by formatting.
* Join unnecessary separation of string literals in `arborio/cabelio.cpp`
* Add missing throw in s_expr code.
* Return value, not reference, in `merge_iterator::operator++(int)`.
* Check for self-assignment in `mechanism_catalogue`.
* Initialize all members of `mechanism`.
* Fix index check order in `multi_event_stream` debug output.
* Use coordinator_ from base class in `memory::array`.

Co-authored-by: thorstenhater <[email protected]>
Co-authored-by: Brent Huisman <[email protected]>
Co-authored-by: Ben Cumming <[email protected]>
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