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.

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

Removing duplicate files #99

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ksbeattie
Copy link
Member

@ksbeattie ksbeattie commented Mar 29, 2024

Remove duplicate files

Addresses #83 which points out that we have duplicate logo.png files in the repo, bloating the released package.

I found a tool (fdupes) that will find duplicate files (via size and MD5 checksum) under a dir. So I ran it and found a few more than mention in the above PR. Specifically:

$ fdupes -r .
./idaes_examples/notebooks/docs/surrogates/pysmo_rbf_surrogate.json
./idaes_examples/notebooks/docs/surrogates/pysmo/pysmo_rbf_surrogate.json

./idaes_examples/notebooks/docs/surrogates/AR_PFD.png
./idaes_examples/notebooks/docs/surrogates/pysmo/AR_PFD.png

./idaes_examples/notebooks/_dev/notebooks/logo.png
./idaes_examples/notebooks/docs/tut/ui/idaes-logo.png
./idaes_examples/notebooks/logo.png

./idaes_examples/notebooks/references.bib
./idaes_examples/notebooks/_dev/notebooks/references.bib

./idaes_examples/archive/ripe/sv.alm
./idaes_examples/archive/ripe/temp.alm

./idaes_examples/archive/dmf/data_management_framework.ipynb
./idaes_examples/archive/dmf/my_workspace/files/928385c3acda4a449412c5bfbbaa83b5/data_management_framework.ipynb

./idaes_examples/archive/power_gen/supercritical/supercritical_steam_cycle.svg
./idaes_examples/notebooks/docs/power_gen/supercritical/supercritical_steam_cycle.svg

./idaes_examples/archive/data_reconciliation/Boiler_scpc_PFD.svg
./idaes_examples/archive/power_gen/supercritical/Boiler_scpc_PFD.svg
./idaes_examples/notebooks/docs/power_gen/supercritical/Boiler_scpc_PFD.svg

Several other files were also found, like empty __init__.py files and notebooks, but I'd removed those from the above list, leaving ones that looked like they could be cleaned up.

This is my attempt at cleaning them up, first by simply removing 2 of the logo.png dupes and seeing what the CI says about that.


Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

📚 Documentation preview 📚: https://idaes-examples--99.org.readthedocs.build/en/99/

@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Mar 29, 2024
@ksbeattie ksbeattie self-assigned this Mar 29, 2024
@lbianchi-lbl lbianchi-lbl self-requested a review April 4, 2024 18:31
@lbianchi-lbl
Copy link
Contributor

  • In general I think this is a very good idea, and we should check for duplicate files either regularly (as part of the CI) or periodically
  • We should wait until the CI is fully functional again and make sure we're able to detect missing/broken links before merging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants