Repository navigation
refactor: ensure correct usage of underscores and hyphens for file and folder names #277
Description
Double check that we use "-" for folders, static files (.rst). Please check the tutorial provided in scikit-package/scikit-package#330
Activity
stevenhua0320 commented on Mar 30, 2026
As we have skpkg with several times, I believe that we have correct usage of the symbols on files and folder names. See the tree structure here. If everything is fine here, we could close this issue.
(diffpy.pdfgui_env) huarundong@Stevens-MacBook-Pro-405 diffpy.pdfgui % tree . ├── AUTHORS.rst ├── CHANGELOG.rst ├── CODE-OF-CONDUCT.rst ├── CODE_OF_CONDUCT.rst ├── LICENSE.rst ├── MANIFEST.in ├── README.rst ├── build │ ├── bdist.macosx-11.0-arm64 │ └── lib │ └── diffpy │ ├── __init__.py │ └── pdfgui │ ├── __init__.py │ ├── applications │ │ ├── __init__.py │ │ └── pdfgui.py │ ├── control │ │ ├── __init__.py │ │ ├── calculation.py │ │ ├── constraint.py │ │ ├── controlerrors.py │ │ ├── fitdataset.py │ │ ├── fitstructure.py │ │ ├── fitting.py │ │ ├── organizer.py │ │ ├── parameter.py │ │ ├── pdfcomponent.py │ │ ├── pdfdataset.py │ │ ├── pdfguicontrol.py │ │ ├── pdfguimacros.py │ │ ├── pdflist.py │ │ ├── pdfstructure.py │ │ ├── plotter.py │ │ └── structureviewer.py │ ├── gui │ │ ├── DesignNotes.txt │ │ ├── __init__.py │ │ ├── aboutdialog.py │ │ ├── adddatapanel.py │ │ ├── addphasepanel.py │ │ ├── blankpanel.py │ │ ├── bondangledialog.py │ │ ├── bondlengthdialog.py │ │ ├── calculationpanel.py │ │ ├── datasetconfigurepanel.py │ │ ├── datasetconstraintpanel.py │ │ ├── datasetpanel.py │ │ ├── datasetresultspanel.py │ │ ├── debugoptions.py │ │ ├── design │ │ │ ├── __init__.py │ │ │ ├── aboutdialog.wxg │ │ │ ├── adddatapanel.wxg │ │ │ ├── addphasepanel.wxg │ │ │ ├── bondlengthdialog.wxg │ │ │ ├── calculationpanel.wxg │ │ │ ├── datasetconfigurepanel.wxg │ │ │ ├── datasetconstraintpanel.wxg │ │ │ ├── datasetpanel.wxg │ │ │ ├── datasetresultspanel.wxg │ │ │ ├── dopingseriespanel.wxg │ │ │ ├── errorreportdialog.wxg │ │ │ ├── fitnotebookpanel.wxg │ │ │ ├── insertrowsdialog.wxg │ │ │ ├── journalpanel.wxg │ │ │ ├── outputpanel.wxg │ │ │ ├── parameterspanel.wxg │ │ │ ├── phaseconfigurepanel.wxg │ │ │ ├── phaseconstraintspanel.wxg │ │ │ ├── phaseresultspanel.wxg │ │ │ ├── plotpanel.wxg │ │ │ ├── preferencespanel.wxg │ │ │ ├── resultspanel.wxg │ │ │ ├── rseriespanel.wxg │ │ │ ├── sgconstraindialog.wxg │ │ │ ├── sgstructuredialog.wxg │ │ │ ├── supercelldialog.wxg │ │ │ └── temperatureseriespanel.wxg │ │ ├── dopingseriespanel.py │ │ ├── errorreportdialog.py │ │ ├── errorreportdialog_control_fix.py │ │ ├── errorwrapper.py │ │ ├── extendedplotframe.py │ │ ├── fitnotebookpanel.py │ │ ├── fittree.py │ │ ├── gui_organization.txt │ │ ├── insertrowsdialog.py │ │ ├── journalpanel.py │ │ ├── main.py │ │ ├── mainframe.py │ │ ├── menuitems.txt │ │ ├── outputpanel.py │ │ ├── paneltest.py │ │ ├── parameterspanel.py │ │ ├── pdfguiglobals.py │ │ ├── pdfpanel.py │ │ ├── phaseconfigurepanel.py │ │ ├── phaseconstraintspanel.py │ │ ├── phasenotebookpanel.py │ │ ├── phasepanelutils.py │ │ ├── phaseresultspanel.py │ │ ├── plotpanel.py │ │ ├── preferencespanel.py │ │ ├── resultspanel.py │ │ ├── rseriespanel.py │ │ ├── sgconstraindialog.py │ │ ├── sgstructuredialog.py │ │ ├── supercelldialog.py │ │ ├── temperatureseriespanel.py │ │ ├── tooltips.py │ │ ├── welcomepanel.py │ │ ├── windowperspective.py │ │ └── wxextensions │ │ ├── __init__.py │ │ ├── autowidthlabelsgrid.py │ │ ├── listctrls.py │ │ ├── paneldialog.py │ │ ├── textctrlutils.py │ │ └── validators.py │ ├── icons │ │ ├── C60-16x16.png │ │ ├── C60_202x202.xcf │ │ ├── __init__.py │ │ ├── buckyfccicon.m │ │ ├── calculationitem.png │ │ ├── columbia-logo.png │ │ ├── danse-logo.png │ │ ├── datasetitem.png │ │ ├── exportplotdata.png │ │ ├── exportplotdata.xcf │ │ ├── fititem.png │ │ ├── fitting.png │ │ ├── fitting.xcf │ │ ├── logo.png │ │ ├── logo.xcf │ │ ├── msu-logo.png │ │ ├── nsf-logo.png │ │ ├── pdfgui.ico │ │ ├── pdfgui_512x512.xcf │ │ ├── phaseitem.png │ │ ├── plotting.png │ │ ├── plotting.xcf │ │ ├── run.png │ │ ├── stop.png │ │ ├── titlepage.png │ │ └── titlepage.xcf │ ├── pdfgui_app.py │ ├── tui.py │ ├── utils.py │ └── version.py ├── cookiecutter.json ├── docs │ ├── Makefile │ ├── make.bat │ └── source │ ├── Farrow-jpcm-2007.pdf │ ├── Proffen-jac-1999.pdf │ ├── _static │ ├── api │ │ ├── diffpy.pdfgui.applications.rst │ │ ├── diffpy.pdfgui.control.rst │ │ ├── diffpy.pdfgui.gui.design.rst │ │ ├── diffpy.pdfgui.gui.rst │ │ ├── diffpy.pdfgui.gui.wxextensions.rst │ │ ├── diffpy.pdfgui.icons.rst │ │ └── diffpy.pdfgui.rst │ ├── conf.py │ ├── examples.rst │ ├── extras.rst │ ├── images │ │ ├── Makefile │ │ ├── eq-01.png │ │ ├── eq-02.png │ │ ├── fig2-01.png │ │ ├── fig2-02.png │ │ ├── fig2-03.png │ │ ├── fig2-04.png │ │ ├── fig2-05.png │ │ ├── fig2-06.png │ │ ├── fig2-07.png │ │ ├── fig2-08.png │ │ ├── fig2-09.png │ │ ├── fig2-10.png │ │ ├── fig2-11.png │ │ ├── fig3-01.png │ │ ├── fig3-02.png │ │ ├── fig3-03.png │ │ ├── fig3-04.png │ │ ├── fig3-05.png │ │ ├── fig3-06.png │ │ ├── fig3-07.png │ │ ├── fig3-08.png │ │ ├── fig3-09.png │ │ ├── fig3-10.png │ │ ├── fig4-01.png │ │ ├── fig4-02.png │ │ ├── gear-icon.png │ │ ├── originals │ │ │ ├── fig2-01.png │ │ │ ├── fig2-01.xcf │ │ │ ├── fig2-02.png │ │ │ ├── fig2-03.png │ │ │ ├── fig2-04.png │ │ │ ├── fig2-05.png │ │ │ ├── fig2-06.png │ │ │ ├── fig2-07.png │ │ │ ├── fig2-08.png │ │ │ ├── fig2-09.png │ │ │ ├── fig2-10.png │ │ │ ├── fig2-11.png │ │ │ ├── fig3-01.png │ │ │ ├── fig3-02.png │ │ │ ├── fig3-03.png │ │ │ ├── fig3-04.png │ │ │ ├── fig3-05.png │ │ │ ├── fig3-06.png │ │ │ ├── fig3-07.png │ │ │ ├── fig3-08.png │ │ │ ├── fig3-09.png │ │ │ ├── fig3-10.png │ │ │ ├── fig4-01.png │ │ │ └── fig4-02.png │ │ ├── plot-icon.png │ │ └── stop-icon.png │ ├── img │ ├── index.rst │ ├── license.rst │ ├── manual.rst │ ├── manual_resources │ │ ├── Doping data series.zip │ │ ├── Nanoparticle structure.zip │ │ ├── Ni data.zip │ │ ├── Temperature data series.zip │ │ └── tui_mno_bond_lengths.py │ ├── pdfgui.pdf │ ├── release.rst │ ├── snippets │ └── tutorial.rst ├── environment.yml ├── news │ ├── TEMPLATE.rst │ ├── doc.rst │ ├── fix-gui-functionality.rst │ ├── rm-manuals.rst │ ├── rm-texinfo.rst │ └── skpkg-update.rst ├── pyproject.toml ├── requirements │ ├── conda.txt │ ├── docs.txt │ ├── pip.txt │ └── tests.txt ├── src │ └── diffpy │ ├── __init__.py │ ├── __pycache__ │ │ └── __init__.cpython-313.pyc │ └── pdfgui │ ├── __init__.py │ ├── __pycache__ │ │ ├── __init__.cpython-313.pyc │ │ ├── tui.cpython-313.pyc │ │ ├── utils.cpython-313.pyc │ │ └── version.cpython-313.pyc │ ├── applications │ │ ├── __init__.py │ │ ├── __pycache__ │ │ │ ├── __init__.cpython-313.pyc │ │ │ └── pdfgui.cpython-313.pyc │ │ └── pdfgui.py │ ├── control │ │ ├── __init__.py │ │ ├── __pycache__ │ │ │ ├── __init__.cpython-313.pyc │ │ │ ├── calculation.cpython-313.pyc │ │ │ ├── constraint.cpython-313.pyc │ │ │ ├── controlerrors.cpython-313.pyc │ │ │ ├── fitdataset.cpython-313.pyc │ │ │ ├── fitstructure.cpython-313.pyc │ │ │ ├── fitting.cpython-313.pyc │ │ │ ├── organizer.cpython-313.pyc │ │ │ ├── parameter.cpython-313.pyc │ │ │ ├── pdfcomponent.cpython-313.pyc │ │ │ ├── pdfdataset.cpython-313.pyc │ │ │ ├── pdfguicontrol.cpython-313.pyc │ │ │ ├── pdfguimacros.cpython-313.pyc │ │ │ ├── pdflist.cpython-313.pyc │ │ │ ├── pdfstructure.cpython-313.pyc │ │ │ ├── plotter.cpython-313.pyc │ │ │ └── structureviewer.cpython-313.pyc │ │ ├── calculation.py │ │ ├── constraint.py │ │ ├── controlerrors.py │ │ ├── fitdataset.py │ │ ├── fitstructure.py │ │ ├── fitting.py │ │ ├── organizer.py │ │ ├── parameter.py │ │ ├── pdfcomponent.py │ │ ├── pdfdataset.py │ │ ├── pdfguicontrol.py │ │ ├── pdfguimacros.py │ │ ├── pdflist.py │ │ ├── pdfstructure.py │ │ ├── plotter.py │ │ └── structureviewer.py │ ├── gui │ │ ├── DesignNotes.txt │ │ ├── __init__.py │ │ ├── __pycache__ │ │ │ ├── __init__.cpython-313.pyc │ │ │ ├── aboutdialog.cpython-313.pyc │ │ │ ├── adddatapanel.cpython-313.pyc │ │ │ ├── addphasepanel.cpython-313.pyc │ │ │ ├── blankpanel.cpython-313.pyc │ │ │ ├── calculationpanel.cpython-313.pyc │ │ │ ├── datasetconfigurepanel.cpython-313.pyc │ │ │ ├── datasetconstraintpanel.cpython-313.pyc │ │ │ ├── datasetpanel.cpython-313.pyc │ │ │ ├── datasetresultspanel.cpython-313.pyc │ │ │ ├── debugoptions.cpython-313.pyc │ │ │ ├── dopingseriespanel.cpython-313.pyc │ │ │ ├── errorreportdialog.cpython-313.pyc │ │ │ ├── errorreportdialog_control_fix.cpython-313.pyc │ │ │ ├── errorwrapper.cpython-313.pyc │ │ │ ├── extendedplotframe.cpython-313.pyc │ │ │ ├── fitnotebookpanel.cpython-313.pyc │ │ │ ├── fittree.cpython-313.pyc │ │ │ ├── insertrowsdialog.cpython-313.pyc │ │ │ ├── journalpanel.cpython-313.pyc │ │ │ ├── main.cpython-313.pyc │ │ │ ├── mainframe.cpython-313.pyc │ │ │ ├── outputpanel.cpython-313.pyc │ │ │ ├── parameterspanel.cpython-313.pyc │ │ │ ├── pdfguiglobals.cpython-313.pyc │ │ │ ├── pdfpanel.cpython-313.pyc │ │ │ ├── phaseconfigurepanel.cpython-313.pyc │ │ │ ├── phaseconstraintspanel.cpython-313.pyc │ │ │ ├── phasenotebookpanel.cpython-313.pyc │ │ │ ├── phasepanelutils.cpython-313.pyc │ │ │ ├── phaseresultspanel.cpython-313.pyc │ │ │ ├── plotpanel.cpython-313.pyc │ │ │ ├── preferencespanel.cpython-313.pyc │ │ │ ├── resultspanel.cpython-313.pyc │ │ │ ├── rseriespanel.cpython-313.pyc │ │ │ ├── sgconstraindialog.cpython-313.pyc │ │ │ ├── sgstructuredialog.cpython-313.pyc │ │ │ ├── temperatureseriespanel.cpython-313.pyc │ │ │ ├── tooltips.cpython-313.pyc │ │ │ ├── welcomepanel.cpython-313.pyc │ │ │ └── windowperspective.cpython-313.pyc │ │ ├── aboutdialog.py │ │ ├── adddatapanel.py │ │ ├── addphasepanel.py │ │ ├── blankpanel.py │ │ ├── bondangledialog.py │ │ ├── bondlengthdialog.py │ │ ├── calculationpanel.py │ │ ├── datasetconfigurepanel.py │ │ ├── datasetconstraintpanel.py │ │ ├── datasetpanel.py │ │ ├── datasetresultspanel.py │ │ ├── debugoptions.py │ │ ├── design │ │ │ ├── __init__.py │ │ │ ├── aboutdialog.wxg │ │ │ ├── adddatapanel.wxg │ │ │ ├── addphasepanel.wxg │ │ │ ├── bondlengthdialog.wxg │ │ │ ├── calculationpanel.wxg │ │ │ ├── datasetconfigurepanel.wxg │ │ │ ├── datasetconstraintpanel.wxg │ │ │ ├── datasetpanel.wxg │ │ │ ├── datasetresultspanel.wxg │ │ │ ├── dopingseriespanel.wxg │ │ │ ├── errorreportdialog.wxg │ │ │ ├── fitnotebookpanel.wxg │ │ │ ├── insertrowsdialog.wxg │ │ │ ├── journalpanel.wxg │ │ │ ├── outputpanel.wxg │ │ │ ├── parameterspanel.wxg │ │ │ ├── phaseconfigurepanel.wxg │ │ │ ├── phaseconstraintspanel.wxg │ │ │ ├── phaseresultspanel.wxg │ │ │ ├── plotpanel.wxg │ │ │ ├── preferencespanel.wxg │ │ │ ├── resultspanel.wxg │ │ │ ├── rseriespanel.wxg │ │ │ ├── sgconstraindialog.wxg │ │ │ ├── sgstructuredialog.wxg │ │ │ ├── supercelldialog.wxg │ │ │ └── temperatureseriespanel.wxg │ │ ├── dopingseriespanel.py │ │ ├── errorreportdialog.py │ │ ├── errorreportdialog_control_fix.py │ │ ├── errorwrapper.py │ │ ├── extendedplotframe.py │ │ ├── fitnotebookpanel.py │ │ ├── fittree.py │ │ ├── gui_organization.txt │ │ ├── insertrowsdialog.py │ │ ├── journalpanel.py │ │ ├── main.py │ │ ├── mainframe.py │ │ ├── menuitems.txt │ │ ├── outputpanel.py │ │ ├── paneltest.py │ │ ├── parameterspanel.py │ │ ├── pdfguiglobals.py │ │ ├── pdfpanel.py │ │ ├── phaseconfigurepanel.py │ │ ├── phaseconstraintspanel.py │ │ ├── phasenotebookpanel.py │ │ ├── phasepanelutils.py │ │ ├── phaseresultspanel.py │ │ ├── plotpanel.py │ │ ├── preferencespanel.py │ │ ├── resultspanel.py │ │ ├── rseriespanel.py │ │ ├── sgconstraindialog.py │ │ ├── sgstructuredialog.py │ │ ├── supercelldialog.py │ │ ├── temperatureseriespanel.py │ │ ├── tooltips.py │ │ ├── welcomepanel.py │ │ ├── windowperspective.py │ │ └── wxextensions │ │ ├── __init__.py │ │ ├── __pycache__ │ │ │ ├── __init__.cpython-313.pyc │ │ │ ├── autowidthlabelsgrid.cpython-313.pyc │ │ │ ├── listctrls.cpython-313.pyc │ │ │ ├── textctrlutils.cpython-313.pyc │ │ │ └── validators.cpython-313.pyc │ │ ├── autowidthlabelsgrid.py │ │ ├── listctrls.py │ │ ├── paneldialog.py │ │ ├── textctrlutils.py │ │ └── validators.py │ ├── icons │ │ ├── C60-16x16.png │ │ ├── C60_202x202.xcf │ │ ├── __init__.py │ │ ├── buckyfccicon.m │ │ ├── calculationitem.png │ │ ├── columbia-logo.png │ │ ├── danse-logo.png │ │ ├── datasetitem.png │ │ ├── exportplotdata.png │ │ ├── exportplotdata.xcf │ │ ├── fititem.png │ │ ├── fitting.png │ │ ├── fitting.xcf │ │ ├── logo.png │ │ ├── logo.xcf │ │ ├── msu-logo.png │ │ ├── nsf-logo.png │ │ ├── pdfgui.ico │ │ ├── pdfgui_512x512.xcf │ │ ├── phaseitem.png │ │ ├── plotting.png │ │ ├── plotting.xcf │ │ ├── run.png │ │ ├── stop.png │ │ ├── titlepage.png │ │ └── titlepage.xcf │ ├── pdfgui_app.py │ ├── tui.py │ ├── utils.py │ └── version.py └── tests ├── __pycache__ │ ├── conftest.cpython-313-pytest-9.0.2.pyc │ ├── test_aboutdialog.cpython-313-pytest-9.0.2.pyc │ ├── test_calculation.cpython-313-pytest-9.0.2.pyc │ ├── test_constraint.cpython-313-pytest-9.0.2.pyc │ ├── test_datasetpanels.cpython-313-pytest-9.0.2.pyc │ ├── test_dopingseriespanel.cpython-313-pytest-9.0.2.pyc │ ├── test_extendedplotframe.cpython-313-pytest-9.0.2.pyc │ ├── test_fitdataset.cpython-313-pytest-9.0.2.pyc │ ├── test_fitstructure.cpython-313-pytest-9.0.2.pyc │ ├── test_insertrowsdialog.cpython-313-pytest-9.0.2.pyc │ ├── test_loadproject.cpython-313-pytest-9.0.2.pyc │ ├── test_mainframe.cpython-313-pytest-9.0.2.pyc │ ├── test_parameter.cpython-313-pytest-9.0.2.pyc │ ├── test_parameterspanel.cpython-313-pytest-9.0.2.pyc │ ├── test_pdfdataset.cpython-313-pytest-9.0.2.pyc │ ├── test_pdfguicontrol.cpython-313-pytest-9.0.2.pyc │ ├── test_pdfstructure.cpython-313-pytest-9.0.2.pyc │ ├── test_phaseconfigurepanel.cpython-313-pytest-9.0.2.pyc │ ├── test_showphasenotebookpanel.cpython-313-pytest-9.0.2.pyc │ ├── test_structureviewer.cpython-313-pytest-9.0.2.pyc │ ├── test_temperatureseriespanel.cpython-313-pytest-9.0.2.pyc │ ├── test_version.cpython-313-pytest-9.0.2.pyc │ └── testutils.cpython-313.pyc ├── conftest.py ├── test_aboutdialog.py ├── test_calculation.py ├── test_constraint.py ├── test_datasetpanels.py ├── test_dopingseriespanel.py ├── test_extendedplotframe.py ├── test_fitdataset.py ├── test_fitstructure.py ├── test_insertrowsdialog.py ├── test_loadproject.py ├── test_mainframe.py ├── test_parameter.py ├── test_parameterspanel.py ├── test_pdfdataset.py ├── test_pdfguicontrol.py ├── test_pdfstructure.py ├── test_phaseconfigurepanel.py ├── test_showphasenotebookpanel.py ├── test_structureviewer.py ├── test_temperatureseriespanel.py ├── test_version.py ├── testdata │ ├── 300K.gr │ ├── 550K.gr │ ├── CdSe_bulk_wur.stru │ ├── LaMnO3.stru │ ├── Ni.dat │ ├── Ni.stru │ ├── Ni_2-8.chi.gr │ ├── lcmo.ddp │ ├── lcmo_00.gr │ ├── lcmo_20.gr │ ├── lcmo_full.ddp │ └── ni.ddp └── testutils.py 41 directories, 492 files