Make cap a submodule to SCHISM

[platipodium]

Dan Rosen and Arun Chawla recommended to move the cap to within SCHISM, as a submodule

[platipodium]

Joseph does not really favour git submodules in SCHISM, and Carsten does not favour including the code hard into SCHISM as subdirectory ... so maybe just leave as is?

[jreniel]

Maybe what you want is a git subrepo?

Recap:

• git submodules are used when you don't want to explicitly include the code (for example, optional helper functionality).
• git subtrees can be used when you want explicitly add another repo's code to your code, but only works well if you don't plan to push back to the parent (this could be your case).
• git subrepo can be used for 2-way push pull, and clones the code explicitly.

Git subrepo is the "newest" of the three. It definitely replaces git subtrees (which doesn't cleanly allow for 2 way comm between the repos) but submodules still have their purpose, when you want to include links to another code base, rather than the codebase itself.

Hope this helps.

[EDIT]: I strongly advice against subtrees, because your commit history will get messed up if you push from the subtree to the parent. If others have subtree cloned the repo, they'll get your history too. It's a mess if it's not going to be used for one-way only (e.g. schism repo pulling from cap repo is OK, but schism repo pushig to cap repo is bad). git subrepo fixes this problem.

[jreniel]

I've been using git subrepo and I highly recommend it. Git subtree was working well, until I tried 2-way push/pull. That's what took me to git subrepo, which finally solved the problem of 2-way comm between repos.

[platipodium]

Thanks @jreniel. I have not looked into git subrepo but would go with your recommendation. If SCHISM is s subrepo of schism-esmf (which is more logical), we can just go ahead, but if schism-esmf is a submodule of schism (which is what the community usually does), @josephzhang8 has to decide in the end.

[platipodium]

git-subrepo is a separate piece of software, so not many users will have it installed...

[jreniel]

You can make it either ways or even technically (maybe nonsensical), both.
Each repo has their own build system, therefore, their own system tree to look for.

git-subrepo works without the end users having it installed, this is explicitly stated in the readme.md.

You can always test these things in your own workspace and explore the result without necessarily pushing.
After installing subrepo, simply do git subrepo clone git@github.com:schism-dev/schism in your schism-esmf repo.
You can do this on another branch or you can revert: git reset HEAD~1 ... Or you can even copy your workdir and try on a different dir. Either way, it will result in an opening of your options...

[jreniel]

To give you an example, git subtree also works without the users having it installed. One example is jigsaw-python which includes ext/jigsaw as a subtree. The users don't know this is a subtree, and don't need git-subtree installed. The same happens with git subrepo, (but not so much with git submodules, which kind-of requires to have submodules in PATH).

[jreniel]

Having given it some thought, I think in your case it makes more sense that schism-esmf integrates schism as a subrepo, rather than the other way around. The "child" module integrating the parent module will make more sense in the long-run. Otherwise, in a sense, you'd be handing off the maintenance of your package to the parent, which doesn't make a lot of sense.

This is similar to how jigsaw-python integrates jigsaw, rather than the other way around.

[josephzhang8]

You mentioned one does not need to install subrepo but later implied we do. Regards, ------------------------------- Joseph Zhang (804)684 7595 (office) SCHISM web: http://ccrm.vims.edu/schism/ From: Jaime R Calzada ***@***.***> Sent: Thursday, March 2, 2023 5:46 PM To: schism-dev/schism-esmf ***@***.***> Cc: Y. Joseph Zhang ***@***.***>; Mention ***@***.***> Subject: Re: [schism-dev/schism-esmf] Make cap a submodule to SCHISM (Issue #23) [EXTERNAL to VIMS received message] Having given it some thought, I think in your case it makes more sense that schism-esmf integrates schism as a subrepo, rather than the other way around. The "child" module integrating the parent module will make more sense in the long-run. Otherwise, in a sense, you'd be handing off the maintenance of your package to the parent, which doesn't make a lot of sense. - Reply to this email directly, view it on GitHub<https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fschism-dev%2Fschism-esmf%2Fissues%2F23%23issuecomment-1452668059&data=05%7C01%7Cyjzhang%40vims.edu%7C6fdf3dc4fa4b4c9046c908db1b6fe6e2%7C8cbcddd9588d4e3b9c1e2367dbdf1740%7C0%7C0%7C638133939663328342%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=LHzqgeCL6HYBG9%2BbS2ltL1ZumUo7NUxXNU786zSKPo0%3D&reserved=0>, or unsubscribe<https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAFBKNZYQP4O6F4RRG25G4GTW2EPKVANCNFSM6AAAAAAVNZH2II&data=05%7C01%7Cyjzhang%40vims.edu%7C6fdf3dc4fa4b4c9046c908db1b6fe6e2%7C8cbcddd9588d4e3b9c1e2367dbdf1740%7C0%7C0%7C638133939663328342%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=eF9CIZg1P2%2Fg7KCam2DBLLg7DG6ncn%2FbpTfV54UFD4A%3D&reserved=0>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

[josephzhang8]

I tried and it did not recognize 'subrepo' Regards, ------------------------------- Joseph Zhang (804)684 7595 (office) SCHISM web: http://ccrm.vims.edu/schism/ From: Y. Joseph Zhang Sent: Thursday, March 2, 2023 6:19 PM To: schism-dev/schism-esmf ***@***.***>; schism-dev/schism-esmf ***@***.***> Cc: Mention ***@***.***> Subject: RE: [schism-dev/schism-esmf] Make cap a submodule to SCHISM (Issue #23) You mentioned one does not need to install subrepo but later implied we do. Regards, ------------------------------- Joseph Zhang (804)684 7595 (office) SCHISM web: http://ccrm.vims.edu/schism/ From: Jaime R Calzada ***@***.******@***.***>> Sent: Thursday, March 2, 2023 5:46 PM To: schism-dev/schism-esmf ***@***.******@***.***>> Cc: Y. Joseph Zhang ***@***.******@***.***>>; Mention ***@***.******@***.***>> Subject: Re: [schism-dev/schism-esmf] Make cap a submodule to SCHISM (Issue #23) [EXTERNAL to VIMS received message] Having given it some thought, I think in your case it makes more sense that schism-esmf integrates schism as a subrepo, rather than the other way around. The "child" module integrating the parent module will make more sense in the long-run. Otherwise, in a sense, you'd be handing off the maintenance of your package to the parent, which doesn't make a lot of sense. - Reply to this email directly, view it on GitHub<https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fschism-dev%2Fschism-esmf%2Fissues%2F23%23issuecomment-1452668059&data=05%7C01%7Cyjzhang%40vims.edu%7C6fdf3dc4fa4b4c9046c908db1b6fe6e2%7C8cbcddd9588d4e3b9c1e2367dbdf1740%7C0%7C0%7C638133939663328342%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=LHzqgeCL6HYBG9%2BbS2ltL1ZumUo7NUxXNU786zSKPo0%3D&reserved=0>, or unsubscribe<https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAFBKNZYQP4O6F4RRG25G4GTW2EPKVANCNFSM6AAAAAAVNZH2II&data=05%7C01%7Cyjzhang%40vims.edu%7C6fdf3dc4fa4b4c9046c908db1b6fe6e2%7C8cbcddd9588d4e3b9c1e2367dbdf1740%7C0%7C0%7C638133939663328342%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=eF9CIZg1P2%2Fg7KCam2DBLLg7DG6ncn%2FbpTfV54UFD4A%3D&reserved=0>. You are receiving this because you were mentioned.Message ID: ***@***.******@***.***>>

[jreniel]

The projects maintainer (the person doing the subrepo adding) needs to install it. But once the surepo has be initialized, anyone that clones the repo does not need it installed. Plz read carefully the subrepo docs. It really does solve your problem.

[jreniel]

(It is also trivial to install it)
https://github.com/ingydotnet/git-subrepo#installation

[jreniel]

In this case, Carsten would be the only one needing to do the subrepo install, no one else would need to install it, not even the SCHISM repo. Subrepo does not interfere with the parent, which is the problem with subtree, that can interfere with the parent/siblings if more there's 3-way push/pull. Subtree only work well in 1-way mode, which would still be valid for Carsten's case, however I'm sure he'd prefer a "clean 2-way mode", which is what subrepo provides and subtree lacks.

Anyone cloning schism-esmf also would not need it installed, just the people doing the direct maintenance on the subrepo itself would need to install it.