.. _install_dlls: Install a Compiler and Build DLLs ================================== Two dynamic-link library (DLL) files are required for **pyHS2MF6** operation. The installation and compilation discussion is presented for use on Windows operating systems. These instructions can easily be adapted for use on Linux operating systems. | .. note:: On a Linux system, these two DLL files would be dynamic load library, `so`, files. | The purpose of the DLL files is two-fold. 1. Make MODFLOW 6.2.1 available to Python programs and the Python 3 interpreter 2. Incorporate extended types or objects into MODFLOW 6.2.1 to enable sharing of information between independent HSPF and MODFLOW 6 processes, or models. | .. caution:: Two DLL files are in the `pyHS2MF6\\bin\\pyMF6` folder. Both of these files were created by compiling Fortran source code. These two DLL files were compiled on a system with the following characteristics. * Windows 10, 64-bit OS, Intel x64-based processor * Python 3.8, 64-bit If your computer has equivalent characteristics and software, you can try using the versions of **mf6.dll** and **pyMF6.cp38-win_amd64.pyd** that are in the `pyHS2MF6\\bin\\pyMF6` folder. Most likely, you will need to recreate these DLL files to work on your particular computer system. | .. _install_fortran: Install a Compiler -------------------- A Fortran compiler, that supports Fortran 95 and 2008 standards, is needed to transform the Fortran source code files into DLL files. The `MinGW `_ port of the GNU Compiler Collection (GCC) Fortran compiler, `GFortran `_, was used to compile the two DLL files included in the `pyMF6` folder. * **mf6.dll** * **pyMF6.cp38-win_amd64.pyd** | .. note:: Instructions are only available here for `MinGW GFortran` on the Windows 10 OS. However, any Fortran compiler that supports the 1995 and 2008 standards and is supported by :abbr:`F2PY (Fortran to Python interface generator)` could be used in place of `MinGW GFortran`. On linux systems, GFortran can usually be installed through a customized installation of the GNU Compiler Collection (GCC) using the linux distribution package manager. | To obtain, GFortran as part of `MinGW `_ : * `Install 32-bit MinGW `_ * `Install 64-bit MinGW `_ | .. caution:: Be sure to add the `bin` directory from the MinGW installation to your PATH environment variable before continuing to the next steps. | .. _install_f2py: Configure NumPy F2PY ~~~~~~~~~~~~~~~~~~~~~~~~~ :abbr:`F2PY (Fortran to Python interface generator)` provides a connection between Fortran and Python programming languages. :abbr:`F2PY (Fortran to Python interface generator)` provides this connection by inserting interface information into Fortran source code file and then using a Fortran compiler to compile both the source code and the interface specification to a `PYD` file. A `PYD` is a `DLL` file that has a special function and some additional declarations so that it can be loaded into a Python program or the Python 3 interpreter. :abbr:`F2PY (Fortran to Python interface generator)` was installed with `NumPy `_ in :ref:`install_pyconda`. There is one configuration item that seems to be required to have Python and :abbr:`F2PY (Fortran to Python interface generator)` use the MinGW compiler. The user needs to create a `pydistutils.cfg `_ file in their home directory. The contents of the `pydistutils.cfg` file should be: :: [build] compiler=mingw32 After installing a Fortran compiler and configuring :abbr:`F2PY (Fortran to Python interface generator)`, it is best to test your installation and configuration before moving on to building the DLL files. * `A simple F2PY test case and tutorial `_ | .. _install_builddlls: Build DLL Files ------------------------- The following steps are required to build the DLL files from the source code files. 1. Obtain the `MODFLOW 6, version 6.2.1 distribution `_ including source code from the `USGS `_. * Extract `mf6.2.1` from the zip archive and place it at the root of the `C:\\` so that have the MODFLOW 6 root directory of at `C:\\mf6.2.1`. 2. Make a new directory `cp_Modules` within the `make` sub-directory so that have `C:\\mf6.2.1\\make\\cp_Modules`. 3. Copy the five Fortran source code files, listed below, from `pyHS2MF6\\src\\pyMF6` to `C:\\mf6.2.1\\make\\cp_Modules` * f2PWrappers.f90 - :ref:`pyMF6_f2pwrap_f` * cp_SimulationCreate.f90 - :ref:`pyMF6_cphSimulationCreateModule_f` * cp_gwf3.f90 - :ref:`pyMF6_cphGwfModule_f` * cp_gwf3uzf8.f90 - :ref:`pyMF6_cphUzfModule_f` * cp_gwf3drn8.f90 - :ref:`pyMF6_cphDrnModule_f` 4. Copy the modified makefiles, `modmakefile` and `modmakedefaults` from `pyHS2MF6\\installation` to `C:\\mf6.2.1\\make` * These are a modified versions of the files `C:\\mf6.2.1\\make\\makefile` and `C:\\mf6.2.1\\make\\makedefaults`. The modifications result in a DLL instead of an EXE, and the modified makefile uses DOS commands instead of UNIX shell commands. * If you would like to make a modified makefile for Linux, just compare the files: `C:\\mf6.2.1\\make\\makefile` to `C:\\mf6.2.1\\make\\modmakefile` and `C:\\mf6.2.1\\make\\makedefaults` to `C:\\mf6.2.1\\make\\modmakedefaults`. The required modifications should be identifiable. 5. Open an Anaconda Prompt, activate the pyhs2mf6 environment, and make the active directory `C:\\mf6.2.1\\make`. :: (base) > conda activate pyhs2mf6 (pyhs2mf6) > cd C:\mf6.2.1\make (pyhs2mf6) C:\mf6.2.1\make > 6. Create the DLL file, `C:\\mf6.2.1\\make\\bin\\mf6.dll`, using the MODFLOW 6 source code, four of the source code files in `cp_Modules`, and `modmakefile`. :: (pyhs2mf6) C:\mf6.2.1\make > mingw32-make.exe --makefile=modmakefile all 7. Copy `C:\\mf6.2.1\\make\\bin\\mf6.dll` to `C:\\mf6.2.1\\make\\mf6.dll` 8. Create the PYD file, `C:\\mf6.2.1\\make\\pyMF6.cp38-win_amd64.pyd`, using F2PY by linking to `C:\\mf6.2.1\\make\\mf6.dll` and compiling `cp_Modules\\f2PWrappers.f90`. :: (pyhs2mf6) C:\mf6.2.1\make > f2py.exe -c -m pyMF6 -L.\ -lmf6 -I.\obj_temp\ -I.\mod_temp\ --verbose .\cp_Modules\f2PWrappers.f90 9. Copy the DLL and PYD files from `C:\\mf6.2.1\\make` to `pyHS2MF6\\bin\\pyMF6`.