Skip to content

Commit e26916e

Browse files
tobeycarmantobeycarman
authored
Merge pull request #703 from uaf-arctic-eco-modeling/iss-701-sphinxdoc-paths
Change sphinx Example Experiment 0 to use demo data rather than data from the input catalog. This fixes a problem where users might not have the input catalog setup or might use a different name, which prevents them from easily being able to build the documentation (or automatically run the example code snippets). Instead this PR changes the organization so that the source data for the example experiment 0 is the from the `demo-data` folder which is available with all clones of the repository. Then, change paths so that the experiment 0 is stored in the `testing-data` rather than the general workflows location. This allows the whole run to be kept under version control and also allows the documentation examples (jupyter execute blocks) to run without waiting for the model to run.
2 parents 21821ef + 81074a8 commit e26916e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+281
-16
lines changed

‎docs_src/sphinx/source/examples_and_tutorials/basic_model_run.rst

Lines changed: 3 additions & 1 deletion

‎docs_src/sphinx/source/examples_and_tutorials/example_experiment_0.rst

Lines changed: 63 additions & 15 deletions

‎docs_src/sphinx/source/software_development_info.rst

Lines changed: 8 additions & 0 deletions

‎testing-data/docs/example_experiment_0/ALD_SAMPLE.png

Lines changed: 3 additions & 0 deletions

‎testing-data/docs/example_experiment_0/NEE_SAMPLE.png

Lines changed: 3 additions & 0 deletions

‎testing-data/docs/example_experiment_0/calibration/calibration_targets.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:8d0878a4ec9ad343c09575cb4d45a5784069c037675018672d1e431b5f859d58
3+
size 34242

‎testing-data/docs/example_experiment_0/config/calibration_directives.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:ae1da6c335b9c25a6024479c9b4c2404240ddbdeea0b9ed55ddca4c84dcdfa15
3+
size 473

‎testing-data/docs/example_experiment_0/config/config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:049b4adb49a37828386768c6a5623db1d988d80060613321f5efd310af00a83d
3+
size 2847

‎testing-data/docs/example_experiment_0/config/output_spec.csv

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:81b1a4742c955646054444d2b9b5784ff560eef3c6a292421176c8b65b4e6a11
3+
size 9014

‎testing-data/docs/example_experiment_0/output/ALD_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:84b4314cf762b9947a0eb7fa5822a7c59759fcf45a0435f4f76e6e1aed8d4ab4
3+
size 79706

‎testing-data/docs/example_experiment_0/output/ALD_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:e44b023e94ff5acaa949db6846705349a78f0bcb7f9f64d2d5376113d64abab5
3+
size 210956

‎testing-data/docs/example_experiment_0/output/ALD_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:ffa6687881f21184510fbd7f34595761a6469de8af0d10cb77e5c1860aecb16d
3+
size 103946

‎testing-data/docs/example_experiment_0/output/CMTNUM_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:2e53dbf336b0b1bf584eeecd0dc946d660c4d5f5cf4a3fd16df020798c1b7c5e
3+
size 45707

‎testing-data/docs/example_experiment_0/output/CMTNUM_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:a52f10c1cc850af405d1dfde1b22a377ea1a64f73edbc7ad31492e9482b066c2
3+
size 110891

‎testing-data/docs/example_experiment_0/output/CMTNUM_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:38a75eba4c2ee184d723d000bf92941290fb2a1f0ad559ffb6977c55afde13ec
3+
size 57947

‎testing-data/docs/example_experiment_0/output/DEEPC_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:b34ebf1911933c25a43d06c69833a746e13ab006360a92371ef52ca0762daf62
3+
size 79731

‎testing-data/docs/example_experiment_0/output/DEEPC_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:dcccac46b500d3037488ead332540d332a8396cc7d4e7b3e03b9d09eafc6e685
3+
size 210950

‎testing-data/docs/example_experiment_0/output/DEEPC_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:666b7e0ac596b255815337f6efff1d3be48040075d5ab751a9583536721eefa9
3+
size 103971

‎testing-data/docs/example_experiment_0/output/DEEPDZ_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:fdfb6e9f4974293758cb20462c0a286348ace41d23aea45e46cfa1ba1fbd88e9
3+
size 79745

