CosmoStat / wf-psf

Data-driven wavefront-based PSF modelling framework.
MIT License
19 stars 9 forks source link

Restructure the repository by modularising the code (i.e. place independent elements into their own package or module) #42

Closed jeipollack closed 1 year ago

jeipollack commented 1 year ago

Here's a brief rough sketch of the new tree structure for the repo:

wf-psf
├── ci
├── data
├── docs
├── scripts 
│   └── wf-psf.py
├── setup.py --> in the future, this will change to pyproject.toml metadata file
└── wf_psf
    ├── config
    │   ├── config.yaml
    │   ├── eval_config.yaml
    │   ├── plot_config.yaml
    │   └── train_config.yaml
    ├── eval
    │   └── metrics.py
    ├── plot
    │   └── plot_utils.py
    ├── psf_models
    │   ├── model.py
    │   ├── model_1.py
    │   └── model_n.py
    ├── run.py
    ├── tests
    │   └── python
    │       └── train_test.py
    ├── train
    │   └── train.py
    └── utils
        └── io.py

Comments suggestions are welcome.

To implement this involves the following subtasks:

let me know if I missed something or you have other ideas to add to the list.

jeipollack commented 1 year ago

The above subtasks are for geared at modularising the code. Documentation and setting up continuous integration/continuous delivery can be discussed in another issue.

jeipollack commented 1 year ago

subtasks completed