Installation#

You can install emg3d either via conda:

conda install -c conda-forge emg3d

or via pip:

pip install emg3d

Requirements are the modules numpy, scipy, numba, and empymod. Various other packages are recommended or required for some advanced functionalities, namely:

  • xarray: For the emg3d.surveys.Survey and emg3d.simulations.Simulation classes (model many sources and frequencies at once).

  • discretize: For advanced meshing tools (fancy mesh-representations and plotting utilities).

  • matplotlib: To use the plotting utilities within discretize.

  • ipympl: To use the interactive plotting utilities in Jupyter.

  • h5py: Save and load data in the HDF5 format.

  • tqdm: For nice progress bars when computing many sources and frequencies.

All soft dependencies are also available both on conda-forge and pip. To get therefore the complete experience use one of the following options:

conda install -c conda-forge emg3d discretize xarray matplotlib ipympl h5py tqdm

or via pip:

pip install emg3d[full]

The wrappers provided in emg3d.inversion may require additional packages, please consult the Inversion-API for more information.

If you are new to Python we recommend using a Python distribution, which will ensure that all dependencies are met, specifically properly compiled versions of NumPy and SciPy; we recommend using Anaconda. If you install Anaconda you can simply start the Anaconda Navigator, add the channel conda-forge and emg3d will appear in the package list and can be installed with a click.

Using NumPy and SciPy with the Intel Math Kernel Library (mkl) can significantly improve computation time. You can check if mkl is used via conda list: The entries for the BLAS and LAPACK libraries should contain something with mkl, not with openblas. To enforce it you might have to create a file pinned, containing the line libblas[build=*mkl] in the folder path-to-your-conda-env/conda-meta/.

This Page