Docstrings, type-hints, documentation fixes

[QuantumChemist]

improving docstring, adding type-hints, improving documentation

• docstrings
• type-hints
• documentation
  • adding more jobflow-remote documentation

Working through Aakash's suggestions #71 (comment)

[JaGeo]

Let me know when I can merge 😀

[QuantumChemist]

Let me know when I can merge 😀

I'm adding a few more things for jobflow-remote. Then you can merge :)
(forgot that, only remembered when I was ticking off the finished tasks)

[QuantumChemist]

I added a more detailed jobflow-remote setup tutorial now. It's based on Aakash's documentation for our BAM group.

I deactivated the Actions workflows for Testing_Python to save Actions time. When the previous one https://github.com/QuantumChemist/autoplex/actions/runs/9811364709 has finished, you can merge the PR, @JaGeo 😆

[JaGeo]

👀

[naik-aakash]

I added a more detailed jobflow-remote setup tutorial now. It's based on Aakash's documentation for our BAM group.

I deactivated the Actions workflows for Testing_Python to save Actions time. When the previous one https://github.com/QuantumChemist/autoplex/actions/runs/9811364709 has finished, you can merge the PR, @JaGeo 😆

Hi @QuantumChemist , would you mind also mentioning this in the docs that it was written by me and adapted?

[QuantumChemist]

I added a more detailed jobflow-remote setup tutorial now. It's based on Aakash's documentation for our BAM group.
I deactivated the Actions workflows for Testing_Python to save Actions time. When the previous one https://github.com/QuantumChemist/autoplex/actions/runs/9811364709 has finished, you can merge the PR, @JaGeo 😆

Hi @QuantumChemist , would you mind also mentioning this in the docs that it was written by me and adapted?

Ok done ✅
https://github.com/JaGeo/autoplex/blob/main/docs/user/jobflowremote.md

I hope this is your bam email (not sure if your second name is included).

I only removed the cluster names and sensitive information, and improved the grammar a bit, so it's not necessary to put my name, too. ☺️

[JaGeo]

@QuantumChemist could you add info about the -i?

[QuantumChemist]

@QuantumChemist could you add info about the -i?

You mean when activating the runner? I will do that in the next PR then. I don't want to use up all your action time.

[JaGeo]

No, what the -i means. I don't think every user might need this. I think we still need to add to this documentation.

[QuantumChemist]

No, what the -i means. I don't think every user might need this. I think we still need to add to this documentation.

just to make sure I understand you correctly: are you referring to this?
https://github.com/JaGeo/autoplex/blob/c7828b5dbe2cacb1b2ec683a81d8e935cf90b7a5/docs/user/jobflowremote.md?plain=1#L61

[JaGeo]

Yes, exactly. This means "interactive mode"

[QuantumChemist]

Added more details and basically how the users can help themselves.
https://github.com/QuantumChemist/autoplex/blob/main/docs/user/jobflowremote.md

Will merge it with the next PR to save the Action time for now 😄