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

Reorganize repository based on current plans #57

Open
damonbayer opened this issue Oct 16, 2024 · 3 comments
Open

Reorganize repository based on current plans #57

damonbayer opened this issue Oct 16, 2024 · 3 comments

Comments

@damonbayer
Copy link
Collaborator

There are a few issues with the current repo structure:

  1. Our NSSP model started as a "demo," hence the nssp_demo folder, but it is now the main offering of the repo.
  2. We are collecting a variety of other "demo" scripts, currently stored in the notebooks folder.

I would like to reorganize the repo to make things a bit more clear. I think I will have a better idea of how to do that once we have run things in azure.

@SamuelBrand1
Copy link
Collaborator

My 2p worth, and this might be better implemented over more than one repo:

Have a structure of:

  • tools: thats pyrenew-hew etc which do the analysis. This should be callable from projects in this repo.
  • projects: thats discrete projects we want to work on in the open e.g. nssp.
  • demos -> docs as vignettes.

@damonbayer
Copy link
Collaborator Author

damonbayer commented Oct 25, 2024

Current thinking:

  • pyrenew-hew: setup as a python library that has the PyRenew model(s)
  • utils_R: R utility scripts that can be sourced or could be set up as an R package
  • utils_py: Python utility scripts that can be imported.
  • pipeline: scripts related to running the pipeline
    • could be further separated into different pipeline folders if we have different pipelines
  • demos: vignettes / docs

@dylanhmorris
Copy link
Contributor

dylanhmorris commented Oct 25, 2024

Largely agree, but I think we can and should avoid import-able/source-able middle ground between pipeline scripts and packaged code. So I'd suggest the above except:

  • Bundle anything reused enough to be a utils_py into pyrenew-hew.utils
  • Any utils_R that don't belong in pipeline could be a micro-package called hewR or something

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