Python Project structure [Draft] - AAU-Dat/P5-Nonlinear-Dimensionality-Reduction GitHub Wiki

Overview: P5:

---jupyter notebooks

---report

---src

---test

---req.txt

---Readme

The file structure for this project is taken with inspiration from {https://docs.python-guide.org/writing/structure/}. With regards to the file structure the group has chosen to have a source (src) folder, which contains the code for the pipeline. The source files are considered modules, and the group has tried to made the code modular, which makes the code easier to read.

The report folder is mainly for documentation of the process of the project that the group has chosen. It contains the tex files as well as the report for the project, named "main.pdf" (found in out directory).

The group has decided to have a testing folder where tests are made for the source files in order to fulfill the functional requirements of the various functions. The tests are also used to ensure that new features do not break the overall functionality of the pipeline in the cases the were tested against.

The src- and testing folder have an init.py file, which . In that way, the modules that are in the respective packages can be used interchangebly.

Likewise, if anyone is interested in using and/or contributing to the project, a requirements text file is provided, which contains the list of python package dependencies needed that the pipeline depends on.

[Would be nice to have a MIT license explicitly]