Reorganising the code

[saroele]

I'll reorganise our code based on the redefined scope as shown here:

It means we'll have the following submodules in opengrid:

• library
• recipes
• notebooks
• tests
• (documentation) (this is not a python module)

The library will have submodules as shown in the graph. For the other modules I don't think this is necessary as of now.

It also means that we'll extend the website repository with the solutions for scheduling recipes. Maybe other specific repos will have to be created, we'll do that if need be.

I'll create a branch for this issue. When this is done, we can move to packaging of opengrid (#70).

[saroele]

I have created a new folder structure in branch issue76_reorganisation. (https://github.com/opengridcc/opengrid/tree/issue76_reorganisation)

The python module opengrid gets a specific folder, as inspired by this blogpost and this blogpost.

Both posts also suggest to put the tests inside the python module. I also created a submodule config for config.py and the related configuration files (passfiles, opengrid.cfg). So what is still outside of the python module are the documentation and notebooks folders.

The only notebooks I checked so far are the Demo_config and Demo_Houseprint notebooks. Next steps: clean out the notebooks folder: delete obsolete notebooks and make sure the others are working. Also, create a first set of recipes based on the library functions and by transferring some code out of the notebooks and into the library or recipes.

[saroele]

I already merged the new structure in develop. Let's keep this issue open until the structure is really finalised.

One thing we may still change is the location of tests: after all, I may prefer to include the tests next to the source files instead of in a separate folder. It's easier during development to have the code and the test next to each other in the same folder.

[saroele]

Added a separate issue for testing, see #79

[saroele]

Before closing this issue, I propose to adapt the scheme to the actual structure and put it somewhere in the source (and in the wiki).

[saroele]

I'm unable to push a commit with two svg files. I get strange git errors, never seen such a thing. Here are the files, as pdf. Maybe I have more luck tomorrow with these svg files. @rubenbaetens maybe you can have a look if these schemes are useful and informative? tnx

OG_BuildingBlocks.pdf OG_DeveloperOverview.pdf

[saroele]

hm, the issue was caused by a computer switch. Everything ok now, svg file pushed to develop branch.

[saroele]

Last meeting we discussed that we need some more structure in the notebooks section. We started a cleanup operation, and I'll reorganize this folder today. So be careful to pull the last version of the develop branch before doing anything else.