Add to Getting Started doc necessary dependencies on Stan and Stan Math

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 Getting Started doc necessary dependencies on Stan and Stan Math #136

Closed roualdes closed 1 year ago

roualdes commented 1 year ago

From our review for the Journal of Open Source Software, https://github.com/openjournals/joss-reviews/issues/5236, it was recommended that we address more clearly our software dependencies on Stan and Stan Math, including mentioning these as included git submodules.

bob-carpenter commented 1 year ago

Seems obvious to us, but definitely worth mentioning. We can just add a section on dependencies and include NumPy. Is there anything else?

bob-carpenter commented 1 year ago

We should also include the dependencies within Stan itself:

Boost
Eigen
Sundials
TBB
(are there any more I'm forgetting here?)

And the required dependency for building:

make

What about dependencies within Python, R, Julia, Rust? I think C is dependency-free at least.

I would say that we do not have a dependency on

because a user could download the zip or one of our releases.

WardBrian commented 1 year ago

The individual documentation pages for each language interface mention their dependencies, so I think we're good there.