You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/folderstructure.md
+1-16Lines changed: 1 addition & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,6 @@
6
6
- experiments: contains simple runs of `ClimaLand` models. Most of these experiments is run as part of our CI.
7
7
- src: contains the code of `ClimaLand` models.
8
8
- ext: contains a package extension for Neural Snow and an extension with constructors for model parameters
9
-
- lib: contains two packages that extend ClimaLand functionality: ClimaLandSimulations and ClimaLandDashboards
10
9
- test: contains [unit tests](https://en.wikipedia.org/wiki/Unit_testing), which are meant to ensure small pieces of ClimaLand source code work as intended before merging pull requests.
11
10
12
11
and 3 GitHub actions folders. GitHub actions are `.yml` files that define workflows that are run at each pull request.
@@ -84,20 +83,6 @@ As well as two files:
84
83
- ClimaLand.jl: This file is the main Julia module of `ClimaLand.jl` repository. It contains all functions defined in `/src` in a nested way, for example `ClimaLand.X`, `ClimaLand.Soil.X`, `ClimaLand.Canopy.X`, etc. When a Julia user install and uses ClimaLand via `]add ClimaLand, using ClimaLand`, they are loading those functions, and are ready to use ClimaLand codebase.
85
84
- Artifacts.jl: Contains functions that return the path of the given artifact name in the current context
86
85
87
-
## /lib folder
88
-
89
-
This folder contains a subfolder, `/ClimaLandSimulations`, which contains a library of methods
90
-
to easily and conveniently run ClimaLand at a variety of sites and globally. There are 3 subfolders:
91
-
92
-
- experiments: This folder contains scripts to run ClimaLand at a fluxnet site using ClimaLandSimulations
93
-
- src: Contains source code for the ClimaLandSimulations package. There are 3 subfolders and
94
-
1 file.
95
-
- Dashboards: Contains scripts to create dashboards for running simulations at fluxnet sites
96
-
- Fluxnet: Contains scripts to setup a ClimaLand simulation at a fluxnet site
97
-
- utilities: Contains utilities used in setup of ClimaLand simulation at a fluxnet sites
98
-
99
-
- test: Contains tests for the ClimaLandSimulations package
100
-
101
86
## /ext folder
102
87
This folder has one subfolder, `/neural_snow`, which contains tools to create the neural network
103
88
for snow and process its data. There are also two files
@@ -121,4 +106,4 @@ subfolders:
121
106
- aqua.jl: Contains code quality assurance tests tha use Aqua.jl
122
107
- Project.toml: Specifies dependencies needed for testing
123
108
- runtests.jl: When `test` is ran from the package manager, this file is ran. It can also be
124
-
manually ran using the `test` environment. This file runs all the other test scripts.
109
+
manually ran using the `test` environment. This file runs all the other test scripts.
0 commit comments