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 repo #85

Open
max-radin opened this issue Dec 16, 2024 · 0 comments
Open

Reorganize repo #85

max-radin opened this issue Dec 16, 2024 · 0 comments

Comments

@max-radin
Copy link
Contributor

As discussed in the last GSEE meeting, we'd like to reorganize the directories to make content easier to access and maintain. In particular, we'd like to consolidate some of the top level directories and move the bulk of the python code into the src directory so that it is part of a package.

  • The new high-level directory structure should like more or less like what was discussed at the meeting (shown below).
  • Most of the business logic should be moved to src so that it is part of the python package. Ideally the scripts themselves will be short python files that just parse command-line arguments and then just call a few functions from the package. The one exception is code that is specific to an example solver, which can live in the appropriate subdirectory of examples.
  • We should make sure that the scripts still work after the migration, and in particular check if any paths need to be updated.
  • We should also make sure to update any paths that appear in README files.
  • We should avoid scope creep in this reorganization. The intention is just to move things into sensible directories, not to write a bunch of code.
qb-gsee-benchmark
├── data
│   ├── solutions
│   ├── problems_instance
│   ├── performance_metrics
│   ├── json_files_with_errors
│   └── features
├── schemas
├── examples
│   ├── dmrg_2024
│   ├── df_qpe_2024
│   └── performance_analysis
├── src
├── scripts
└── tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant