StochasticAnalytics / emClarity

GNU Lesser General Public License v3.0
41 stars 6 forks source link

build instructions #64

Closed brevans closed 1 year ago

brevans commented 6 years ago

Would be really nice to have some documentation on how to build this for ourselves. I help to maintain a software stack on a shared compute environment where it would be really nice to add your tool to our automated build recipes.

It looks like the build script is testScripts/mCompile.sh ? What argument needs to be passed?

bHimes commented 6 years ago

Hi @brevans

Up until now, I've really only used the master branch, which would make a third party build pretty risky as I like to break my code on the daily.

I've just made clean copies of the alpha, and development branches, and will change practice to work on development, merging into alpha when needed and into master when trusted. Then it should be reasonably safe to build from the master branch.

I'll add a section to the wiki with details on what is needed for a build sometime in the next day or so.

Thanks for the suggestion!

Ben H.

( Ps. May I ask where you are working ? )

brevans commented 6 years ago

Awesome. I don't mind/am accustomed to just pointing at a commit hash and hoping for the best if someone is interested in testing. We keep multiple versions available where necessary for testing/reproducibility.

I work at Yale. One of my jobs is to support researchers on the compute clusters. The one folks want to run emClarity on is a mix of K80/1080Ti/p100/TitanV. So we are all over the place. Happy to provide feedback/pull requests as you continue. Keep up the good work.

🍻🍻 -also Ben

bHimes commented 6 years ago

@brevans

Hi Ben,

It looks like there really isn't anything to do other than to run the script with no arguments. (Previously needed to compile for different matlab releases)

I added a little blurb on the installation page of the wiki. Would it be useful to describe the arguments passed to mcc? Any other useful info? Otherwise I'll consider it done.

Ben

brevans commented 6 years ago

Looks like you need to pass it a .m file though, yes? https://github.com/bHimes/emClarity/blob/fa82c80ee4e2d0084468337c9143fc00d662dd9c/testScripts/mCompile.sh#L6

bHimes commented 6 years ago

Hahah, right. I've updated the section on the wiki then to include >$ ./mCompile emClarity.m

In principle, this could just be hardcoded into the script, as compiling the individual library functions (BH_....) is probably unlikely, but in principle, you could make stand-alone programs too which could be nice in some cases.

bHimes commented 6 years ago

Hi @brevans, did everything compile okay? Good to close?