‎testing-data/docs/example_experiment_0/output/DEEPDZ_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:f50fef52b0f91fd940325b294c35f193d2289c120b819eb6134e78492d95ff60
3+
size 210967

‎testing-data/docs/example_experiment_0/output/DEEPDZ_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:152ac87259ad056a22251aa7deddbff09abafc157fc522173435a70c21032a26
3+
size 103985

‎testing-data/docs/example_experiment_0/output/GPP_monthly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:cc92983616538c70013e56336b37db76f2160f417a8be6e6755b1b1eae14f947
3+
size 8179891

‎testing-data/docs/example_experiment_0/output/GPP_monthly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:5fd54fb01fabfd39e30442d926bd515f6c83ad7cf13a3113511ec359607654df
3+
size 24011654

‎testing-data/docs/example_experiment_0/output/GPP_monthly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:b52f2cca458eab718c27bd1a8ef19f8245d076baed07e96155f55c29cd03ddb5
3+
size 11062771

‎testing-data/docs/example_experiment_0/output/LAYERDEPTH_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:ddacba2c3cbcb905c858dee5f2bedc86d99d2013b2affae782c383188f3f4f8c
3+
size 1508463

‎testing-data/docs/example_experiment_0/output/LAYERDEPTH_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:44a06281c3ddd2e19ebb89aaa407fa341bd89fb0fbf7c042f0dd77d09f0332c8
3+
size 4411679

‎testing-data/docs/example_experiment_0/output/LAYERDEPTH_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:0a1f905f9c782f70268effb125eb737c319717a18d632e955805f37e99ef0202
3+
size 2036703

‎testing-data/docs/example_experiment_0/output/LAYERDZ_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:d149737459a55eb7c73324f8d4492a4bf385565b82b0416a0739578e39a95a1c
3+
size 1508451

‎testing-data/docs/example_experiment_0/output/LAYERDZ_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:918ea028cc05f28f4852a49fe49c5b7c1249453b436b3b3d195e47a82d7994de
3+
size 4411666

‎testing-data/docs/example_experiment_0/output/LAYERDZ_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:86f97df071f22128d2fa3be36762e4873f465a8e35afaf266f0ad0e68bdaa531
3+
size 2036691

‎testing-data/docs/example_experiment_0/output/LAYERTYPE_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:d2c0c24b19786e2ccafa79a9c9871d703b339670cea61265271272ad35b10936
3+
size 760490

‎testing-data/docs/example_experiment_0/output/LAYERTYPE_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:442766a961835f24a60e9e9a18c6ea89b5419dd1614612600a07474623c26333
3+
size 2211683

‎testing-data/docs/example_experiment_0/output/LAYERTYPE_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:7d7c457d032aea26e27455bf0b6316b6cd4084268a98fbc20edd335bc3173d2b
3+
size 1024730

‎testing-data/docs/example_experiment_0/output/MINEC_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:43018d96b4f88043827e1bc963b55a6d80c5a2dcfcbd9d2415eb98b43a48f502
3+
size 79729

‎testing-data/docs/example_experiment_0/output/MINEC_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:0b4735bc629b66606cf9063ac5319882d683c302f94160e1140843be60b37a64
3+
size 210948

‎testing-data/docs/example_experiment_0/output/MINEC_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:80f25a2bbad06e64354434b8f367e40c3742ed231cbad9bb42780cba291eada9
3+
size 103969

‎testing-data/docs/example_experiment_0/output/RG_monthly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:1d5325b230932ccf7fafac601cc91627a85dbf5ad86b0724eb8d2690d7815b0a
3+
size 835190

‎testing-data/docs/example_experiment_0/output/RG_monthly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:e71c1a3831c9d8986ee3d184275de701140a1e4effcce55ea573c6dd999b95c1
3+
size 2410950

‎testing-data/docs/example_experiment_0/output/RG_monthly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:471f02a99ae2a3f560200ef4e40333b8ef0687e34e63cdae6fcf336440303e98
3+
size 1126070

‎testing-data/docs/example_experiment_0/output/RH_monthly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:afac96e2049529c241391030bdf4ac73db4aa7ac4bd0078ba34a1e39624b9d5a
3+
size 835197

