Documentation and Examples

[jasonnicholson]

I forked your repository. I am working on writing documentation and examples. I plan to send you a pull request once it is more complete. Here the items that I can identify are of use:

• Simple starter examples. You have some of this.
• Complicated, multi-input functions. i.e. The equivalent of like a triple or quadruple for loop.
• global_data function use.
• Setting up SSH on windows with batch_job in a corporate environment.
• Simulink examples and recommendations.
• More information on memory mapping.

If you have more requests, please put them here: https://github.com/jasonnicholson/batch_job/issues
or just reply to this message.

The final product will be like this:
https://www.mathworks.com/matlabcentral/fileexchange/61436-jasonnicholson-regularizend

Current formated documentation is here:
https://github.com/jasonnicholson/batch_job/tree/master/Documentation/html

Examples are here:
https://github.com/jasonnicholson/batch_job/tree/master/Examples

[ojwoodford]

Hi Jason. That all sounds great! I'll take a look when it's done. I'd also love to ask you a few questions:

• Do you use the toolbox much?
• Is your aim to make your regularizeNd function work efficiently on large datasets?
• I know the documentation isn't great, but the toolbox also doesn't seem to have that many users. Do you feel it would if better documented?
• Have you successfully used the SSH stuff, and if so on what OS? I've found not many people have success with that.

Thanks for your input!

[jasonnicholson]

I have used the toolbox several times. I want to use it more especial as I ramp up testing of my simulink models for automated tests split over multiple PCs.

regularizeNd is very efficient on large datasets. I regularly work with matrices up to rank 1e8. I really haven't needed bigger for now.

Yes, I think batch_job would have a lot more users with better documentation. It is clear you are very smart and batch_job was written with greatly flexibility to do complicated tasks. The barrier to entry to use the tool could be better. Examples and documentation are needed. I plan to document it and then suggest it to colleagues.

I use SSH on Linux. I have done SSH on windows but it has been a while.

I have already looked deep into the code and rearranged things for cleaner execution and clarity. I think that even if SSH is a problem, I can use another remote tool to get things working. Basically my guess is that I need to get remote command line session running some way. There is lots of options.

[ojwoodford]

Sounds good. Thanks.