__init__.py 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. """
  2. ==================================
  3. Input and output (:mod:`scipy.io`)
  4. ==================================
  5. .. currentmodule:: scipy.io
  6. .. toctree::
  7. :hidden:
  8. io.matlab
  9. SciPy has many modules, classes, and functions available to read data
  10. from and write data to a variety of file formats.
  11. .. seealso:: `NumPy IO routines <https://www.numpy.org/devdocs/reference/routines.io.html>`__
  12. MATLAB® files
  13. =============
  14. .. autosummary::
  15. :toctree: generated/
  16. loadmat - Read a MATLAB style mat file (version 4 through 7.1)
  17. savemat - Write a MATLAB style mat file (version 4 through 7.1)
  18. whosmat - List contents of a MATLAB style mat file (version 4 through 7.1)
  19. For low-level MATLAB reading and writing utilities, see `scipy.io.matlab`.
  20. IDL® files
  21. ==========
  22. .. autosummary::
  23. :toctree: generated/
  24. readsav - Read an IDL 'save' file
  25. Matrix Market files
  26. ===================
  27. .. autosummary::
  28. :toctree: generated/
  29. mminfo - Query matrix info from Matrix Market formatted file
  30. mmread - Read matrix from Matrix Market formatted file
  31. mmwrite - Write matrix to Matrix Market formatted file
  32. Unformatted Fortran files
  33. ===============================
  34. .. autosummary::
  35. :toctree: generated/
  36. FortranFile - A file object for unformatted sequential Fortran files
  37. FortranEOFError - Exception indicating the end of a well-formed file
  38. FortranFormattingError - Exception indicating an inappropriate end
  39. Netcdf
  40. ======
  41. .. autosummary::
  42. :toctree: generated/
  43. netcdf_file - A file object for NetCDF data
  44. netcdf_variable - A data object for the netcdf module
  45. Harwell-Boeing files
  46. ====================
  47. .. autosummary::
  48. :toctree: generated/
  49. hb_read -- read H-B file
  50. hb_write -- write H-B file
  51. Wav sound files (:mod:`scipy.io.wavfile`)
  52. =========================================
  53. .. module:: scipy.io.wavfile
  54. .. autosummary::
  55. :toctree: generated/
  56. read
  57. write
  58. WavFileWarning
  59. Arff files (:mod:`scipy.io.arff`)
  60. =================================
  61. .. module:: scipy.io.arff
  62. .. autosummary::
  63. :toctree: generated/
  64. loadarff
  65. MetaData
  66. ArffError
  67. ParseArffError
  68. """
  69. # matfile read and write
  70. from .matlab import loadmat, savemat, whosmat
  71. # netCDF file support
  72. from ._netcdf import netcdf_file, netcdf_variable
  73. # Fortran file support
  74. from ._fortran import FortranFile, FortranEOFError, FortranFormattingError
  75. from ._fast_matrix_market import mminfo, mmread, mmwrite
  76. from ._idl import readsav
  77. from ._harwell_boeing import hb_read, hb_write
  78. # Deprecated namespaces, to be removed in v2.0.0
  79. from . import arff, harwell_boeing, idl, mmio, netcdf, wavfile
  80. __all__ = [s for s in dir() if not s.startswith('_')]
  81. from scipy._lib._testutils import PytestTester
  82. test = PytestTester(__name__)
  83. del PytestTester