‎testing-data/docs/example_experiment_0/output/RH_monthly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:626a2edbc946d8648a143dd944731c6d6f2711feeaa3ab00feaa76d9185eb560
3+
size 2410957

‎testing-data/docs/example_experiment_0/output/RH_monthly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:773426a57726edb48cc5742d30894bf5ed3615e8989da60f5a17448215e80218
3+
size 1126077

‎testing-data/docs/example_experiment_0/output/RM_monthly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:14533f38849cf50917664de717f970cd7200a686c94f2877344e7b48e8fbad41
3+
size 835195

‎testing-data/docs/example_experiment_0/output/RM_monthly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:94dbd64e4917fc57c60d6c84c58cc44420b64eaa0011a4a2dc528457b40026c9
3+
size 2410955

‎testing-data/docs/example_experiment_0/output/RM_monthly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:8952d6ef4b55e06ee7bf97ac3ce2f8b8334f264a3252763725ae2e5bd044a147
3+
size 1126075

‎testing-data/docs/example_experiment_0/output/SHLWC_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:ab05ef2a8817773efbdf47e71f609ce6d374beb061d082aa4a2b86ca1881af38
3+
size 79729

‎testing-data/docs/example_experiment_0/output/SHLWC_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:33d3c77c22d864225c910f33ca1607fb2380a2475edffe1f66cf259e9e5b96df
3+
size 210948

‎testing-data/docs/example_experiment_0/output/SHLWC_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:8f6a5c99b9f451a8ece104a7ce491c28eee9447676538c8e46a887a04b43614a
3+
size 103969

‎testing-data/docs/example_experiment_0/output/SHLWDZ_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:464c2e8bbb7d6fe89342880deeb4bed38e6a54ed0d9d05e00bd5bfc27e583263
3+
size 79743

‎testing-data/docs/example_experiment_0/output/SHLWDZ_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:71ada031453cd0bcbab88befacfab6bd6fe3766fa9e9e0ced00a4a64a80088d0
3+
size 210965

‎testing-data/docs/example_experiment_0/output/SHLWDZ_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:8173523eadd913efecd536fbfec803b1fdcaf1d5c2a6d5908ac8b9c59b849a69
3+
size 103983

‎testing-data/docs/example_experiment_0/output/TLAYER_monthly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:b1f2f1e6275b33f9283a328da3e7d4325e969b46e4bf1b9baddfee4f941bc219
3+
size 17971939

‎testing-data/docs/example_experiment_0/output/TLAYER_monthly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:7fa98ba873261d235061e4bf176ee05561ef2c706452a529320062af734eb4f1
3+
size 52811674

‎testing-data/docs/example_experiment_0/output/TLAYER_monthly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:651d5e49ce6b0aad9b58a969263fa931e5a5cc99506ceb158020b8c9459c16ce
3+
size 24310819

‎testing-data/docs/example_experiment_0/output/VEGC_yearly_sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:4eac6f120c7e22ab0303d929627647559e5ba69835a67cc482c087285fa9999a
3+
size 79706

‎testing-data/docs/example_experiment_0/output/VEGC_yearly_sp.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:59a24a438dd737c64a32c3f107f4e631e39a95f1251654afcf4be104bb292946
3+
size 210954

‎testing-data/docs/example_experiment_0/output/VEGC_yearly_tr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:2fedd1ef5350be7cff6091c2d16a380c25cc065cb7a1bd464547d26c2e3ab342
3+
size 103946

‎testing-data/docs/example_experiment_0/output/restart-eq.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:b2fb6e159c4184e49ae020e2a836dd0b88b9da079684a772a7a36bd8f5d51be9
3+
size 1088428

‎testing-data/docs/example_experiment_0/output/restart-pr.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:4f729d798b5145bdd212f19a628d43b6bec162c4c905272950bc302a7b0f7d19
3+
size 1088428

‎testing-data/docs/example_experiment_0/output/restart-sc.nc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:0c0d6a359e8cd02528ad73961a51d00d75d345114aa682df45cef947ed080d34
3+
size 1088428

0 commit comments

Comments
 (0)