Reorganize files and directories

[nkoukpaizan]

It would be good to reorganize the repository. This would keep the root directory cleaner. A few suggestions:

• Move header files that are currently in the root directory, e.g. ModelEvaluator.hpp and CircuitGraph.hpp, to appropriate sub-directories.
• Move all GridKit library source folders, e.g. ComponentLib and Solver, to a Src, GridKit directory or something similar. A natural separation would be that everything in the Gridkit:: namespace be in this directory.

Let's start a discussion on this. Others may have more suggestions. cc @shakedregev @reid-g @alexander-novo

[pelesh]

I suggest following directory structure structure (and using lowercase for dir names):

+-+-- buildsystem
  +-- cmake
  +-- docs
  +-- examples
  +-- src +-+
  |         +-- models +-+
  |         |            +-- phasordynamics +
  |         |            |                  +-- README.md
  |         |            |                  +-- ModelEvaluatorPhasor.hpp
  |         |            |                  +-- branch
  |         |            |                  +-- bus
  |         |            |                  ...
  |         |            +-- emt +
  |         |            |       +-- README.md
  |         |            |       +-- ModelEvaluatorEmt.hpp
  |         |            |       +-- node
  |         |            |       +-- resistor
  |         |            |       ...
  |         |            +-- powerflow
  |         |            +-- powerelectronics
  |         |            +-- dynopt
  |         +-- composer +-+
  |         |              +-- sparsematrix
  |         +-- solvers
  |         +-- utils
  +-- tests +-+
              +-- functionality
              +-- unit

Model evaluators and system models are moved to the directory where related component models reside.

Suggestions?

CC @abirchfield @shakedregev @reid-g @alexander-novo

[shakedregev]

This looks good

[reid-g]

Sparse matrix should be independent of the models so that can go into utils.

I am not sure on having a separate directory for composers. Perhaps keep composers in the model directory for their respective system?

Otherwise, looks good to me.

[pelesh]

Sparse matrix should be independent of the models so that can go into utils.

I am not sure on having a separate directory for composers. Perhaps keep composers in the model directory for their respective system?

Otherwise, looks good to me.

I also thought composers could be placed in the same dir with the respective component library. I think utils is typically used for error handling, options setting, I/O parsers, etc. Perhaps we could have linalg directory for numerical linear algebra functions?