ModelComponent Class

[Tjalling-dejong]

Issue addressed

Fixes #671

Explanation

Creating a model component subclass for grid model first. The idea is to make a general ModelComponent class that will replace the different model classess with subclasses of ModelComponent.

Checklist

• Updated tests or added new tests
• Branch is up to date with main
• Tests & pre-commit hooks pass
• Updated documentation if needed
• Updated changelog.rst if needed
• For predefined catalogs: update the catalog version in the file itself, the references in data/predefined_catalogs.yml, and the changelog in data/changelog.rst

Additional Notes (optional)

Add any additional notes or information that may be helpful.

[savente93]

Looking good Tjalling. I think this is nice for a first try and we'll see about polishing some things when we start integrating it with the rest and moving over tests.

[hboisgon]

Hi @Tjalling-dejong , very nice first implementation of the Grid ModelComponent!
I think it's almost ready, I just added a few answers to Sam and asked to rename the setup methods but for the rest almost ready to merge I think :)
Just one thing, but before you merge, I think we don't need the v1 folder and maybe rename grid.py script to grid_component.py

[DirkEilander]

Some quick suggestions:

• we need to initialize a component with the model rather than just root to be able to acces the model region, data catalog, etc.. Using a model property that calls the weak_ref to model we can avoid circular dependencies, see also discussion New `ModelComponent` class #636
• it would be good to keep the 'just in time reading' we have currently. This is achieved by creating a data property which calls _initialize_data if _data is None. In most other methods we can than simply use data rather than _data, see also current implementation for grid, maps, geoms, etc.
• Both the model and data properties should land in the generic ModelComponent class

[hboisgon]

Almost there @Tjalling-dejong ! Just a few minor suggestions before this is finalized and can be merged :)

After this PR it would be good to harmonise and finalise the link of GridComponent to ModelRegionComponent and to update and link GridComponent to Model so that we can create gridded models again.

[savente93]

I broadly agree with Hélène's comments so once you resolve those I'm happy for it to be merged. Nearly there!

[deltamarnix]

Good busy! Looks like a solid PR. I assume we can get those tests up and running as soon as the Model class is also ready.

[hboisgon]

Great work @Tjalling-dejong ! Looking good now :)
I still have a couple of very little comments but at the level of for example an argument that you forgot to remove from the docstrings. So would be great if you could still update before merging. But I approve already as they are quite minor.
Great job!