For a job not to queue until minimally required parameters are set

Features and Functionality
1

Hello,

It would be a nice feature if the job won’t queue until the minimally required parameters are set, by giving some kind of error message or something.

Sometimes it’s a new job that I’m not familiar with, other times it’s an honest mistake - but having some kind of *required label on required parameters or such a message or error that pops up before the job queues would be helpful to save time. Sometimes my jobs queue for a couple of days because I use a cluster, only for it to fail in the first second because I missed a parameter by accident/out of ignorance.

Many thanks!

2

Thanks @newbie for this request. May I ask

  1. What version of CryoSPARC do you use?
  2. Please can you provide example pairings of job type and parameter name for which you encountered this problem?
3

Thanks for responding.

  1. I’m currently using v4.7.1 due to incompatibility issues with the update on our cluster. I’ll be updating it whenever we get this issue fixed. I apologize if this suggestion has already been addressed in the newer version.

  2. I also apologize if the examples here are silly, but I made the mistake of deleting some other jobs that gave similar errors, so these are the only ones I have on hand:

E.g. Volume alignment tools. I haven’t used it before and I wasn’t sure of what settings I’m supposed to pick, so I just let it run without changing any parameters from the default.

Understandably, it gave me this error when it ran:
AssertionError: No action was specified. Please input a 3D shift to perform re-centering, and/or activate symmetry alignment to do symmetry alignment
It would’ve been nice to know that I need either or before I let it run. It thankfully didn’t queue for long because it’s not a resource-intensive job.

e.g. For the sharpen tool, I didn’t supply an input mask nor activate the ‘Generate new FSC mask’ parameter, so once it ran it gave me this error
AssertionError: If not supplying an input mask, the 'Generate new FSC mask' parameter must be activated!

this is kind of different, but e.g. for local refinement I got this error when I tried used 180 deg for the search extent
AssertionError: Search space must not cover all of SO(3)

I tried searching for information on it in the documentation/tutorials, but I couldn’t find it. It would be nice to know if there are ‘forbidden’ values beforehand as well.

I’m aware a lot of these types of errors could be avoided, but I just thought to suggest this anyway because it would be a nice to have.

4

Please update this topic when you had a chance to test CryoSPARC v5, where parameter validation has changed compared with CryoSPARC v4.

1 Like