-
Notifications
You must be signed in to change notification settings - Fork 1
Add tutorial for running small demo workflow on local machine #8
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
Comments
@Gbowker which workflows would be suitable for running on a laptop? |
Hi @SJaffa so since I said this I have realised that only the tasks which use python in practace anyone could use, becuase MTEX requires a matlab licence and Damask requires a powerful computer. The best demo workflows in this case would be ones in which just use python. BUT the only one at the moment is Proposed easy to run demo-workflow: - schema: generate_microstructure_seeds_from_random
inputs:
VE_size: [1, 1, 1]
num_grains: 4
phase_label: demo
- schema: generate_volume_element_from_voronoi
inputs:
homog_label: SX
VE_grid_size: [8, 8, 8]
- schema: visualise_volume_element I think this would be the best workflow for a user to run first becuase it introduces them to the idea of making the models which our team create for our work. @gcapes what do you think? |
The |
@Gbowker I like your suggestion. For me, the ideal first demo would only need python and no other software, and run quickly. As such, I chose the existing demo workflow https://github.com/hpcflow/matflow-new/blob/develop/matflow/data/workflows/modify_volume_element_grid_size.yaml for my getting started section of the docs that I'm working on, on the It's very similar (the same even?) as what you proposed (I'm not sure if I don't like the idea of complicating a quick demo with having to install docker. My motivation for this is to get something running as quickly as easily as possible so that someone can verify their installation/config. |
In Monday meeting discussed the scale of tutorials and agreed it would be best to have a progression:
|
Me and @mikey247 worked through setting up and submitting some workflows on our laptops. We think we successfully installed MatFlow and dependencies, added the config and envs files to
They both said "Submitted N jobs" and produced some output files and folders but running We also tried Gerard's dummy workflows Follow up questions and next steps:
|
I got one to run successfully! Using MatFlow, version 0.3.0a149 and hpcFlow, version 0.2.0a209 I can run |
If you submit workflows using different versions of matflow, it (usually?) breaks |
This is blocked until we get the dummy workflows running with a pinned matflow/HPCflow version, and document their expected outputs |
Progress: tested all dummy workflows on my laptop (two work, one fails), and one demo workflow (fails). Learned what the output looks like and where the log & error messages will go. |
For people who are new to MatFlow there are a lot of concepts to pick up in order to understand the documentation and effectively set up your own workflow. A good way to learn some of the concepts without extra cognitive load might be to follow a tutorial to run a minimal workflow on your own laptop. This would have very detailed instructions and no decisions for the user to make.
This can help people learn the general purpose of each step in the setup, some of the jargon, and make sure they can see the whole process to the end. This should make it much easier when trying to install on a HPC cluster.
This should be linked from the landing page of the documentation.
The text was updated successfully, but these errors were encountered: