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

Make SIMIO a standalone Python package #13

Closed
jeffjennings opened this issue Feb 10, 2023 · 2 comments
Closed

Make SIMIO a standalone Python package #13

jeffjennings opened this issue Feb 10, 2023 · 2 comments

Comments

@jeffjennings
Copy link

jeffjennings commented Feb 10, 2023

As part of the JOSS review, I appreciate the code is designed to serve as executable functions inside CASA, and I know this would be a bit of a larger effort, but I think it would be highly beneficial if the code were also available as a standalone Python package (on PyPI and thus installable by pip).

The only major addition to the code's core routines would be a method to interface with measurement sets; you could model this after existing packages (or just make them dependencies and import them) such as uvplot and visread. This would also allow users to use the code with modular CASA (e.g., as is done with PRIISM).

This would also allow you to easily integrate things like tests for the code's core routines, automating processes such as the manual tests described in the docs. This would better address the JOSS review guideline Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?.

As a bit of a bigger change (though one that I think would be very useful for users of SIMIO and for code contributors!), this is just a suggestion.

openjournals/joss-reviews#4942

@nicokurtovic
Copy link
Owner

Hi Jeff, thanks for the suggestion.

I have been thinking a lot about this, and at least for this version I would prefer to keep it as an executable. The initial inspiration for the code structure was the hydro-code FARGO 3D, where you work inside the FARGO folder and you can save your setups individually. My thought was to have something similar to FARGO, where you would only need to download SIMIO, and then save the templates and projects individually in a self-contained folder.

I think since the last CASA 6.X versions, CASA tasks can also be called from the python terminal (example), and so a future SIMIO package could be fully integrated in python, but for the current SIMIO I would prefer to keep the folder structure, if possible.

@jeffjennings
Copy link
Author

Ok, I appreciate you thinking about this. I think ultimately it would benefit users and maintainers of SIMIO if the package is fully self-contained, but the design choice is yours. I added a suggestion about making the nature of SIMIO a bit more clear in the paper in my comment in #3. I'm happy to close this issue otherwise.

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

No branches or pull requests

2 participants