.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "content/examples/04-dcip/plot_read_DC_data_with_IO_class.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_content_examples_04-dcip_plot_read_DC_data_with_IO_class.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_content_examples_04-dcip_plot_read_DC_data_with_IO_class.py:


Reading and Plotting data with DC.IO class
==========================================

The DC.IO class is a convenient way to handle DC data and
carry inversions within a same class. It also has several plotting utils
such as pseudosections. We show here an example of plotting DC data based
on a demonstration dataset.

.. GENERATED FROM PYTHON SOURCE LINES 10-20

.. code-block:: Python


    import numpy as np
    import pandas as pd
    import shutil
    import os
    import matplotlib.pyplot as plt
    from SimPEG.electromagnetics.static import resistivity as DC
    from SimPEG import Report
    from SimPEG.utils.io_utils import download








.. GENERATED FROM PYTHON SOURCE LINES 21-24

Download an example DC data csv file
------------------------------------


.. GENERATED FROM PYTHON SOURCE LINES 24-36

.. code-block:: Python


    # file origina and name
    url = "https://storage.googleapis.com/simpeg/examples/dc_data.csv"
    fname = download(url, folder="./test_url", overwrite=True)

    # read csv using pandas
    df = pd.read_csv(fname)
    # header for ABMN locations
    header_loc = ["Spa." + str(i + 1) for i in range(4)]
    # Apparent resistivity
    header_apprho = df.keys()[6]





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Downloading https://storage.googleapis.com/simpeg/examples/dc_data.csv
       saved to: /home/vsts/work/1/s/examples/04-dcip/test_url/dc_data.csv
    Download completed!




.. GENERATED FROM PYTHON SOURCE LINES 37-40

Convert file to DC.IO object
----------------------------


.. GENERATED FROM PYTHON SOURCE LINES 41-65

.. code-block:: Python


    # Number of the data
    ndata = df[header_loc[0]].values.size
    # ABMN locations
    a = np.c_[df[header_loc[0]].values, np.zeros(ndata)]
    b = np.c_[df[header_loc[1]].values, np.zeros(ndata)]
    m = np.c_[df[header_loc[2]].values, np.zeros(ndata)]
    n = np.c_[df[header_loc[3]].values, np.zeros(ndata)]
    # Apparent resistivity
    apprho = df[header_apprho].values

    # Create DC.IO survey Object object
    IO = DC.IO()
    # Generate DC survey using IO object
    dc_survey = IO.from_abmn_locations_to_survey(
        a,
        b,
        m,
        n,
        survey_type="dipole-dipole",
        data_dc=apprho,
        data_dc_type="apparent_resistivity",
    )





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    /home/vsts/work/1/s/examples/04-dcip/plot_read_DC_data_with_IO_class.py:53: UserWarning:

    code under construction - API might change in the future





.. GENERATED FROM PYTHON SOURCE LINES 66-69

Plot
----


.. GENERATED FROM PYTHON SOURCE LINES 70-79

.. code-block:: Python

    fig, ax = plt.subplots(1, 1, figsize=(10, 3))
    IO.plotPseudoSection(
        data_type="apparent_resistivity", scale="linear", clim=(0, 1000), ncontour=3, ax=ax
    )
    plt.show()

    # clean up
    shutil.rmtree(os.path.expanduser("./test_url"))




.. image-sg:: /content/examples/04-dcip/images/sphx_glr_plot_read_DC_data_with_IO_class_001.png
   :alt: plot read DC data with IO class
   :srcset: /content/examples/04-dcip/images/sphx_glr_plot_read_DC_data_with_IO_class_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 80-83

Print the version of SimPEG and dependencies
--------------------------------------------


.. GENERATED FROM PYTHON SOURCE LINES 83-86

