Watts-Lab / team-process-map

MIT License
0 stars 4 forks source link

Restructure the Repository #228

Open xehu opened 1 month ago

xehu commented 1 month ago

As we clean up the repository into its final form, we should consider restructuring the repository in a more standard way --- conforming to other Python package set-ups --- and to maintain a modular structure in case we want to expand the package in the future.

Below is a proposed structure for the repository:

team-process-map
├── LICENSE
├── README.md
├── docs
│  ├── conf.py
│  └── index.rst
├── examples
│  └── notebooks.ipynb
├── pyproject.toml
├── requirements.txt
├── src
│  ├── new_package
│  │  ├── __init__.py
│  │  └── new_module.py
│  └── team_process_map
│    ├── __init__.py
│    ├── data_processing.py
│    └── visualization.py
└── tests
  ├── __init__.py
  ├── test_data_processing.py
  ├── test_new_module.py
  └── test_visualization.py

The main changes would be: