Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix README.md #62

Merged
merged 3 commits into from
Sep 13, 2024
Merged

Fix README.md #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ee2da7
Fix script with hyperspy 2.0
ericpre Sep 12, 2024
59386d0
Temporary remove kikuchipy until it supports hyperspy 2.0
ericpre Sep 12, 2024
b145b83
Update `README.md` by running script
ericpre Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
304 changes: 51 additions & 253 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,261 +15,59 @@ and send us a pull request.

# (Known) HyperSpy extensions

| Package name | Brief description |
|--------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
| [hyperspy-gui-ipywidgets](https://github.com/hyperspy/hyperspy_gui_ipywidgets) | ipywidgets widgets for HyperSpy |
| [hyperspy-gui-traitsui](https://github.com/hyperspy/hyperspy_gui_traitsui) | traitsui widgets for HyperSpy |
| [kikuchipy](https://github.com/kikuchipy/kikuchipy) | Processing, simulating and indexing of electron backscatter diffraction patterns |
| [LumiSpy](https://github.com/lumispy/lumispy) | Analysis of luminescence spectroscopy data |
| [pyxem](https://github.com/pyxem/pyxem) | Multi-dimensional diffraction microscopy |
| Package name | Brief description |
|--------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|
| [exspy](https://github.com/hyperspy/exspy) | Electron energy loss spectroscopy (EELS) and X-ray energy dispersive spectroscopy (EDS)|
| [holospy](https://github.com/hyperspy/holospy) | Electron holography |
| [hyperspy-gui-ipywidgets](https://github.com/hyperspy/hyperspy_gui_ipywidgets) | ipywidgets widgets for HyperSpy |
| [hyperspy-gui-traitsui](https://github.com/hyperspy/hyperspy_gui_traitsui) | traitsui widgets for HyperSpy |
| [kikuchipy](https://github.com/kikuchipy/kikuchipy) | Processing, simulating and indexing of electron backscatter diffraction patterns |
| [LumiSpy](https://github.com/lumispy/lumispy) | Analysis of luminescence spectroscopy data |
| [pyxem](https://github.com/pyxem/pyxem) | Multi-dimensional diffraction microscopy |
| [rosettasciio](https://github.com/hyperspy/rosettasciio) | Reading and writing of scientific data formats. |

## List of `signal_type` classes provided by the different HyperSpy extensions in alphabetical order


<table>
<thead>
<tr>
<th>signal_type</th>
<th>aliases</th>
<th>class name</th>
<th>package</th>
</tr>
</thead>
<tbody>
<tr>
<td>beam_shift</td>
<td></td>
<td>BeamShift</td>
<td>pyxem</td>
</tr>
<tr>
<td>CL_SEM</td>
<td>CLSEM, cathodoluminescence SEM</td>
<td>CLSEMSpectrum</td>
<td>lumispy</td>
</tr>
<tr>
<td>CL_STEM</td>
<td>CLSTEM, cathodoluminescence STEM</td>
<td>CLSTEMSpectrum</td>
<td>lumispy</td>
</tr>
<tr>
<td>CL</td>
<td>CLSpectrum, cathodoluminescence</td>
<td>CLSpectrum</td>
<td>lumispy</td>
</tr>
<tr>
<td>correlation</td>
<td></td>
<td>Correlation1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>correlation</td>
<td></td>
<td>Correlation2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>dpc</td>
<td></td>
<td>DPCBaseSignal</td>
<td>pyxem</td>
</tr>
<tr>
<td>dpc</td>
<td></td>
<td>DPCSignal1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>dpc</td>
<td></td>
<td>DPCSignal2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>DielectricFunction</td>
<td>dielectric function</td>
<td>DielectricFunction</td>
<td>hyperspy</td>
</tr>
<tr>
<td>diffraction</td>
<td></td>
<td>Diffraction1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>diffraction</td>
<td></td>
<td>Diffraction2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>diffraction_variance</td>
<td></td>
<td>DiffractionVariance1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>diffraction_variance</td>
<td></td>
<td>DiffractionVariance2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>diffraction_vectors</td>
<td></td>
<td>DiffractionVectors</td>
<td>pyxem</td>
</tr>
<tr>
<td>diffraction_vectors</td>
<td></td>
<td>DiffractionVectors1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>diffraction_vectors</td>
<td></td>
<td>DiffractionVectors2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>tensor_field</td>
<td></td>
<td>DisplacementGradientMap</td>
<td>pyxem</td>
</tr>
<tr>
<td>EBSD</td>
<td>electron_backscatter_diffraction</td>
<td>EBSD</td>
<td>kikuchipy</td>
</tr>
<tr>
<td>EBSDMasterPattern</td>
<td>ebsd_master_pattern, master_pattern</td>
<td>EBSDMasterPattern</td>
<td>kikuchipy</td>
</tr>
<tr>
<td>ECPMasterPattern</td>
<td>ecp_master_pattern</td>
<td>ECPMasterPattern</td>
<td>kikuchipy</td>
</tr>
<tr>
<td>EDS_SEM</td>
<td></td>
<td>EDSSEMSpectrum</td>
<td>hyperspy</td>
</tr>
<tr>
<td>EDS_TEM</td>
<td></td>
<td>EDSTEMSpectrum</td>
<td>hyperspy</td>
</tr>
<tr>
<td>EELS</td>
<td>TEM EELS</td>
<td>EELSSpectrum</td>
<td>hyperspy</td>
</tr>
<tr>
<td>EL</td>
<td>ELSpectrum, electroluminescence</td>
<td>ELSpectrum</td>
<td>lumispy</td>
</tr>
<tr>
<td>electron_diffraction</td>
<td></td>
<td>ElectronDiffraction1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>electron_diffraction</td>
<td></td>
<td>ElectronDiffraction2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>hologram</td>
<td></td>
<td>HologramImage</td>
<td>hyperspy</td>
</tr>
<tr>
<td>Luminescence</td>
<td>LuminescenceSpectrum</td>
<td>LumiSpectrum</td>
<td>lumispy</td>
</tr>
<tr>
<td>Transient</td>
<td>TRLumi, TR luminescence, time-resolved luminescence</td>
<td>LumiTransient</td>
<td>lumispy</td>
</tr>
<tr>
<td>TransientSpec</td>
<td>TRLumiSpec, TR luminescence spectrum, time-resolved luminescence spectrum</td>
<td>LumiTransientSpectrum</td>
<td>lumispy</td>
</tr>
<tr>
<td>PL</td>
<td>PLSpectrum, photoluminescence</td>
<td>PLSpectrum</td>
<td>lumispy</td>
</tr>
<tr>
<td>pair_distribution_function</td>
<td></td>
<td>PairDistributionFunction1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>polar_diffraction</td>
<td></td>
<td>PolarDiffraction2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>power</td>
<td></td>
<td>Power2D</td>
<td>pyxem</td>
</tr>
<tr>
<td>reduced_intensity</td>
<td></td>
<td>ReducedIntensity1D</td>
<td>pyxem</td>
</tr>
<tr>
<td>vector_matching</td>
<td></td>
<td>VectorMatchingResults</td>
<td>pyxem</td>
</tr>
<tr>
<td>VirtualBSEImage</td>
<td>virtual_backscatter_electron_image</td>
<td>VirtualBSEImage</td>
<td>kikuchipy</td>
</tr>
<tr>
<td>virtual_dark_field</td>
<td></td>
<td>VirtualDarkFieldImage</td>
<td>pyxem</td>
</tr>
</tbody>
</table>
| signal_type | aliases | class name | package |
| :-------------------------: | :-----------------------------------------------------------------------: | :-------------------------: | :-----: |
| beam_shift | | BeamShift | pyxem |
| CL_SEM | CLSEM, cathodoluminescence SEM | CLSEMSpectrum | lumispy |
| CL_STEM | CLSTEM, cathodoluminescence STEM | CLSTEMSpectrum | lumispy |
| CL | CLSpectrum, cathodoluminescence | CLSpectrum | lumispy |
| correlation | | Correlation1D | pyxem |
| correlation | | Correlation2D | pyxem |
| dpc | | DPCSignal1D | pyxem |
| dpc | | DPCSignal2D | pyxem |
| DielectricFunction | dielectric function | DielectricFunction | exspy |
| diffraction | | Diffraction1D | pyxem |
| diffraction | | Diffraction2D | pyxem |
| diffraction_variance | | DiffractionVariance1D | pyxem |
| diffraction_variance | | DiffractionVariance2D | pyxem |
| diffraction_vectors | | DiffractionVectors | pyxem |
| diffraction_vectors | | DiffractionVectors1D | pyxem |
| diffraction_vectors | | DiffractionVectors2D | pyxem |
| tensor_field | | DisplacementGradientMap | pyxem |
| EDS_SEM | | EDSSEMSpectrum | exspy |
| EDS_TEM | | EDSTEMSpectrum | exspy |
| EELS | TEM EELS | EELSSpectrum | exspy |
| EL | ELSpectrum, electroluminescence | ELSpectrum | lumispy |
| electron_diffraction | | ElectronDiffraction1D | pyxem |
| electron_diffraction | | ElectronDiffraction2D | pyxem |
| hologram | | HologramImage | holospy |
| insitu_diffraction | | InSituDiffraction2D | pyxem |
| labeled_diffraction_vectors | | LabeledDiffractionVectors2D | pyxem |
| Luminescence | LuminescenceSpectrum | LumiSpectrum | lumispy |
| Transient | TRLumi, TR luminescence, time-resolved luminescence | LumiTransient | lumispy |
| TransientSpec | TRLumiSpec, TR luminescence spectrum, time-resolved luminescence spectrum | LumiTransientSpectrum | lumispy |
| orientation_map | | OrientationMap | pyxem |
| PL | PLSpectrum, photoluminescence | PLSpectrum | lumispy |
| pair_distribution_function | | PairDistributionFunction1D | pyxem |
| polar_diffraction | | PolarDiffraction2D | pyxem |
| polar_vectors | | PolarVectors | pyxem |
| power | | Power2D | pyxem |
| reduced_intensity | | ReducedIntensity1D | pyxem |
| vector_matching | | VectorMatchingResults | pyxem |
| virtual_dark_field | | VirtualDarkFieldImage | pyxem |


1 change: 0 additions & 1 deletion extension_list.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
exspy
holospy
hyperspy
kikuchipy
lumispy
pyxem
10 changes: 8 additions & 2 deletions make_README.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
import contextlib
import io
import os

from prettytable import MARKDOWN
import hyperspy.api as hs


readme_source_folder = 'readme_source'

# Get the information from hyperspy
table_html = hs.print_known_signal_types()._repr_html_()
f = io.StringIO()
with contextlib.redirect_stdout(f):
hs.print_known_signal_types(style=MARKDOWN)
table_ascii = f.getvalue()

with open(os.path.join(readme_source_folder, '2-extension_table.md'), "w") as f:
f.write(table_html)
f.write(table_ascii)

# Make the README.md by concatenation
source_file_list = sorted(os.listdir(readme_source_folder))
Expand Down
Loading
Loading