search

lanl / dfnWorks

dfnWorks is a parallelized computational suite to generate three-dimensional discrete fracture networks (DFN) and simulate flow and transport. If you download the software please fill out our interest form to stay up to date on releases https://goo.gl/forms/VE39oKsyp4LVC6Gj2 and join our google group https://groups.google.com/d/forum/dfnworks-users . Precompiled Docker Container https://hub.docker.com/r/ees16/dfnworks
https://dfnworks.lanl.gov/
Other
73 stars 42 forks source link

Easier installation suggestion #77

Open gbene opened 6 months ago

gbene commented 6 months ago

Hi again!

I am opening another issue since it is completely unrelated from the first that I made today.

DFNWorks is fantastic but I find it a bit cumbersome to install and use pydfnworks. All the different components to compile locally in multiple machines and OSs takes quite a bit of time. I was wandering if you ever considered to organize and compact the pip package by including precompiled binaries of lagrit, DFGen etcetc. You could do this by including the binaries in a folder inside the package itself (so for example in pydfnworks>builds).

This would firstly simplify a lot the path management. Since the precompiled libraries are in a folder within the library there won't be the need to use the .dfnworksrc file. Secondly, with a bit of work, it could be possible to make DFNWorks crossplatform!

Implementation of this should not be that difficult because It would require to add the paths of the precompiled libraries in the package_data dict in setup.py like this:

        ...
        package_data={'': ['dfnGen/generation/output_report/figures/*png',
                           'builds/ConnectivityTest',
                           'builds/correct_stor',
                           'builds/correct_uge',
                           'builds/DFNGen',
                           'builds/lagrit',]}
      )

and then add in the init.py a way to get the internal path (that is also the the dfnworks_PATH). Something like this:

...
file_path = os.path.realpath(__file__)

internal_filepath = os.path.dirname(file_path)
os.environ['dfnworks_PATH'] = internal_filepath

os.environ['DFNGEN_EXE'] = os.path.join(os.environ['dfnworks_PATH'], 'builds/DFNGen')
os.environ['CORRECT_UGE_EXE'] = os.path.join(os.environ['dfnworks_PATH'], 'builds/correct_uge')
os.environ['CORRECT_STOR_EXE'] = os.path.join(os.environ['dfnworks_PATH'], 'builds/correct_stor')
os.environ['CONNECT_TEST_EXE'] = os.path.join(os.environ['dfnworks_PATH'], 'builds/ConnectivityTest')
os.environ['LAGRIT_EXE'] = os.path.join(os.environ['dfnworks_PATH'], 'builds/lagrit')
...

The difficult part would be to automate the compilation of the different libraries (maybe using github actions?).

Let me know your thoughts about this!

Thank you again!

hymanjd commented 6 months ago

Thank you kindly for the recommendations. For those interested in simpler installation, we provide a docker container. If you would like to test this and submit a pull request, you're most welcome to. Thanks!