search

roualdes / bridgestan

BridgeStan provides efficient in-memory access through Python, Julia, and R to the methods of a Stan model.
https://roualdes.github.io/bridgestan
BSD 3-Clause "New" or "Revised" License
88 stars 12 forks source link

Add to Julia interface docs required STAN_THREADS for tests #147

Closed roualdes closed 1 year ago

roualdes commented 1 year ago

This PR addresses issue #145 by adding a section to the Julia interface docs detailing the multi-threaded capabilities of Julia, how they coordinate with the BridgeStan API, and the fact that we test against this, thus requiring STAN_THREADS=true to be set for our Julia tests to run successfully.

I'd prefer to link to the function compile_model, but I don't know how to set up an internal link to that specific anchor in our docs.

WardBrian commented 1 year ago

How would you feel about putting this in CONTRIBUTING.md rather than the user docs?

roualdes commented 1 year ago

Ya, that makes sense, since this is mostly about testing and we already mention in the customizing bridgestan section of Getting Started that one needs stan_threads set for parallel calls of a stan program.

Give me a second and I'll make the change.