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

Put model files in a separate repository #250

Closed
Sheshuk opened this issue May 26, 2023 · 1 comment · Fixed by #274
Closed

Put model files in a separate repository #250

Sheshuk opened this issue May 26, 2023 · 1 comment · Fixed by #274
Labels
ModelRegistry Connected to the registry of models suggestion An idea that needs to be discussed/approved before starting implementaion

Comments

@Sheshuk
Copy link
Contributor

Sheshuk commented May 26, 2023

Right now all the model data files are bundled in this repository, despite the new model registry functionality, which allows us to put them elsewhere.

As I suggested in #238 we can move out all the model files to a separate repository snewpy_models, and manage them there.

Advantages:

  1. Cut new release of the snewpy_models when the data is changed, without having to wait for snewpy release.
  2. snewpy repository will become very lightweight (no need to download all the models during the checkout, for example if you want to work on a specific feature, implement an interface to a new model etc.)
  3. We can create Zenodo entries for the snewpy_models, and direct the downloader there, if needed.

I think it can be done quite fast and simple.
I implemented #247 to avoid hardcoding the repository path, and use any provided URL, so it should be easy to point to the new snewpy_models repo.

@Sheshuk Sheshuk added suggestion An idea that needs to be discussed/approved before starting implementaion ModelRegistry Connected to the registry of models labels May 26, 2023
@JostMigenda
Copy link
Member

I’ve created https://github.com/SNEWS2/snewpy-models-ccsn/ and added a model file that I’m going to use to implement #160. I’ll see what the workflow is like with this separate repo and think about how to automate some steps, especially around version tagging & snewpy releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ModelRegistry Connected to the registry of models suggestion An idea that needs to be discussed/approved before starting implementaion
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants