Packaging with MOOSE python modules as dependencies

[jvwilliams23]

Check these boxes if you have followed the posting rules.

• Q&A General is the most appropriate section for my question
• I have consulted the posting Guidelines on the Discussions front page
• I have searched the Discussions forum and my question has not been asked before
• I have searched the MOOSE website and the documentation does not answer my question
• I have formatted my post following the posting guidelines (screenshots as a last resort, triple back quotes around pasted text)

Question

Hi,

I have made a small python package for doing UQ on workflows including MOOSE simulations. To make my work usable, I want to package it up with pip and incorporate some unit testing etc. Some parts of the code depend on MOOSE's python modules pyhit and moosetree for reading, modifying and writing input files for simulations. As far as I can tell, the only way to use pyhit and moosetree is to add them to my PYTHONPATH manually.

I was wondering, is there any way around this? For running CI unit tests, I do not really want to add MOOSE as a submodule and clone it for all the tests, since it is a pretty large repo and I only need a tiny part of it. As a worst-case scenario, I could just avoid writing tests for that part of the code.

[GiudGiud]

Hello

There used to be a moose-tools package you could get from conda.
@milljm will know more where we stand on this

[milljm]

Yeah, it looks like you're using an older instance of Conda. Not the issue, but just FYI if you are tired of lengthy solves (installing moose-dev using this instance of Conda will/is probably taking around 30 minutes), updating to a later release will greatly speed things up. To elaborate, your conda info should include this within the output:

         python version : 3.10.14.final.0
                 solver : libmamba (default)     <-------
       virtual packages : __archspec=1=m2
                          __conda=24.9.2=0
                          __osx=14.7.1=0
                          __unix=0=0

Anyways, the real issue here is that our packages are built using conda-forge's compilers. So you'll need to add that channel into the mix in order to install anything from our public channel:

conda config --add channels conda-forge
conda config --add channels https://conda.software.inl.gov/public

You'll get a warning about our channel already added but moving to the top... this is good

Once that is complete, try your conda create command again!

[milljm]

I just read that this may be an instance of Conda you don't have control over (HPC). If that is true, I think in that case the following should work:

conda create -n testing moose-pyhit=2022 \
 --channel https://conda.software.inl.gov/public \
 --channel conda-forge

That way, you're not modifying the channels in place already.

[jvwilliams23]

Thanks @milljm, I managed to download moose-pyhit! Do you know how to get moosetree? My code relies on moosetree.find

[milljm]

Indeed, comes with :)

>>> from pyhit import moosetree
>>> moosetree.__file__
'/Users/milljm/miniforge/envs/testing/lib/python3.10/site-packages/pyhit/moosetree/__init__.py'

[jvwilliams23]

Perfect, thank you!

[milljm]

Oh, sorry. I should have demonstrated moosetree.find('node'). But I was more interested in demonstrating access to moosetree, without needing a clone of the moose repository.

Cheers!