CoreMS 2.2.1__tar.gz → 3.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. {CoreMS-2.2.1 → CoreMS-3.0.1}/CoreMS.egg-info/PKG-INFO +31 -19
  2. {CoreMS-2.2.1 → CoreMS-3.0.1}/CoreMS.egg-info/SOURCES.txt +13 -16
  3. {CoreMS-2.2.1 → CoreMS-3.0.1}/CoreMS.egg-info/requires.txt +4 -0
  4. {CoreMS-2.2.1 → CoreMS-3.0.1}/PKG-INFO +31 -19
  5. {CoreMS-2.2.1 → CoreMS-3.0.1}/README.md +30 -18
  6. CoreMS-3.0.1/corems/__init__.py +60 -0
  7. CoreMS-3.0.1/corems/chroma_peak/calc/ChromaPeakCalc.py +260 -0
  8. CoreMS-3.0.1/corems/chroma_peak/factory/chroma_peak_classes.py +826 -0
  9. CoreMS-3.0.1/corems/encapsulation/constant.py +1283 -0
  10. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/encapsulation/factory/parameters.py +161 -39
  11. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/encapsulation/factory/processingSetting.py +312 -202
  12. CoreMS-3.0.1/corems/encapsulation/input/parameter_from_json.py +499 -0
  13. CoreMS-3.0.1/corems/encapsulation/output/parameter_to_dict.py +113 -0
  14. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/encapsulation/output/parameter_to_json.py +150 -42
  15. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/calc/GC_Calc.py +35 -29
  16. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/calc/GC_Deconvolution.py +226 -140
  17. CoreMS-3.0.1/corems/mass_spectra/calc/GC_RI_Calibration.py +44 -0
  18. CoreMS-3.0.1/corems/mass_spectra/calc/LC_Calc.py +1422 -0
  19. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/calc/MZSearch.py +77 -87
  20. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/calc/SignalProcessing.py +199 -147
  21. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/factory/GC_Class.py +161 -100
  22. CoreMS-3.0.1/corems/mass_spectra/factory/LC_Class.py +1118 -0
  23. CoreMS-3.0.1/corems/mass_spectra/factory/chromat_data.py +51 -0
  24. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/input/andiNetCDF.py +5 -6
  25. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/input/boosterHDF5.py +2 -2
  26. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/input/brukerSolarix.py +1 -2
  27. CoreMS-3.0.1/corems/mass_spectra/input/corems_hdf5.py +530 -0
  28. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/input/massList.py +7 -20
  29. CoreMS-3.0.1/corems/mass_spectra/input/mzml.py +471 -0
  30. CoreMS-3.0.1/corems/mass_spectra/input/parserbase.py +66 -0
  31. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectra/input/rawFileReader.py +413 -208
  32. CoreMS-3.0.1/corems/mass_spectra/output/export.py +1785 -0
  33. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/AutoRecalibration.py +87 -72
  34. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/Calibration.py +245 -157
  35. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/CalibrationCalc.py +91 -81
  36. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/KendrickGroup.py +79 -76
  37. CoreMS-3.0.1/corems/mass_spectrum/calc/MassErrorPrediction.py +436 -0
  38. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/MassSpectrumCalc.py +84 -71
  39. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/MeanResolvingPowerFilter.py +75 -66
  40. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/NoiseCalc.py +131 -118
  41. CoreMS-3.0.1/corems/mass_spectrum/calc/NoiseCalc_Bayes.py +93 -0
  42. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/calc/PeakPicking.py +385 -272
  43. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/factory/MassSpectrumClasses.py +393 -287
  44. CoreMS-3.0.1/corems/mass_spectrum/input/baseClass.py +524 -0
  45. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/input/boosterHDF5.py +21 -25
  46. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/input/coremsHDF5.py +66 -33
  47. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/input/massList.py +135 -72
  48. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/mass_spectrum/input/numpyArray.py +47 -22
  49. CoreMS-3.0.1/corems/mass_spectrum/output/export.py +823 -0
  50. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_formula/calc/MolecularFormulaCalc.py +420 -264
  51. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_formula/factory/MolecularFormulaFactory.py +394 -263
  52. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_formula/input/masslist_ref.py +138 -144
  53. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/calc/ClusterFilter.py +103 -104
  54. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/calc/MolecularFilter.py +48 -48
  55. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/calc/SpectralSimilarity.py +100 -88
  56. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/calc/math_distance.py +181 -131
  57. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/factory/EI_SQL.py +168 -130
  58. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/factory/MolecularLookupTable.py +407 -392
  59. CoreMS-3.0.1/corems/molecular_id/factory/classification.py +803 -0
  60. CoreMS-3.0.1/corems/molecular_id/factory/lipid_molecular_metadata.py +45 -0
  61. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/factory/molecularSQL.py +313 -253
  62. CoreMS-3.0.1/corems/molecular_id/factory/spectrum_search_results.py +116 -0
  63. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/input/nistMSI.py +32 -46
  64. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/search/compoundSearch.py +89 -53
  65. CoreMS-3.0.1/corems/molecular_id/search/database_interfaces.py +837 -0
  66. CoreMS-3.0.1/corems/molecular_id/search/findOxygenPeaks.py +330 -0
  67. CoreMS-3.0.1/corems/molecular_id/search/lcms_spectral_search.py +310 -0
  68. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/search/molecularFormulaSearch.py +367 -216
  69. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/molecular_id/search/priorityAssignment.py +319 -250
  70. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/ms_peak/calc/MSPeakCalc.py +361 -239
  71. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/ms_peak/factory/MSPeakClasses.py +59 -55
  72. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/transient/calc/TransientCalc.py +146 -132
  73. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/transient/factory/TransientClasses.py +77 -76
  74. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/transient/input/brukerSolarix.py +93 -109
  75. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/transient/input/midasDatFile.py +52 -55
  76. {CoreMS-2.2.1 → CoreMS-3.0.1}/requirements.txt +4 -0
  77. {CoreMS-2.2.1 → CoreMS-3.0.1}/setup.py +1 -1
  78. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_calibration.py +1 -1
  79. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_classification.py +1 -1
  80. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_input.py +2 -2
  81. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_mass_spectrum_export_import.py +1 -1
  82. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_molecular_formula_search.py +14 -15
  83. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_mspeak.py +0 -2
  84. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_search_mass_list.py +1 -1
  85. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_setting_settings.py +1 -1
  86. CoreMS-3.0.1/tests/test_wf_lipidomics.py +269 -0
  87. CoreMS-2.2.1/corems/__init__.py +0 -376
  88. CoreMS-2.2.1/corems/chroma_peak/calc/ChromaPeakCalc.py +0 -96
  89. CoreMS-2.2.1/corems/chroma_peak/factory/ChromaPeakClasses.py +0 -361
  90. CoreMS-2.2.1/corems/collection/__init__.py +0 -1
  91. CoreMS-2.2.1/corems/encapsulation/constant.py +0 -1007
  92. CoreMS-2.2.1/corems/encapsulation/input/parameter_from_json.py +0 -339
  93. CoreMS-2.2.1/corems/encapsulation/output/parameter_to_dict.py +0 -63
  94. CoreMS-2.2.1/corems/mass_spectra/calc/GC_RI_Calibration.py +0 -36
  95. CoreMS-2.2.1/corems/mass_spectra/calc/LC_Calc.py +0 -100
  96. CoreMS-2.2.1/corems/mass_spectra/calc/LF_Targeted.py +0 -163
  97. CoreMS-2.2.1/corems/mass_spectra/factory/LC_Class.py +0 -555
  98. CoreMS-2.2.1/corems/mass_spectra/factory/LC_Temp.py +0 -43
  99. CoreMS-2.2.1/corems/mass_spectra/input/coremsHDF5.py +0 -89
  100. CoreMS-2.2.1/corems/mass_spectra/output/export.py +0 -858
  101. CoreMS-2.2.1/corems/mass_spectrum/calc/MassErrorPrediction.py +0 -377
  102. CoreMS-2.2.1/corems/mass_spectrum/calc/NoiseCalc_Bayes.py +0 -91
  103. CoreMS-2.2.1/corems/mass_spectrum/input/baseClass.py +0 -475
  104. CoreMS-2.2.1/corems/mass_spectrum/output/export.py +0 -670
  105. CoreMS-2.2.1/corems/molecular_id/calc/KendrickGroup.py +0 -0
  106. CoreMS-2.2.1/corems/molecular_id/factory/classification.py +0 -694
  107. CoreMS-2.2.1/corems/molecular_id/search/findOxygenPeaks.py +0 -287
  108. CoreMS-2.2.1/corems/transient/__init__.py +0 -0
  109. CoreMS-2.2.1/corems/transient/calc/__init__.py +0 -0
  110. CoreMS-2.2.1/corems/transient/factory/__init__.py +0 -0
  111. CoreMS-2.2.1/corems/transient/input/__init__.py +0 -0
  112. CoreMS-2.2.1/ext_lib/__init__.py +0 -0
  113. CoreMS-2.2.1/tests/test_LossFinder.py +0 -91
  114. CoreMS-2.2.1/tests/test_assembly_identification.py +0 -480
  115. CoreMS-2.2.1/tests/test_massErrorPrediction.py +0 -21
  116. CoreMS-2.2.1/tests/test_mz_search.py +0 -22
  117. {CoreMS-2.2.1 → CoreMS-3.0.1}/CoreMS.egg-info/dependency_links.txt +0 -0
  118. {CoreMS-2.2.1 → CoreMS-3.0.1}/CoreMS.egg-info/top_level.txt +0 -0
  119. {CoreMS-2.2.1 → CoreMS-3.0.1}/Dockerfile +0 -0
  120. {CoreMS-2.2.1 → CoreMS-3.0.1}/LICENSE +0 -0
  121. {CoreMS-2.2.1 → CoreMS-3.0.1}/MANIFEST.in +0 -0
  122. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/chroma_peak/__init__.py +0 -0
  123. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/chroma_peak/calc/__init__.py +0 -0
  124. {CoreMS-2.2.1 → CoreMS-3.0.1}/corems/chroma_peak/factory/__init__.py +0 -0
  125. {CoreMS-2.2.1/corems/collection/factory → CoreMS-3.0.1/corems/encapsulation}/__init__.py +0 -0
  126. {CoreMS-2.2.1/corems/collection/input → CoreMS-3.0.1/corems/encapsulation/factory}/__init__.py +0 -0
  127. {CoreMS-2.2.1/corems/collection/output → CoreMS-3.0.1/corems/encapsulation/input}/__init__.py +0 -0
  128. {CoreMS-2.2.1/corems/encapsulation → CoreMS-3.0.1/corems/encapsulation/output}/__init__.py +0 -0
  129. {CoreMS-2.2.1/corems/encapsulation/factory → CoreMS-3.0.1/corems/mass_spectra}/__init__.py +0 -0
  130. {CoreMS-2.2.1/corems/encapsulation/input → CoreMS-3.0.1/corems/mass_spectra/calc}/__init__.py +0 -0
  131. {CoreMS-2.2.1/corems/encapsulation/output → CoreMS-3.0.1/corems/mass_spectra/factory}/__init__.py +0 -0
  132. {CoreMS-2.2.1/corems/mass_spectra → CoreMS-3.0.1/corems/mass_spectra/input}/__init__.py +0 -0
  133. {CoreMS-2.2.1/corems/mass_spectra/calc → CoreMS-3.0.1/corems/mass_spectra/output}/__init__.py +0 -0
  134. {CoreMS-2.2.1/corems/mass_spectra/factory → CoreMS-3.0.1/corems/mass_spectrum}/__init__.py +0 -0
  135. {CoreMS-2.2.1/corems/mass_spectra/input → CoreMS-3.0.1/corems/mass_spectrum/calc}/__init__.py +0 -0
  136. {CoreMS-2.2.1/corems/mass_spectra/input/win_only → CoreMS-3.0.1/corems/mass_spectrum/factory}/__init__.py +0 -0
  137. {CoreMS-2.2.1/corems/mass_spectra/output → CoreMS-3.0.1/corems/mass_spectrum/input}/__init__.py +0 -0
  138. {CoreMS-2.2.1/corems/mass_spectrum → CoreMS-3.0.1/corems/mass_spectrum/output}/__init__.py +0 -0
  139. {CoreMS-2.2.1/corems/mass_spectrum/calc → CoreMS-3.0.1/corems/molecular_formula}/__init__.py +0 -0
  140. {CoreMS-2.2.1/corems/mass_spectrum/factory → CoreMS-3.0.1/corems/molecular_formula/calc}/__init__.py +0 -0
  141. {CoreMS-2.2.1/corems/mass_spectrum/input → CoreMS-3.0.1/corems/molecular_formula/factory}/__init__.py +0 -0
  142. {CoreMS-2.2.1/corems/mass_spectrum/input/win_only → CoreMS-3.0.1/corems/molecular_formula/input}/__init__.py +0 -0
  143. {CoreMS-2.2.1/corems/mass_spectrum/output → CoreMS-3.0.1/corems/molecular_id}/__init__.py +0 -0
  144. {CoreMS-2.2.1/corems/molecular_formula → CoreMS-3.0.1/corems/molecular_id/calc}/__init__.py +0 -0
  145. {CoreMS-2.2.1/corems/molecular_formula/calc → CoreMS-3.0.1/corems/molecular_id/factory}/__init__.py +0 -0
  146. {CoreMS-2.2.1/corems/molecular_formula/factory → CoreMS-3.0.1/corems/molecular_id/input}/__init__.py +0 -0
  147. {CoreMS-2.2.1/corems/molecular_formula/input → CoreMS-3.0.1/corems/molecular_id/search}/__init__.py +0 -0
  148. {CoreMS-2.2.1/corems/molecular_id → CoreMS-3.0.1/corems/ms_peak}/__init__.py +0 -0
  149. {CoreMS-2.2.1/corems/molecular_id → CoreMS-3.0.1/corems/ms_peak}/calc/__init__.py +0 -0
  150. {CoreMS-2.2.1/corems/molecular_id → CoreMS-3.0.1/corems/ms_peak}/factory/__init__.py +0 -0
  151. {CoreMS-2.2.1/corems/molecular_id/input → CoreMS-3.0.1/corems/transient}/__init__.py +0 -0
  152. {CoreMS-2.2.1/corems/molecular_id/search → CoreMS-3.0.1/corems/transient/calc}/__init__.py +0 -0
  153. {CoreMS-2.2.1/corems/ms_peak → CoreMS-3.0.1/corems/transient/factory}/__init__.py +0 -0
  154. {CoreMS-2.2.1/corems/ms_peak/calc → CoreMS-3.0.1/corems/transient/input}/__init__.py +0 -0
  155. {CoreMS-2.2.1 → CoreMS-3.0.1}/disclaimer.txt +0 -0
  156. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ChemstationMSFileReader.dll +0 -0
  157. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ChemstationMSFileReader.xml +0 -0
  158. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/RawFileReaderLicense.doc +0 -0
  159. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.BackgroundSubtraction.dll +0 -0
  160. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.BackgroundSubtraction.xml +0 -0
  161. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.Data.dll +0 -0
  162. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.Data.xml +0 -0
  163. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.MassPrecisionEstimator.dll +0 -0
  164. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.MassPrecisionEstimator.xml +0 -0
  165. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.RawFileReader.dll +0 -0
  166. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/ThermoFisher.CommonCore.RawFileReader.xml +0 -0
  167. {CoreMS-2.2.1/corems/ms_peak/factory → CoreMS-3.0.1/ext_lib}/__init__.py +0 -0
  168. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/OpenMcdf.Extensions.dll +0 -0
  169. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/OpenMcdf.dll +0 -0
  170. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/OpenMcdf.xml +0 -0
  171. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/System.IO.FileSystem.AccessControl.dll +0 -0
  172. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/System.IO.FileSystem.AccessControl.xml +0 -0
  173. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/System.Security.AccessControl.dll +0 -0
  174. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/System.Security.AccessControl.xml +0 -0
  175. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/System.Security.Principal.Windows.dll +0 -0
  176. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/System.Security.Principal.Windows.xml +0 -0
  177. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.BackgroundSubtraction.dll +0 -0
  178. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.BackgroundSubtraction.xml +0 -0
  179. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.Data.dll +0 -0
  180. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.Data.xml +0 -0
  181. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.MassPrecisionEstimator.dll +0 -0
  182. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.MassPrecisionEstimator.xml +0 -0
  183. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.RawFileReader.dll +0 -0
  184. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/dotnet/ThermoFisher.CommonCore.RawFileReader.xml +0 -0
  185. {CoreMS-2.2.1 → CoreMS-3.0.1}/ext_lib/version +0 -0
  186. {CoreMS-2.2.1 → CoreMS-3.0.1}/setup.cfg +0 -0
  187. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_gcms.py +0 -0
  188. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_mass_spectrum.py +0 -0
  189. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_molecular_formula.py +0 -0
  190. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_molecular_formula_db_factory.py +0 -0
  191. {CoreMS-2.2.1 → CoreMS-3.0.1}/tests/test_output.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: CoreMS