.. code-block:: Python


    Report()






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <table style='border: 1.5px solid;'>
      <tr>
         <td style='text-align: center; font-weight: bold; font-size: 1.2em; border: 1px solid;' colspan='6'>Wed Apr 10 20:01:29 2024 UTC</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>OS</td>
        <td style='text-align: left; border: 1px solid;'>Linux</td>
        <td style='text-align: right; border: 1px solid;'>CPU(s)</td>
        <td style='text-align: left; border: 1px solid;'>2</td>
        <td style='text-align: right; border: 1px solid;'>Machine</td>
        <td style='text-align: left; border: 1px solid;'>x86_64</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>Architecture</td>
        <td style='text-align: left; border: 1px solid;'>64bit</td>
        <td style='text-align: right; border: 1px solid;'>RAM</td>
        <td style='text-align: left; border: 1px solid;'>6.8 GiB</td>
        <td style='text-align: right; border: 1px solid;'>Environment</td>
        <td style='text-align: left; border: 1px solid;'>Python</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>File system</td>
        <td style='text-align: left; border: 1px solid;'>ext4</td>
      </tr>
      <tr>
         <td style='text-align: center; border: 1px solid;' colspan='6'>Python 3.8.19 | packaged by conda-forge | (default, Mar 20 2024, 12:47:35) 
    [GCC 12.3.0]</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>SimPEG</td>
        <td style='text-align: left; border: 1px solid;'>0.21.1</td>
        <td style='text-align: right; border: 1px solid;'>discretize</td>
        <td style='text-align: left; border: 1px solid;'>0.10.0</td>
        <td style='text-align: right; border: 1px solid;'>pymatsolver</td>
        <td style='text-align: left; border: 1px solid;'>0.2.0</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>numpy</td>
        <td style='text-align: left; border: 1px solid;'>1.24.4</td>
        <td style='text-align: right; border: 1px solid;'>scipy</td>
        <td style='text-align: left; border: 1px solid;'>1.10.1</td>
        <td style='text-align: right; border: 1px solid;'>sklearn</td>
        <td style='text-align: left; border: 1px solid;'>1.3.2</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>matplotlib</td>
        <td style='text-align: left; border: 1px solid;'>3.7.3</td>
        <td style='text-align: right; border: 1px solid;'>empymod</td>
        <td style='text-align: left; border: 1px solid;'>2.2.2</td>
        <td style='text-align: right; border: 1px solid;'>geoana</td>
        <td style='text-align: left; border: 1px solid;'>0.6.0</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>pandas</td>
        <td style='text-align: left; border: 1px solid;'>2.0.3</td>
        <td style='text-align: right; border: 1px solid;'>pydiso</td>
        <td style='text-align: left; border: 1px solid;'>0.0.5</td>
        <td style='text-align: right; border: 1px solid;'>numba</td>
        <td style='text-align: left; border: 1px solid;'>0.58.1</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>dask</td>
        <td style='text-align: left; border: 1px solid;'>2023.5.0</td>
        <td style='text-align: right; border: 1px solid;'>sympy</td>
        <td style='text-align: left; border: 1px solid;'>1.12</td>
        <td style='text-align: right; border: 1px solid;'>IPython</td>
        <td style='text-align: left; border: 1px solid;'>8.12.2</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>ipywidgets</td>
        <td style='text-align: left; border: 1px solid;'>8.1.2</td>
        <td style='text-align: right; border: 1px solid;'>plotly</td>
        <td style='text-align: left; border: 1px solid;'>5.19.0</td>
        <td style='text-align: right; border: 1px solid;'>vtk</td>
        <td style='text-align: left; border: 1px solid;'>9.2.6</td>
      </tr>
      <tr>
        <td style='text-align: right; border: 1px solid;'>memory_profiler</td>
        <td style='text-align: left; border: 1px solid;'>0.61.0</td>
        <td style='text-align: right; border: 1px solid;'>choclo</td>
        <td style='text-align: left; border: 1px solid;'>0.2.0</td>
        <td style= border: 1px solid;'></td>
        <td style= border: 1px solid;'></td>
      </tr>
    </table>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 87-97

Moving Forward
--------------

If you have suggestions for improving this example, please create a `pull request on the example in SimPEG <https://github.com/simpeg/simpeg/blob/main/examples/06-dc/read_plot_DC_data_with_IO_class.py>`_

You might try:
   - changing the contour levels
   - try with you own dataset
   - create a mask for negative apparent resistivities
   - ...


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 2.379 seconds)

**Estimated memory usage:**  9 MB


.. _sphx_glr_download_content_examples_04-dcip_plot_read_DC_data_with_IO_class.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_read_DC_data_with_IO_class.ipynb <plot_read_DC_data_with_IO_class.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_read_DC_data_with_IO_class.py <plot_read_DC_data_with_IO_class.py>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_