RFC: Restructure repository
Fixes #78 (closed)
I did some additional (big) restructuring of the repository, which should be hopefully the last one before we release 1.0. If you want to check the structure it probably makes sense to not look at the difference but checkout the branch directly. Please also take a look at the structure of the docs. I mainly worked on the File structure and the Docs.
File structure
There are now mainly three folders
- modules
- core
- lib
modules
Contains the classes for the analysis. All functions have been moved to lib. I also renamed epsilon.py to dielectric.py and also its modules to DielectricPlanar and DielectricCylinder to be consistent with DielectricSpectrum.
core
Contains base classes for building the modules split into three files: base
, planar
, cylinder
lib
Contains additional functions. The folders contains math
for functions like fourier trafo, weights
for the weighting functions, tables
for the tables and util
everything else.
Docs
The docs now contain an additional entry for the api reference which is what is provided by core and lib. I also fixed the issue that parameters of the classes are not shown.
TODOs
-
doc generation still generates many warnings -
fix the tests
I apologize for the commit mess. I started with the work before we merged the last two commits. However, when we squash merge the whole thing is will be okay.