3
- Version: 2.2.1
3
+ Version: 3.0.1
4
4
  Summary: Mass Spectrometry Framework for Small Molecules Analysis
5
5
  Home-page: https://github.com/EMSL-Computing/CoreMS
6
6
  Author: Corilo, Yuri
@@ -14,13 +14,13 @@ Classifier: Development Status :: 4 - Beta
14
14
  Description-Content-Type: text/markdown
15
15
  License-File: LICENSE
16
16
 
17
- ![CoreMS Logo](docs/CoreMS.COLOR_small.png?raw=true)
17
+ ![CoreMS Logo](https://github.com/EMSL-Computing/CoreMS/blob/master/docs/CoreMS.COLOR_small.png?raw=true)
18
18
 
19
19
  <div align="left">
20
20
 
21
21
  <br>
22
22
  <br>
23
- <a href="https://doi.org/10.5281/zenodo.4641552"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg" alt="CoreMS DOI" style="width:150px"></a>
23
+ <a href="https://doi.org/10.5281/zenodo.14009575"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14009575.svg" alt="DOI"></a>
24
24
  <br>
25
25
  </div>
26
26
 
@@ -29,19 +29,18 @@ License-File: LICENSE
29
29
  - [CoreMS](#CoreMS)
30
30
  - [Current Version](#current-version)
31
31
  - [Contact Information](#main-developers/contact )
32
+ - [Documentation](#documentation)
32
33
  - [Contribution Information](#contributing)
33
34
  - [Data Input](#data-input-formats)
34
35
  - [Data Output](#data-output-formats)
35
36
  - [Data Structure](#data-structure-types)
36
37
  - [Features](#available-features)
37
- - [Overview Slides](examples/CoreMS-Overview.pdf)
38
- - [Framework Documentation](https://emsl-computing.github.io/CoreMS/)
39
38
  - Installation
40
39
  - [Installation](#corems-installation)
41
40
  - [Thermo Raw File on Mac and Linux](#thermo-raw-file-access)
42
41
  - Execution
43
42
  - [Jupyter Notebook and Docker containers](#docker-stack)
44
- - [Simple Example](#simple-script-example)
43
+ - [Example for FT-ICR Data Processing](#simple-script-example)
45
44
  - [Python Examples](examples/scripts)
46
45
  - [Jupyter Notebook Examples](examples/notebooks)
47
46
  - Sibling Projects
@@ -66,13 +65,22 @@ CoreMS aims to provide
66
65
 
67
66
  ## Current Version
68
67
 
69
- `2.2.1`
68
+ `3.0.1`
70
69
 
71
70
  ***
72
71
 
73
72
  ## Main Developers/Contact
74
73
  - [Yuri. E. Corilo](mailto:corilo@pnnl.gov)
75
74
  - [William Kew](mailto:william.kew@pnnl.gov)
75
+ - [Katherine Heal](mailto:katherine.heal@pnnl.gov)
76
+
77
+ ***
78
+
79
+ ## Documentation
80
+
81
+ API documentation can be found [here](https://emsl-computing.github.io/CoreMS/corems.html).
82
+
83
+ Overview slides can be found [here](https://github.com/EMSL-Computing/CoreMS/blob/master/examples/CoreMS-Overview.pdf).
76
84
 
77
85
  ***
78
86
 
@@ -91,11 +99,12 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
91
99
  - Spectroswiss signal booster data-acquisition station (.hdf5)
92
100
  - MagLab ICR data-acquisition station (FT and magnitude mode) (.dat)
93
101
  - ANDI NetCDF for GC-MS (.cdf)
102
+ - mzml for LC-MS (.mzml)
94
103
  - Generic mass list in profile and centroid mde (include all delimiters types and Excel formats)
95
104
  - CoreMS exported processed mass list files(excel, .csv, .txt, pandas dataframe as .pkl)
96
105
  - CoreMS self-containing Hierarchical Data Format (.hdf5)
97
106
  - Pandas Dataframe
98
- - Support for cloud Storage using s3path.S3path(see examples of usage here: [S3 Support](tests/s3_test.py))
107
+ - Support for cloud Storage using s3path.S3path
99
108
 
100
109
  ### Data output formats
101
110
 
@@ -103,7 +112,7 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
103
112
  - Text Files (.csv, tab separated .txt, etc)
104
113
  - Microsoft Excel (xlsx)
105
114
  - Automatic JSON for metadata storage and reuse
106
- - Self-containing Hierarchical Data Format (.hdf5) including raw data and ime-series data-point for processed data-sets with all associated metadata stored as json attributes
115
+ - Self-containing Hierarchical Data Format (.hdf5) including raw data and time-series data-point for processed data-sets with all associated metadata stored as json attributes
107
116
 
108
117
  ### Data structure types
109
118
 
@@ -115,12 +124,6 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
115
124
  - Mass Spectral Peak
116
125
  - Molecular Formula
117
126
 
118
- ### In progress data structures
119
- - IMS-MS
120
- - LC-IMS-MS
121
- - Collections
122
- - Molecular Structure
123
-
124
127
  ***
125
128
 
126
129
  ## Available features
@@ -163,6 +166,15 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
163
166
  - Prediction of mass error distribution
164
167
  - Calculated ICR Resolving Power based on magnetic field (B), and transient time(T)
165
168
 
169
+ ### LC-MS Signal Processing, Molecular Formula Search and Assignment, and Spectral Similarity Searches
170
+ - Two dimensional (m/z and retention time) peak picking using persistent homology
171
+ - Smoothing, cetroid detection, and integration of extracted ion chromatograms
172
+ - Peak shape metric calculations including half peak height, tailing factor, and dispersity index
173
+ - MS1 deconvolution of mass features
174
+ - Idenfitication of <sup>13</sup>C isotopes within the mass features
175
+ - Compatibility with molecular formula searching on MS1 or MS2 spectra
176
+ - Spectral search capability using entropy similarity
177
+
166
178
  ***
167
179
 
168
180
  ## Installation
@@ -255,7 +267,7 @@ If you don't have docker installed, the easiest way is to [install docker for de
255
267
 
256
268
  ***
257
269
 
258
- ## Simple Script Example
270
+ ## Example for FT-ICR Data Processing
259
271
 
260
272
  More examples can be found under the directory examples/scripts, examples/notebooks
261
273
 
@@ -339,11 +351,11 @@ UML (unified modeling language) diagrams for Direct Infusion FT-MS and GC-MS cla
339
351
 
340
352
  If you use CoreMS in your work, please use the following citation:
341
353
 
342
- Version [2.2.1 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.2.1), archived on Zenodo:
354
+ Version [3.0.1 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v3.0.1), archived on Zenodo:
343
355
 
344
- [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg)](https://doi.org/10.5281/zenodo.4641552)
356
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14009575.svg)](https://doi.org/10.5281/zenodo.14009575)
345
357
 
346
- Yuri E. Corilo, William R. Kew, Lee Ann McCue (2021, March 27). EMSL-Computing/CoreMS: CoreMS 2.0.1 (Version v2.0.1), as developed on Github. Zenodo. http://doi.org/10.5281/zenodo.4641552
358
+ Yuri E. Corilo, William R. Kew, Lee Ann McCue, Katherine R . Heal, James C. Carr (2024, October 29). EMSL-Computing/CoreMS: CoreMS 3.0.1 (Version v3.0.1), as developed on Github. Zenodo. http://doi.org/10.5281/zenodo.14009575
347
359
 
348
360
  ```
349
361
 
@@ -14,12 +14,8 @@ corems/__init__.py
14
14
  corems/chroma_peak/__init__.py
15
15
  corems/chroma_peak/calc/ChromaPeakCalc.py
16
16
  corems/chroma_peak/calc/__init__.py
17
- corems/chroma_peak/factory/ChromaPeakClasses.py
18
17
  corems/chroma_peak/factory/__init__.py
19
- corems/collection/__init__.py
20
- corems/collection/factory/__init__.py
21
- corems/collection/input/__init__.py
22
- corems/collection/output/__init__.py
18
+ corems/chroma_peak/factory/chroma_peak_classes.py
23
19
  corems/encapsulation/__init__.py
24
20
  corems/encapsulation/constant.py
25
21
  corems/encapsulation/factory/__init__.py
@@ -35,22 +31,24 @@ corems/mass_spectra/calc/GC_Calc.py
35
31
  corems/mass_spectra/calc/GC_Deconvolution.py
36
32
  corems/mass_spectra/calc/GC_RI_Calibration.py
37
33
  corems/mass_spectra/calc/LC_Calc.py
38
- corems/mass_spectra/calc/LF_Targeted.py
39
34
  corems/mass_spectra/calc/MZSearch.py
40
35
  corems/mass_spectra/calc/SignalProcessing.py
41
36
  corems/mass_spectra/calc/__init__.py
37
+ corems/mass_spectra/calc/lc_calc.py
42
38
  corems/mass_spectra/factory/GC_Class.py
43
39
  corems/mass_spectra/factory/LC_Class.py
44
- corems/mass_spectra/factory/LC_Temp.py
45
40
  corems/mass_spectra/factory/__init__.py
41
+ corems/mass_spectra/factory/chromat_data.py
42
+ corems/mass_spectra/factory/lc_class.py
46
43
  corems/mass_spectra/input/__init__.py
47
44
  corems/mass_spectra/input/andiNetCDF.py
48
45
  corems/mass_spectra/input/boosterHDF5.py
49
46
  corems/mass_spectra/input/brukerSolarix.py
50
- corems/mass_spectra/input/coremsHDF5.py
47
+ corems/mass_spectra/input/corems_hdf5.py
51
48
  corems/mass_spectra/input/massList.py
49
+ corems/mass_spectra/input/mzml.py
50
+ corems/mass_spectra/input/parserbase.py
52
51
  corems/mass_spectra/input/rawFileReader.py
53
- corems/mass_spectra/input/win_only/__init__.py
54
52
  corems/mass_spectra/output/__init__.py
55
53
  corems/mass_spectra/output/export.py
56
54
  corems/mass_spectrum/__init__.py
@@ -73,7 +71,6 @@ corems/mass_spectrum/input/boosterHDF5.py
73
71
  corems/mass_spectrum/input/coremsHDF5.py
74
72
  corems/mass_spectrum/input/massList.py
75
73
  corems/mass_spectrum/input/numpyArray.py
76
- corems/mass_spectrum/input/win_only/__init__.py
77
74
  corems/mass_spectrum/output/__init__.py
78
75
  corems/mass_spectrum/output/export.py
79
76
  corems/molecular_formula/__init__.py
@@ -85,7 +82,6 @@ corems/molecular_formula/input/__init__.py
85
82
  corems/molecular_formula/input/masslist_ref.py
86
83
  corems/molecular_id/__init__.py
87
84
  corems/molecular_id/calc/ClusterFilter.py
88
- corems/molecular_id/calc/KendrickGroup.py
89
85
  corems/molecular_id/calc/MolecularFilter.py
90
86
  corems/molecular_id/calc/SpectralSimilarity.py
91
87
  corems/molecular_id/calc/__init__.py
@@ -94,12 +90,16 @@ corems/molecular_id/factory/EI_SQL.py
94
90
  corems/molecular_id/factory/MolecularLookupTable.py
95
91
  corems/molecular_id/factory/__init__.py
96
92
  corems/molecular_id/factory/classification.py
93
+ corems/molecular_id/factory/lipid_molecular_metadata.py
97
94
  corems/molecular_id/factory/molecularSQL.py
95
+ corems/molecular_id/factory/spectrum_search_results.py
98
96
  corems/molecular_id/input/__init__.py
99
97
  corems/molecular_id/input/nistMSI.py
100
98
  corems/molecular_id/search/__init__.py
101
99
  corems/molecular_id/search/compoundSearch.py
100
+ corems/molecular_id/search/database_interfaces.py
102
101
  corems/molecular_id/search/findOxygenPeaks.py
102
+ corems/molecular_id/search/lcms_spectral_search.py
103
103
  corems/molecular_id/search/molecularFormulaSearch.py
104
104
  corems/molecular_id/search/priorityAssignment.py
105
105
  corems/ms_peak/__init__.py
@@ -145,20 +145,17 @@ ext_lib/dotnet/ThermoFisher.CommonCore.MassPrecisionEstimator.dll
145
145
  ext_lib/dotnet/ThermoFisher.CommonCore.MassPrecisionEstimator.xml
146
146
  ext_lib/dotnet/ThermoFisher.CommonCore.RawFileReader.dll
147
147
  ext_lib/dotnet/ThermoFisher.CommonCore.RawFileReader.xml
148
- tests/test_LossFinder.py
149
- tests/test_assembly_identification.py
150
148
  tests/test_calibration.py
151
149
  tests/test_classification.py
152
150
  tests/test_gcms.py
153
151
  tests/test_input.py
154
- tests/test_massErrorPrediction.py
155
152
  tests/test_mass_spectrum.py
156
153
  tests/test_mass_spectrum_export_import.py
157
154
  tests/test_molecular_formula.py
158
155
  tests/test_molecular_formula_db_factory.py
159
156
  tests/test_molecular_formula_search.py
160
157
  tests/test_mspeak.py
161
- tests/test_mz_search.py
162
158
  tests/test_output.py
163
159
  tests/test_search_mass_list.py
164
- tests/test_setting_settings.py
160
+ tests/test_setting_settings.py
161
+ tests/test_wf_lipidomics.py
@@ -5,12 +5,16 @@ IsoSpecPy~=2.2.2
5
5
  lmfit~=1.1.0
6
6
  lxml~=4.9.3
7
7
  matplotlib~=3.7.0
8
+ ms-entropy~=1.1.2
8
9
  netCDF4~=1.6.3
9
10
  numpy~=1.24.2
10
11
  openpyxl~=3.1.1
11
12
  pandas~=1.5.3
12
13
  pyswarm~=0.6
13
14
  pythonnet~=3.0.1
15
+ pymzml~=2.5.2
16
+ requests~=2.31.0
17
+ ripser==0.6.4
14
18
  s3path~=0.4.1
15
19
  scikit_learn~=1.2.2
16
20
  scipy~=1.10.1
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: CoreMS
3
- Version: 2.2.1
3
+ Version: 3.0.1
4
4
  Summary: Mass Spectrometry Framework for Small Molecules Analysis
5
5
  Home-page: https://github.com/EMSL-Computing/CoreMS
6
6
  Author: Corilo, Yuri
@@ -14,13 +14,13 @@ Classifier: Development Status :: 4 - Beta
14
14
  Description-Content-Type: text/markdown
15
15
  License-File: LICENSE
16
16
 
17
- ![CoreMS Logo](docs/CoreMS.COLOR_small.png?raw=true)
17
+ ![CoreMS Logo](https://github.com/EMSL-Computing/CoreMS/blob/master/docs/CoreMS.COLOR_small.png?raw=true)
18
18
 
19
19
  <div align="left">
20
20
 
21
21
  <br>
22
22
  <br>
23
- <a href="https://doi.org/10.5281/zenodo.4641552"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg" alt="CoreMS DOI" style="width:150px"></a>
23
+ <a href="https://doi.org/10.5281/zenodo.14009575"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14009575.svg" alt="DOI"></a>
24
24
  <br>
25
25
  </div>
26
26
 
@@ -29,19 +29,18 @@ License-File: LICENSE
29
29
  - [CoreMS](#CoreMS)
30
30
  - [Current Version](#current-version)
31
31
  - [Contact Information](#main-developers/contact )
32
+ - [Documentation](#documentation)
32
33
  - [Contribution Information](#contributing)
33
34
  - [Data Input](#data-input-formats)
34
35
  - [Data Output](#data-output-formats)
35
36
  - [Data Structure](#data-structure-types)
36
37
  - [Features](#available-features)
37
- - [Overview Slides](examples/CoreMS-Overview.pdf)
38
- - [Framework Documentation](https://emsl-computing.github.io/CoreMS/)
39
38
  - Installation
40
39
  - [Installation](#corems-installation)
41
40
  - [Thermo Raw File on Mac and Linux](#thermo-raw-file-access)
42
41
  - Execution
43
42
  - [Jupyter Notebook and Docker containers](#docker-stack)
44
- - [Simple Example](#simple-script-example)
43
+ - [Example for FT-ICR Data Processing](#simple-script-example)
45
44
  - [Python Examples](examples/scripts)
46
45
  - [Jupyter Notebook Examples](examples/notebooks)
47
46
  - Sibling Projects
@@ -66,13 +65,22 @@ CoreMS aims to provide
66
65
 
67
66
  ## Current Version
68
67
 
69
- `2.2.1`
68
+ `3.0.1`
70
69
 
71
70
  ***
72
71
 
73
72
  ## Main Developers/Contact
74
73
  - [Yuri. E. Corilo](mailto:corilo@pnnl.gov)
75
74
  - [William Kew](mailto:william.kew@pnnl.gov)
75
+ - [Katherine Heal](mailto:katherine.heal@pnnl.gov)
76
+
77
+ ***
78
+
79
+ ## Documentation
80
+
81
+ API documentation can be found [here](https://emsl-computing.github.io/CoreMS/corems.html).
82
+
83
+ Overview slides can be found [here](https://github.com/EMSL-Computing/CoreMS/blob/master/examples/CoreMS-Overview.pdf).
76
84
 
77
85
  ***
78
86
 
@@ -91,11 +99,12 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
91
99
  - Spectroswiss signal booster data-acquisition station (.hdf5)
92
100
  - MagLab ICR data-acquisition station (FT and magnitude mode) (.dat)
93
101
  - ANDI NetCDF for GC-MS (.cdf)
102
+ - mzml for LC-MS (.mzml)
94
103
  - Generic mass list in profile and centroid mde (include all delimiters types and Excel formats)
95
104
  - CoreMS exported processed mass list files(excel, .csv, .txt, pandas dataframe as .pkl)
96
105
  - CoreMS self-containing Hierarchical Data Format (.hdf5)
97
106
  - Pandas Dataframe
98
- - Support for cloud Storage using s3path.S3path(see examples of usage here: [S3 Support](tests/s3_test.py))
107
+ - Support for cloud Storage using s3path.S3path
99
108
 
100
109
  ### Data output formats
101
110
 
@@ -103,7 +112,7 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
103
112
  - Text Files (.csv, tab separated .txt, etc)
104
113
  - Microsoft Excel (xlsx)
105
114
  - Automatic JSON for metadata storage and reuse
106
- - Self-containing Hierarchical Data Format (.hdf5) including raw data and ime-series data-point for processed data-sets with all associated metadata stored as json attributes
115
+ - Self-containing Hierarchical Data Format (.hdf5) including raw data and time-series data-point for processed data-sets with all associated metadata stored as json attributes
107
116
 
108
117
  ### Data structure types
109
118
 
@@ -115,12 +124,6 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
115
124
  - Mass Spectral Peak
116
125
  - Molecular Formula
117
126
 
118
- ### In progress data structures
119
- - IMS-MS
120
- - LC-IMS-MS
121
- - Collections
122
- - Molecular Structure
123
-
124
127
  ***
125
128
 
126
129
  ## Available features
@@ -163,6 +166,15 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
163
166
  - Prediction of mass error distribution
164
167
  - Calculated ICR Resolving Power based on magnetic field (B), and transient time(T)
165
168
 
169
+ ### LC-MS Signal Processing, Molecular Formula Search and Assignment, and Spectral Similarity Searches
170
+ - Two dimensional (m/z and retention time) peak picking using persistent homology
171
+ - Smoothing, cetroid detection, and integration of extracted ion chromatograms
172
+ - Peak shape metric calculations including half peak height, tailing factor, and dispersity index
173
+ - MS1 deconvolution of mass features
174
+ - Idenfitication of <sup>13</sup>C isotopes within the mass features
175
+ - Compatibility with molecular formula searching on MS1 or MS2 spectra
176
+ - Spectral search capability using entropy similarity
177
+
166
178
  ***
167
179
 
168
180
  ## Installation
@@ -255,7 +267,7 @@ If you don't have docker installed, the easiest way is to [install docker for de
255
267
 
256
268
  ***
257
269
 
258
- ## Simple Script Example
270
+ ## Example for FT-ICR Data Processing
259
271
 
260
272
  More examples can be found under the directory examples/scripts, examples/notebooks
261
273
 
@@ -339,11 +351,11 @@ UML (unified modeling language) diagrams for Direct Infusion FT-MS and GC-MS cla
339
351
 
340
352
  If you use CoreMS in your work, please use the following citation:
341
353
 
342
- Version [2.2.1 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.2.1), archived on Zenodo:
354
+ Version [3.0.1 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v3.0.1), archived on Zenodo:
343
355
 
344
- [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg)](https://doi.org/10.5281/zenodo.4641552)
356
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14009575.svg)](https://doi.org/10.5281/zenodo.14009575)
345
357
 
346
- Yuri E. Corilo, William R. Kew, Lee Ann McCue (2021, March 27). EMSL-Computing/CoreMS: CoreMS 2.0.1 (Version v2.0.1), as developed on Github. Zenodo. http://doi.org/10.5281/zenodo.4641552
358
+ Yuri E. Corilo, William R. Kew, Lee Ann McCue, Katherine R . Heal, James C. Carr (2024, October 29). EMSL-Computing/CoreMS: CoreMS 3.0.1 (Version v3.0.1), as developed on Github. Zenodo. http://doi.org/10.5281/zenodo.14009575
347
359
 
348
360
  ```
349
361
 
@@ -1,10 +1,10 @@
1
- ![CoreMS Logo](docs/CoreMS.COLOR_small.png?raw=true)
1
+ ![CoreMS Logo](https://github.com/EMSL-Computing/CoreMS/blob/master/docs/CoreMS.COLOR_small.png?raw=true)
2
2
 
3
3
  <div align="left">
4
4
 
5
5
  <br>
6
6
  <br>
7
- <a href="https://doi.org/10.5281/zenodo.4641552"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg" alt="CoreMS DOI" style="width:150px"></a>
7
+ <a href="https://doi.org/10.5281/zenodo.14009575"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14009575.svg" alt="DOI"></a>
8
8
  <br>
9
9
  </div>
10
10
 
@@ -13,19 +13,18 @@
13
13
  - [CoreMS](#CoreMS)
14
14
  - [Current Version](#current-version)
15
15
  - [Contact Information](#main-developers/contact )
16
+ - [Documentation](#documentation)
16
17
  - [Contribution Information](#contributing)
17
18
  - [Data Input](#data-input-formats)
18
19
  - [Data Output](#data-output-formats)
19
20
  - [Data Structure](#data-structure-types)
20
21
  - [Features](#available-features)
21
- - [Overview Slides](examples/CoreMS-Overview.pdf)
22
- - [Framework Documentation](https://emsl-computing.github.io/CoreMS/)
23
22
  - Installation
24
23
  - [Installation](#corems-installation)
25
24
  - [Thermo Raw File on Mac and Linux](#thermo-raw-file-access)
26
25
  - Execution
27
26
  - [Jupyter Notebook and Docker containers](#docker-stack)
28
- - [Simple Example](#simple-script-example)
27
+ - [Example for FT-ICR Data Processing](#simple-script-example)
29
28
  - [Python Examples](examples/scripts)
30
29
  - [Jupyter Notebook Examples](examples/notebooks)
31
30
  - Sibling Projects
@@ -50,13 +49,22 @@ CoreMS aims to provide
50
49
 
51
50
  ## Current Version
52
51
 
53
- `2.2.1`
52
+ `3.0.1`
54
53
 
55
54
  ***
56
55
 
57
56
  ## Main Developers/Contact
58
57
  - [Yuri. E. Corilo](mailto:corilo@pnnl.gov)
59
58
  - [William Kew](mailto:william.kew@pnnl.gov)
59
+ - [Katherine Heal](mailto:katherine.heal@pnnl.gov)
60
+
61
+ ***
62
+
63
+ ## Documentation
64
+
65
+ API documentation can be found [here](https://emsl-computing.github.io/CoreMS/corems.html).
66
+
67
+ Overview slides can be found [here](https://github.com/EMSL-Computing/CoreMS/blob/master/examples/CoreMS-Overview.pdf).
60
68
 
61
69
  ***
62
70
 
@@ -75,11 +83,12 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
75
83
  - Spectroswiss signal booster data-acquisition station (.hdf5)
76
84
  - MagLab ICR data-acquisition station (FT and magnitude mode) (.dat)
77
85
  - ANDI NetCDF for GC-MS (.cdf)
86
+ - mzml for LC-MS (.mzml)
78
87
  - Generic mass list in profile and centroid mde (include all delimiters types and Excel formats)
79
88
  - CoreMS exported processed mass list files(excel, .csv, .txt, pandas dataframe as .pkl)
80
89
  - CoreMS self-containing Hierarchical Data Format (.hdf5)
81
90
  - Pandas Dataframe
82
- - Support for cloud Storage using s3path.S3path(see examples of usage here: [S3 Support](tests/s3_test.py))
91
+ - Support for cloud Storage using s3path.S3path
83
92
 
84
93
  ### Data output formats
85
94
 
@@ -87,7 +96,7 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
87
96
  - Text Files (.csv, tab separated .txt, etc)
88
97
  - Microsoft Excel (xlsx)
89
98
  - Automatic JSON for metadata storage and reuse
90
- - Self-containing Hierarchical Data Format (.hdf5) including raw data and ime-series data-point for processed data-sets with all associated metadata stored as json attributes
99
+ - Self-containing Hierarchical Data Format (.hdf5) including raw data and time-series data-point for processed data-sets with all associated metadata stored as json attributes
91
100
 
92
101
  ### Data structure types
93
102
 
@@ -99,12 +108,6 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
99
108
  - Mass Spectral Peak
100
109
  - Molecular Formula
101
110
 
102
- ### In progress data structures
103
- - IMS-MS
104
- - LC-IMS-MS
105
- - Collections
106
- - Molecular Structure
107
-
108
111
  ***
109
112
 
110
113
  ## Available features
@@ -147,6 +150,15 @@ As an open source project, CoreMS welcomes contributions of all forms. Before co
147
150
  - Prediction of mass error distribution
148
151
  - Calculated ICR Resolving Power based on magnetic field (B), and transient time(T)
149
152
 
153
+ ### LC-MS Signal Processing, Molecular Formula Search and Assignment, and Spectral Similarity Searches
154
+ - Two dimensional (m/z and retention time) peak picking using persistent homology
155
+ - Smoothing, cetroid detection, and integration of extracted ion chromatograms
156
+ - Peak shape metric calculations including half peak height, tailing factor, and dispersity index
157
+ - MS1 deconvolution of mass features
158
+ - Idenfitication of <sup>13</sup>C isotopes within the mass features
159
+ - Compatibility with molecular formula searching on MS1 or MS2 spectra
160
+ - Spectral search capability using entropy similarity
161
+
150
162
  ***
151
163
 
152
164
  ## Installation
@@ -239,7 +251,7 @@ If you don't have docker installed, the easiest way is to [install docker for de
239
251
 
240
252
  ***
241
253
 
242
- ## Simple Script Example
254
+ ## Example for FT-ICR Data Processing
243
255
 
244
256
  More examples can be found under the directory examples/scripts, examples/notebooks
245
257
 
@@ -323,11 +335,11 @@ UML (unified modeling language) diagrams for Direct Infusion FT-MS and GC-MS cla
323
335
 
324
336
  If you use CoreMS in your work, please use the following citation:
325
337
 
326
- Version [2.2.1 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v2.2.1), archived on Zenodo:
338
+ Version [3.0.1 Release on GitHub](https://github.com/EMSL-Computing/CoreMS/releases/tag/v3.0.1), archived on Zenodo:
327
339
 
328
- [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4641552.svg)](https://doi.org/10.5281/zenodo.4641552)
340
+ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14009575.svg)](https://doi.org/10.5281/zenodo.14009575)
329
341
 
330
- Yuri E. Corilo, William R. Kew, Lee Ann McCue (2021, March 27). EMSL-Computing/CoreMS: CoreMS 2.0.1 (Version v2.0.1), as developed on Github. Zenodo. http://doi.org/10.5281/zenodo.4641552
342
+ Yuri E. Corilo, William R. Kew, Lee Ann McCue, Katherine R . Heal, James C. Carr (2024, October 29). EMSL-Computing/CoreMS: CoreMS 3.0.1 (Version v3.0.1), as developed on Github. Zenodo. http://doi.org/10.5281/zenodo.14009575
331
343
 
332
344
  ```
333
345
 
@@ -0,0 +1,60 @@
1
+ __author__ = "Yuri E. Corilo"
2
+ __version__ = "3.0.1"
3
+ import time
4
+ import os
5
+ import sys
6
+ import hashlib
7
+
8
+ # Get the path to the README file
9
+ readme_path = os.path.join(os.path.dirname(__file__), "..", "README.md")
10
+
11
+ # Read the contents of the README file if it exists
12
+ if os.path.exists(readme_path):
13
+ try:
14
+ with open(readme_path, "r", encoding="utf-8") as readme_file:
15
+ __doc__ = readme_file.read()
16
+ except Exception as e:
17
+ __doc__ = "CoreMS: A comprehensive mass spectrometry framework for software development and data analysis of small molecules analysis."
18
+ print(f"Warning: Could not read README.md file. Error: {e}")
19
+ else:
20
+ __doc__ = "CoreMS: A comprehensive mass spectrometry framework for software development and data analysis of small molecules analysis."
21
+
22
+
23
+
24
+ def timeit(method):
25
+ def timed(*args, **kw):
26
+ ts = time.time()
27
+ result = method(*args, **kw)
28
+ te = time.time()
29
+ if "log_time" in kw:
30
+ name = kw.get("log_name", method.__name__.upper())
31
+ kw["log_time"][name] = int((te - ts) * 1000)
32
+ else:
33
+ print("%r %2.2f ms" % (method.__name__, (te - ts) * 1000))
34
+ return result
35
+
36
+ return timed
37
+
38
+
39
+ class SuppressPrints:
40
+ def __enter__(self):
41
+ self._original_stdout = sys.stdout
42
+ sys.stdout = open(os.devnull, "w")
43
+
44
+ def __exit__(self, exc_type, exc_val, exc_tb):
45
+ sys.stdout.close()
46
+ sys.stdout = self._original_stdout
47
+
48
+
49
+ def chunks(lst, n):
50
+ """Yield successive n-sized chunks from lst."""
51
+ for i in range(0, len(lst), n):
52
+ yield lst[i : i + n]
53
+
54
+
55
+ def corems_md5(fname):
56
+ bytes_io = fname.open("rb").read()
57
+
58
+ md5_returned = hashlib.sha256(bytes_io).hexdigest()
59
+
60
+ return "{}:{}".format("sha256", md5_returned)