Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Some of the subdirectories in the ACME code contain code that was brought in from another repository.  List them all.

...

  • external any subdirectory in ACME whose entire content is from another repository
  • upstream master  the repository everyone is sending their changes to.  Only one so that everyone pulling from the same source is working with all the same changes.   The source of an external.

Methods for including externals

  • submodule  a link that points to another git repository.  See Sharing External Code using Git Submodules . Submodules require an extra step after cloning to get the code.
  • subtree a set of files and commits from another git repo, brought in to your repo.  See Sharing External Code using Git Subtree.  Subtrees are included in ACME when you "git clone".
  • monorepo adding multiple projects, related or not, in the same repo.  Code is included when you clone ACME.
  • buildtime  the repo is checked out to the $CIME_OUTPUT_ROOT/$CASE/bld when compiling a case for the first time.  Code does not exist in ACME repo.

Rules for adding externals

...

NameSubdirectory in ACMEexternal methodupstream masterdevelopment methodPOCNotes
CIMEcimesubtreehttps://github.com/ESMCI/cime

2-way


MCTcime/externals/MCTsubtreehttps://github.com/MCSclimate/MCT

mostly 1-way

usually brought in with CIME
PIOcime/externals/pio*subtreehttps://github.com/NCAR/ParallelIO

mostly 1-way

usually brought in with CIME
MPAS-Ocean

components/mpas-o/model

submodule

https://github.com/MPAS-Dev/MPAS forked to https://github.com/ACME-Climate/MPAS

strict 1-way
MPAS-Land Ice

components/mpasli/model

submodulehttps://github.com/MPAS-Dev/MPAS forked tohttps://github.com/ACME-Climate/MPASstrict 1-wayMatt Hoffman
MPAS-Sea Ice

components/mpas-cice/model

submodulehttps://github.com/MPAS-Dev/MPAS forked tohttps://github.com/ACME-Climate/MPAS branch cice/developstrict 1-way
FATES

components/clm/src/external_models/fates

submodule

https://github.com/NGEET/fates forked to https://github.com/ACME-Climate/fates

strict 1-way
MPP

components/clm/src/external_models/mpp

submodulehttps://github.com/ACME-Climate/mpp branch alm/developstrict 1-wayGautam Bisht
HOMMEcomponents/hommemonorepoNANAMark TaylorACME CAM uses

homme/src/share and homme/src/preqx

CVMixNAbuildtimehttps://github.com/CVMix/CVMix-srcstrict 1-way?After case.build, can be found in

$EXEROOT/ocn/source/core_ocean/.cvmix_all

ocean BGCNAbuildtimehttps://github.com/ACME-Climate/Ocean-BGCstrict 1-way?After case.build, can be found in

$EXEROOT/ocn/source/core_ocean/.BGC_all

...