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

Infrastructure to publish data files as PyPI package #21

Merged
merged 5 commits into from
May 23, 2023

Conversation

JostMigenda
Copy link
Contributor

This PR contains the basic infrastructure to publish a package with the SNOwGLoBES data files (detector_configurations.dat and the directories channels/, effic/, smear/ and xscns/) to PyPI.

This makes it easier to reuse these files. For example, in SNEWPY users currently need to manually download SNOwGLoBES and specify the SNOwGLoBES directory in every function call (or set the environment variable). With this PR and the corresponding changes to SNEWPY, this would all be handled automatically by the package manager.

As you can this in this PR, no changes to existing SNOwGLoBES code, files or directory structure is required. The additions are in a single snowglobes_data/ directory; simply run the setup.sh script in there to generate the package.
In a future commit, I can add a GitHub workflow which automatically generates the package and uploads it to PyPI whenever a new SNOwGLoBES version is tagged.

@JostMigenda JostMigenda marked this pull request as ready for review May 23, 2023 18:00
@JostMigenda JostMigenda merged commit a8edf3a into SNOwGLoBES:master May 23, 2023
@JostMigenda JostMigenda deleted the pythonPackaging branch April 30, 2024 16:16
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 this pull request may close these issues.

1 participant