QEFolder.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 4. ¿Qué contiene la carpeta instalada de QE-6.3?\n",
    "\n",
    "Al instalar QE se crea una carpeta , *e.g.* \"qe-6.3\", en donde se almacena toda la información  del programa: \"file sources\", documentación, herramientas y otros programas. A continuación se presenta una lista de la mayoría de los elementos que aparecen en dicha carpeta, con una brevísima descripción de los mismos, los elementos que utilizaremos para ejemplificar el uso de QE se marcan en **negritas**:\n",
    "\n",
    "\n",
    "<img src=\"./Figs/FolderQE.png\" style=\"width: 300px\" alt=\"screenshot\" title=\"Carpeta de qe\" />\n",
    "**Figura.** Impresión de pantalla de los contenidos de qe.\n",
    "\n",
    "* XSPECTRA: Código para \"X-ray spectra calculation\".\n",
    "* test-suite: Contiene una serie de ejecutables para pruebas de cálculos o *benchmarks*, con una descripción de lo que se prueba. \n",
    "* S3DE: \"A suite of scripts used to manage an environment suitable for code development. Automatic Makefile generation, versions, portability among different systems and library loading are some of the main tasks of the DE\".\n",
    "* QHA: Código \"Quasi-Harmonic Approximation\". Calcula fonones y proyecciones de las DOS fonónicas.\n",
    "* PWCOND: Calcula estructura de bandas compleja, kpoints complejos, potenciales autoconsistentes, transmitancia, etc.\n",
    "* **PW: \"Plane-Wave Self-Consistent Field\", contiene un \"overview\", ejemplos, documentación, código y herramientas (\"A collection of simple tools for specific tasks\", e.g. \"pwi2xsf.sh, pwo2xsf.sh : convert a pw.x input or output to the xcrysden format\").**\n",
    "* **PP:\"PostProc\", \"an open-source package for postprocessing of data produced by \\PWscf\\ and \\CP.\" E.g.: \"The main postprocessing code \\texttt{pp.x} extracts the specified data from the data files produced by \\PWscf\\ (\\pwx\\ executable) or \\CP\\ (\\cpx\\ executable); prepares data for plotting by writing them into formats that can be read by several plotting programs.\"**\n",
    "* PlotPhon: Programa para graficar densidad de estados de fonones. \n",
    "* PHonon: información y código necesario para realizar cálculos de fonones o de fonones en el punto gamma. \n",
    "* NEB: \"open-source package for the calculation of energy barriers  and reaction pathway using the Nudged Elastic Band (NEB) method\"\n",
    "* License: información y licencia del programa.\n",
    "* KS_Solvers: Rutinas que resuelven la ecuación de \"Kohn Sham\".\n",
    "* GWW: GW quasi-particle calculations, use of the \"Bethe–Salpeter equation\" for two body particles quantum fields theoretical calcs. \n",
    "* GUI: Stands for \"Graphical-user-interfaces\". The folder contains:\n",
    "    *(1) [PWgui](http://www-k3.ijs.si/kokalj/pwgui/pwgui.html): a Graphical-User-Interface for PWscf, [CompMatSci2003](https://www.sciencedirect.com/science/article/pii/S0927025603001046), [PDF](Docs/Kokalj_Computer_graphics_and_graphical_user_interfaces_as_tools_in_simulations_of_matter_at_the_atomic_scale_CompuMaterSci_2003.pdf)\n",
    "    *(2) QE-modes package: a collection of Emacs major-modes for Quantum ESPRESSO input files.\"\n",
    "* EPW:\" \"Electron-phonon Wannier\". EPW is an open-source F90/MPI code which calculates properties related to the electron-phonon interaction using [Density-Functional Perturbation Theory](/Docs/DFPT-DalCorso-Shanghai_2008.pdf) and Maximally Localized Wannier Functions\".[EPW](http://epw.org.uk/)\n",
    "* environment_variables: Contiene las variables ambientales del sistema, e.g. \"BIN_DIR = path of compiled executables. Usually this is \\$PREFIX/bin, where \\$PREFIX is the root of the Quantum ESPRESSO source tree.\"\n",
    "* **Doc: Contiene la documentación general de QE. Entre otros documentos contiene: user-guide.pdf, developer-man.pdf, plumed_quick_ref.pdf y brillouin_zone.pdf.**. Estos documentos pueden ser de utilidad para la instalación o manejo del programa. \n",
    "* dev-tools: Opciones avanzadas para desarrolladores.\n",
    "* CPV: \"Car-Parrinello molecular dynamics code\". Contiene documentación y código de dinámica molecular, incluyendo dinámica de celda variable y cálculo de superficies de energía libre. [P. Giannozzi, O et al. J.Phys.:Condens.Matter 29, 465901 (2017)](https://iopscience.iop.org/article/10.1088/1361-648X/aa8f79)\n",
    "* COUPLE: \"This package allows calling programs of the QE package as subroutines\"\n",
    "* CONTRIBUTING.md: Archivo que explica las modalidades de posibles contribuciones en el código QE.\n",
    "* atomic: Código para cálculos de estructura electrónica y generación de pseudopotenciales. Contiene guías de la teoría de PP, así como para la generación y pruebas de los PPs generados. \n",
    "* archive: Carpeta que contiene los archivos .tar.gz de librerías y archivos necesarios. \n",
    "* include: Archivos de configuración usados y generados durante la configuración, compilación del paquete. \n",
    "* clib: codigo.\n",
    "* FoX: archivos binarios y librerías del código.\n",
    "* UtilXlib: archivod de código.\n",
    "* LAPACK -> lapack-3.6.1: \"a library of Fortran 90 with subroutines for solving the most commonly occurring problems in numerical linear algebra.\" [Lapack](http://www.netlib.org/lapack/)\n",
    "* LAXlib: Carpeta que contiene librerías para de prueba y de cronometraje (\"timing code\"). Pruebas de comunicación entre procesadores, número de procesadores, tareas específicas, etc. \n",
    "* FFTXlib: \"Implements real space grid parallelization of FFT and task groups. \" También contiene archivos para realizar pruebas de evaluación de paralelización. Incluye un \"python script to extract the parameters from an output file of pw.x\".\n",
    "* Modules: Código. \n",
    "* dft-d3: \"Interface routines for Quantum ESPRESSO are contained in file dftd3_qe.f90.This file is released under the GPL.\"\n",
    "* install: Archivos de instalación. \n",
    "* LR_Modules: Archivos de código\n",
    "* upftools: Herramienta automática para generar pseudopotenciales. También tiene herramientas para convertir entre pseudopotenciales para QE y CASINO y viceversa. \n",
    "* TDDFPT: Carpeta con codigo para realizar cálculos \"Time Dependent Density Functional Perturbation Theory (TDDFPT)\"\n",
    "* iotk: redirecciona a subfolder de *S3DE* mencionado arriba. \n",
    "* pseudo: Carpeta a donde se bajan y almacenan los pseudopotenciales.\n",
    "* bin: Carpeta que contiene ejecutables de código y de rutinas de análisis y manejo de postprocesamiento.\n",
    "* tempdir: Aquí se almacenan archivos temporales. Si no se redefine el tempdir al realizar un cálculo, los archivos de las funciones de onda son guardados en esta carpeta. \n",
    "\n",
    "Habiendo proporcionado una idea superficial de la poderosa y versátil herramienta con la que se cuenta, en los siguientes notebooks se demostrará el uso básico de QE con algunos ejemplos de simulaciones, cálculos, convergencia de parámetros, etc.    \n",
    "\n",
    "En el próximo notebook se realiza un ejercicio completo para cálcular la energía total de un sistema, el más sencillo, un átomo de hidrógeno. Se cálculan parámetros de convergencia que son graficados con Python para demostrar el uso de gráficos en Python y visualizar algunos de los resultados. [(Energía, parámetros de convergencia y gráficas de *ecutwvfn* del hidrógeno)](SinglePoint-convergence-plotting.ipynb)\n",
    "\n",
    "[Ir al notebook anterior.](QEInstallation.ipynb)\n"
   ]
  }
 ],
 "metadata": {
  "extensions": {
   "jupyter_dashboards": {
    "activeView": "grid_default",
    "version": 1,
    "views": {
     "grid_default": {
      "cellMargin": 10,
      "defaultCellHeight": 20,
      "maxColumns": 12,
      "name": "grid",
      "type": "grid"
     },
     "report_default": {
      "name": "report",
      "type": "report"
     }
    }
   }
  },
  "hide_input": false,
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.5.3"
  },
  "nbpresent": {
   "slides": {
    "0aa2345a-46cd-4e1a-8beb-97af62703f8c": {
     "id": "0aa2345a-46cd-4e1a-8beb-97af62703f8c",
     "prev": "6a1e62f6-8d6f-4210-b3e0-59fb1ef6a2da",
     "regions": {
      "2715b07a-f9db-4897-9442-412653799195": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "1434ea8c-23c5-4696-9948-9f4f5c0747c9",
        "part": "whole"
       },
       "id": "2715b07a-f9db-4897-9442-412653799195"
      }
     }
    },
    "18513ca0-f52c-4fcb-93fe-4f9bb816ea85": {
     "id": "18513ca0-f52c-4fcb-93fe-4f9bb816ea85",
     "prev": "bac2d47d-0f9e-4458-bda3-813682d0dfb6",
     "regions": {
      "70eb626d-a89d-424e-998c-a7ffc4b6e226": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "fa21c92e-d69f-4ad0-9ce2-853f11d55eb1",
        "part": "whole"
       },
       "id": "70eb626d-a89d-424e-998c-a7ffc4b6e226"
      }
     }
    },
    "252b7fa7-81b3-4e1a-aec8-1ed9e68ef546": {
     "id": "252b7fa7-81b3-4e1a-aec8-1ed9e68ef546",
     "prev": "ab4e6901-d3f3-4d5c-8044-6af4063ae1cb",
     "regions": {
      "5adc70ac-d550-4cc6-a030-4bb4e3713f4a": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "12bc68b5-ff64-4f5f-a28a-cffb0149cc97",
        "part": "whole"
       },
       "id": "5adc70ac-d550-4cc6-a030-4bb4e3713f4a"
      }
     }
    },
    "263d58ed-b8a5-4018-8b93-7d5f8179b2ac": {
     "id": "263d58ed-b8a5-4018-8b93-7d5f8179b2ac",
     "prev": "7920af9f-921e-4a4d-a2a5-0ba10a181a0f",
     "regions": {
      "96879449-8ace-4f85-ad17-c5aead471581": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "1b199828-1e4d-4aaf-b837-57127d66af8e",
        "part": "whole"
       },
       "id": "96879449-8ace-4f85-ad17-c5aead471581"
      }
     }
    },
    "33cbc714-2904-4545-bb31-3c5d76920bc2": {
     "id": "33cbc714-2904-4545-bb31-3c5d76920bc2",
     "prev": "9cd7ad2b-10e2-4189-92b4-d8c9ea5cd237",
     "regions": {
      "ef6d9f0f-54ca-4fe4-9cd5-099067553213": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "a8e7892e-e137-424f-ba0a-e39ec1817e92",
        "part": "whole"
       },
       "id": "ef6d9f0f-54ca-4fe4-9cd5-099067553213"
      }
     }
    },
    "42b0e211-c07f-465b-9f02-60fd66835840": {
     "id": "42b0e211-c07f-465b-9f02-60fd66835840",
     "prev": "79700dbd-98e9-47a2-abbd-ffd86b065dde",
     "regions": {
      "daef21ba-dc32-4bc6-8e78-bd4c3fa690e3": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "febba9e0-08a8-4653-bfc8-db4b7b510b88",
        "part": "whole"
       },
       "id": "daef21ba-dc32-4bc6-8e78-bd4c3fa690e3"
      }
     }
    },
    "4fd769dd-3dc7-4905-b385-ac26f050cf3b": {
     "id": "4fd769dd-3dc7-4905-b385-ac26f050cf3b",
     "prev": "a17a48d3-63de-407c-aff5-df311ade3012",
     "regions": {
      "cf8b87b1-ed9e-434e-bd8d-fd00e2e15331": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "8862c192-da26-45fd-93fe-fcde77fbecfb",
        "part": "whole"
       },
       "id": "cf8b87b1-ed9e-434e-bd8d-fd00e2e15331"
      }
     }
    },
    "598e4d8b-455e-4a66-a691-f1a9547e7502": {
     "id": "598e4d8b-455e-4a66-a691-f1a9547e7502",
     "prev": "dcd2748d-3089-4679-81ef-3fb5c323875e",
     "regions": {
      "280a64e2-7754-43c4-aaf7-eb3199410595": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "b9ddf778-f2b3-4be1-91cb-7c28d3e9f7bb",
        "part": "whole"
       },
       "id": "280a64e2-7754-43c4-aaf7-eb3199410595"
      }
     }
    },
    "6a1e62f6-8d6f-4210-b3e0-59fb1ef6a2da": {
     "id": "6a1e62f6-8d6f-4210-b3e0-59fb1ef6a2da",
     "prev": "42b0e211-c07f-465b-9f02-60fd66835840",
     "regions": {
      "1fcf03cb-87e1-4a6e-b784-70836bc23af8": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "c9f12f8b-1c84-4f02-95df-7c82b7ee3228",
        "part": "whole"
       },
       "id": "1fcf03cb-87e1-4a6e-b784-70836bc23af8"
      }
     }
    },
    "7920af9f-921e-4a4d-a2a5-0ba10a181a0f": {
     "id": "7920af9f-921e-4a4d-a2a5-0ba10a181a0f",
     "prev": null,
     "regions": {
      "02bf57c5-6e10-4b2e-9cb6-6c6de4fc95d2": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "a33a1be1-c8d1-4eca-b4c5-dab812c52550",
        "part": "whole"
       },
       "id": "02bf57c5-6e10-4b2e-9cb6-6c6de4fc95d2"
      }
     },
     "theme": null
    },
    "79700dbd-98e9-47a2-abbd-ffd86b065dde": {
     "id": "79700dbd-98e9-47a2-abbd-ffd86b065dde",
     "prev": "263d58ed-b8a5-4018-8b93-7d5f8179b2ac",
     "regions": {
      "8e700ae6-736f-4af2-a462-dbdf4aaebd6f": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "91dd76d3-98df-4a43-914d-d377792b7a39",
        "part": "whole"
       },
       "id": "8e700ae6-736f-4af2-a462-dbdf4aaebd6f"
      }
     }
    },
    "9cd7ad2b-10e2-4189-92b4-d8c9ea5cd237": {
     "id": "9cd7ad2b-10e2-4189-92b4-d8c9ea5cd237",
     "prev": "b12659ea-c9df-420e-94f0-a1fb140352db",
     "regions": {
      "28951877-15cf-4e49-b19f-f8cc33e237ae": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "cfa95e8a-48b4-426d-a270-f8bedc8c1dc5",
        "part": "whole"
       },
       "id": "28951877-15cf-4e49-b19f-f8cc33e237ae"
      }
     }
    },
    "a17a48d3-63de-407c-aff5-df311ade3012": {
     "id": "a17a48d3-63de-407c-aff5-df311ade3012",
     "prev": "33cbc714-2904-4545-bb31-3c5d76920bc2",
     "regions": {
      "1af095c2-d430-4dff-8c12-fa0aa834ba34": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "32d16d88-2720-43ad-8c59-e123919dc44b",
        "part": "whole"
       },
       "id": "1af095c2-d430-4dff-8c12-fa0aa834ba34"
      }
     }
    },
    "a7f54400-91c5-4c26-acc9-1dd235018a01": {
     "id": "a7f54400-91c5-4c26-acc9-1dd235018a01",
     "prev": "252b7fa7-81b3-4e1a-aec8-1ed9e68ef546",
     "regions": {
      "9bd607b2-b218-492d-82e8-7e3273b35451": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "6acf2383-edc6-4ef3-a8b4-c112fda69af1",
        "part": "whole"
       },
       "id": "9bd607b2-b218-492d-82e8-7e3273b35451"
      }
     }
    },
    "ab4e6901-d3f3-4d5c-8044-6af4063ae1cb": {
     "id": "ab4e6901-d3f3-4d5c-8044-6af4063ae1cb",
     "prev": "4fd769dd-3dc7-4905-b385-ac26f050cf3b",
     "regions": {
      "4a50d2c3-717f-45b3-ba88-a5036e8463df": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "f4c0fed4-90b6-4645-b10b-49851900c7f8",
        "part": "whole"
       },
       "id": "4a50d2c3-717f-45b3-ba88-a5036e8463df"
      }
     }
    },
    "b12659ea-c9df-420e-94f0-a1fb140352db": {
     "id": "b12659ea-c9df-420e-94f0-a1fb140352db",
     "prev": "18513ca0-f52c-4fcb-93fe-4f9bb816ea85",
     "regions": {
      "d174f353-bcf3-46e5-bd8a-b7011eb562bc": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "924fbfec-5c04-4f5b-89e2-a6162fafaa05",
        "part": "whole"
       },
       "id": "d174f353-bcf3-46e5-bd8a-b7011eb562bc"
      }
     }
    },
    "bac2d47d-0f9e-4458-bda3-813682d0dfb6": {
     "id": "bac2d47d-0f9e-4458-bda3-813682d0dfb6",
     "prev": "0aa2345a-46cd-4e1a-8beb-97af62703f8c",
     "regions": {
      "e62de9dc-56e7-47ae-a0a2-d1de20047863": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "6cd3f4b6-92c2-4746-b1fd-75760f192c25",
        "part": "whole"
       },
       "id": "e62de9dc-56e7-47ae-a0a2-d1de20047863"
      }
     }
    },
    "dcd2748d-3089-4679-81ef-3fb5c323875e": {
     "id": "dcd2748d-3089-4679-81ef-3fb5c323875e",
     "prev": "f4b4b992-12c6-4624-aa15-7312aee75aa8",
     "regions": {
      "56ae914f-619d-4f82-8615-de46596669c5": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "37fd9aa6-54ae-4281-a9e3-471695e75549",
        "part": "whole"
       },
       "id": "56ae914f-619d-4f82-8615-de46596669c5"
      }
     }
    },
    "f4b4b992-12c6-4624-aa15-7312aee75aa8": {
     "id": "f4b4b992-12c6-4624-aa15-7312aee75aa8",
     "prev": "a7f54400-91c5-4c26-acc9-1dd235018a01",
     "regions": {
      "22afa098-15a0-4003-aae9-bc8ea306733a": {
       "attrs": {
        "height": 0.8,
        "width": 0.8,
        "x": 0.1,
        "y": 0.1
       },
       "content": {
        "cell": "7c3abc69-ec63-4afd-a1e0-55dbe964caa6",
        "part": "whole"
       },
       "id": "22afa098-15a0-4003-aae9-bc8ea306733a"
      }
     }
    }
   },
   "themes": {
    "default": "d3647b69-0294-47a2-ac90-4302a6c7efcd",
    "theme": {}
   }
  },
  "toc": {
   "base_numbering": 1,
   "nav_menu": {},
   "number_sections": true,
   "sideBar": true,
   "skip_h1_title": false,
   "title_cell": "Table of Contents",
   "title_sidebar": "Contents",
   "toc_cell": false,
   "toc_position": {},
   "toc_section_display": true,
   "toc_window_display": false
  },
  "varInspector": {
   "cols": {
    "lenName": 16,
    "lenType": 16,
    "lenVar": 40
   },
   "kernels_config": {
    "python": {
     "delete_cmd_postfix": "",
     "delete_cmd_prefix": "del ",
     "library": "var_list.py",
     "varRefreshCmd": "print(var_dic_list())"
    },
    "r": {
     "delete_cmd_postfix": ") ",
     "delete_cmd_prefix": "rm(",
     "library": "var_list.r",
     "varRefreshCmd": "cat(var_dic_list()) "
    }
   },
   "types_to_exclude": [
    "module",
    "function",
    "builtin_function_or_method",
    "instance",
    "_Feature"
   ],
   "window_display": false
  }
 },
 "nbformat": 4,
 "nbformat_minor": 1
}