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

Split scripts into separate repository #31

Closed
BenjaminStuermer opened this issue Dec 22, 2020 · 3 comments
Closed

Split scripts into separate repository #31

BenjaminStuermer opened this issue Dec 22, 2020 · 3 comments
Assignees

Comments

@BenjaminStuermer
Copy link
Collaborator

I have proposed splitting this project into two separate repositories:

  • The DIYEPW Python package, which would contain everything in the current repository's lib/diyepw/ directory.
  • The DIYEPW Script toolkit, which would contain everything else currently in the repository.

The expected convention for a repository containing a Python package is that the package itself makes up the entire contents of a repository. The scripts and associated input files are not part of the package - they were specifically requested to be written as command-line tools, which means a user interacts with them in a fundamentally different way than with package code.

If we split them, users who are interested in using the prepared command-line scripts can clone the appropriate repository, and users who are interested in embedding DIYEPW capabilities into their own Python scripts can install the package. If they remain in the same repository, then we have an odd situation where users who want the command-line scripts also have to download the entire package code, even though they should be installing it via a package manager rather than locally.

I'd like to make sure all three of us are on board with this solution (or some alternative) before I proceed, since it's a fairly substantial change to the project.

@amandadsmith
Copy link

amandadsmith commented Dec 23, 2020

I support this split. I think the fairly substantial changes have been made and hopefully this helps us keep things clean & organized for each of the two possible audiences (of which I am probably the rare crossover).

@crvernon may have concerns we haven't thought of, or can create the new repo if we're all in agreement.

@crvernon
Copy link
Contributor

I agree with this as well. Let's proceed. Thanks!

@BenjaminStuermer
Copy link
Collaborator Author

The scripts have been relocated to https://github.com/IMMM-SFA/diyepw-scripts. In the process, I have removed the inputs that were previously included with the scripts, and have added instructions for downloading them from the NOAA website. I intend to add a script later that lets you specify a set of WMOs and years and download ISD Lite files into a directory of your choice for use in the original step-by-step workflow.

@amandadsmith Please take a look at the README in the new repository and let me know if you see anything that is missing.

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

3 participants