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

Remove outdated images in wrong folder #1407

Open
lucasverleyen opened this issue Jan 10, 2025 · 3 comments · May be fixed by #1409 or #1429
Open

Remove outdated images in wrong folder #1407

lucasverleyen opened this issue Jan 10, 2025 · 3 comments · May be fixed by #1409 or #1429
Assignees
Milestone

Comments

@lucasverleyen
Copy link
Member

All images used in the IDEAS Modelica package are stored in IDEAS/IDEAS/Resources/Images. However, there is a folder IDEAS/IDEAS/Images with some images from equations. I checked and I don't find links to that folder, so I guess these images are not used anymore?

@jelgerjansen, can you check as well? If so, I suggest removing that folder.

@lucasverleyen lucasverleyen self-assigned this Jan 10, 2025
@jelgerjansen
Copy link
Contributor

@lucasverleyen these can indeed be removed (these equation images were added 14 years ago and used in the documentation back then).

I think it would be good to extend this issue to move/remove a couple of files, e.g.

  • IDEAS/bin/runUnitTests.py: we run the unit tests in a different way nowadays
  • IDEAS/IDEAS/ConvertFromIDEAS_2.mos: currently empty and if used, it should be moved to IDEAS/IDEAS/Scripts/Conversion
  • IDEAS/IDEAS/Scripts: files related to LIDEAS unit testing (not included in unit testing right now)
  • IDEAS/IDEAS/Resources/LIDEAS: files related to unit testing of LIDEAS (not included in unit testing right now)
  • IDEAS/IDEAS/UsersGuide: consider directly including in IDEAS/IDEAS/package.mo (as is done in IBPSA)

@lucasverleyen lucasverleyen linked a pull request Jan 14, 2025 that will close this issue
@lucasverleyen
Copy link
Member Author

lucasverleyen commented Jan 14, 2025

@lucasverleyen these can indeed be removed (these equation images were added 14 years ago and used in the documentation back then).

I have removed the files and created a pull request.

I think it would be good to extend this issue to move/remove a couple of files, e.g.

Perfect, good idea!

  • IDEAS/bin/runUnitTests.py: we run the unit tests in a different way nowadays

Are you sure? There is a runUnitTests.py file in Buildings, IBPSA, MoPED... I am not fully up to date with our unit testing, so I need to take a more detailed look to decide on that.

  • IDEAS/IDEAS/ConvertFromIDEAS_2.mos: currently empty and if used, it should be moved to IDEAS/IDEAS/Scripts/Conversion

I suggest removing it. It's empty, and if we need a script in the future, we can make one at the right location.

  • IDEAS/IDEAS/Scripts: files related to LIDEAS unit testing (not included in unit testing right now)
  • IDEAS/IDEAS/Resources/LIDEAS: files related to unit testing of LIDEAS (not included in unit testing right now)

So, including LIDEAS in the unit testing and moving all required scripts to the appropriate folder?

  • IDEAS/IDEAS/UsersGuide: consider directly including in IDEAS/IDEAS/package.mo (as is done in IBPSA)

For me, it is fine to keep it as a separate file, but no strong opinion.

@lucasverleyen lucasverleyen added this to the Release 3.x milestone Jan 14, 2025
@lucasverleyen
Copy link
Member Author

@jelgerjansen small update on my previous comment. By coincidence, I noticed that the separate file means that the user's guide is not shown if you open the package, in contrast to e.g. modelica standard library, buildings, ... So, I agree with including the user's guide in the main package

@lucasverleyen lucasverleyen linked a pull request Mar 11, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants