-
Notifications
You must be signed in to change notification settings - Fork 20
Docs: README updates #607
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Docs: README updates #607
Changes from all commits
6f29322
cdf3b26
1b2da7a
f0a900c
ec7bd82
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,40 @@ | ||
# **Fremake Canopy** | ||
# **Fre make** | ||
Through the fre-cli, `fre make` can be used to create and run a checkout script, makefile, and compile a model. | ||
|
||
* Fremake Canopy Supports: | ||
* Fre make Supports: | ||
- multiple targets; use `-t` flag to define each target | ||
- bare-metal build | ||
- container creation | ||
- parallel checkouts for bare-metal build** | ||
|
||
** **Note: Users will not be able to create containers without access to podman** | ||
|
||
## **Usage (Users)** | ||
* Refer to fre-cli [README.md](https://github.com/NOAA-GFDL/fre-cli/blob/main/README.md) for foundational fre-cli usage guide and tips. | ||
|
||
## Guide | ||
In order to use the `fre make` tools, remember to create a combined yaml first. This can be done with the `fre yamltools combine-yamls` tool. This combines the model, compile, platform, experiment, and any analysis yamls into ONE yaml file for parsing and validation. | ||
|
||
To combine: | ||
`fre yamltools combine-yamls -y [model yaml file] -e [experiment name] -p [platform] -t [target]` | ||
|
||
### **Bare-metal Build:** | ||
```bash | ||
# Create checkout script | ||
fre make checkout-script -y [model yaml file] -p [platform] -t [target] | ||
|
||
# Create and run checkout script | ||
fre make checkout-script -y [model yaml file] -p [platform] -t [target] --execute | ||
|
||
# Create Makefile | ||
fre make makefile -y [model yaml file] -p [platform] -t [target] | ||
|
||
# Create the compile script | ||
fre make compile-script -y [model yaml file] -p [platform] -t [target] | ||
|
||
# Create and run the compile script | ||
fre make compile-script -y [model yaml file] -p [platform] -t [target] --execute | ||
|
||
# Run all of fremake | ||
# Run fre make checkout-script, fre make makefile, and fre make compile-script in order | ||
fre make all -y [model yaml file] -p [platform] -t [target] [other options...] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would you be able to put this in it's own code blurb? Like have a snippet of explanation like "Or run the fre make steps in an all-encompassing tool ..." right before, then add the I don't want it to seem like the user has to run all the steps AND the all step |
||
``` | ||
|
||
### **Container Build:** | ||
For the container build, parallel checkouts are not supported, so the `-npc` options must be used for the checkout script. In addition the platform must be a container platform. | ||
|
||
***To reiterate, users will not be able to create containers unless they have podman access on gaea.*** | ||
```bash | ||
# Create checkout script | ||
fre make checkout-script -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] -npc | ||
|
||
# Create and run checkout script | ||
fre make checkout-script -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] --execute | ||
|
||
# Create Makefile | ||
fre make makefile -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] | ||
|
||
#Create a Dockerfile | ||
fre make dockerfile -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] | ||
|
||
# Create and run the Dockerfile | ||
fre make dockerfile -y [model yaml file] -p [CONTAINER PLATFORM] -t [target] --execute | ||
``` |
Uh oh!
There was an error while loading. Please reload this page.