Difference between revisions of "How to get WRF-SFIRE"
(added release with WRF first) |
|||
| (31 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{users guide}} | |
| + | '''The WRF-Fire code in [http://wrf-model.org/WRF WRF] release has an old version of the code here, from 2010, with [[Fire code in WRF release|further modifications at NCAR]] and developments since WRF 4.0. We cannot support that version and it is not under our control. Many [[WRF-SFIRE development notes|different features were added]] since then. Please get the current version from http://github.com/openwfm/WRF-SFIRE as described here, which includes current SFIRE and WRF. This is the only version we can support. We can even consider [[WRF-Fire development notes#Wish list|adding features]] on request. | ||
| − | + | SFIRE is maintained in a [[git]] repository. A git repository is a software version control system similar to [http://www.nongnu.org/cvs/ CVS] or [http://subversion.apache.org/ SVN]. There is a repository containing WRF-SFIRE and another repository containing WPS, and it is regularly synchronized with major WRF releases. They both need to be compiled with the same compiler and be present at the same directory level. In order to obtain the software from our repositories, you must first [http://git-scm.com/download download] and install the git software. The default view of the repository is the head of the master branch, which should contain a current stable and working code at any time. | |
| − | The | + | The best view of current activity is available at http://repo.or.cz/git-browser/by-commit.html?r=WRF-SFIRE.git |
| − | |||
| − | |||
| − | |||
| − | Developers | + | Developers can get write access to the git repository on request, and must push changes to it. |
| − | access must push changes to | ||
==Download== | ==Download== | ||
| − | We strongly recommend to use download by git, because | + | We strongly recommend to use download by git (as opposed to a tar or zip file, also available from the repository), because git allows easy updates and identification of the state of all files in case of problems. The following public, read-only mirrors are available. |
| − | ;[http://github.com/ | + | ;[http://github.com/openwfm/WRF-SFIRE http://github.com/openwfm/WRF-SFIRE] |
| − | :<tt><pre>git clone git://github.com/ | + | :<tt><pre>git clone git://github.com/openwfm/WRF-SFIRE.git</pre></tt> |
| − | ; | + | ;http://repo.or.cz/WRF-SFIRE.git |
| − | :<tt><pre>git clone git:// | + | :<tt><pre>git clone git://repo.or.cz/WRF-SFIRE.git</pre></tt> |
| − | The home | + | The home page of the mirror allows you to browse the source code as well as examine changes and view the different development branches. |
It is also possible to download the latest source code as a | It is also possible to download the latest source code as a | ||
| − | [[wikipedia:tar (file format)|tarball]] or [[wikipedia:zip (file format)|zip]] file from each mirror; however, this method is discouraged as it will be | + | [[wikipedia:tar (file format)|tarball]] or [[wikipedia:zip (file format)|zip]] file from each mirror; however, this method is discouraged as it will be difficult to update to the latest version and we cannot support code that is not under git control. |
| − | difficult to update to the latest version. | ||
==Update== | ==Update== | ||
| − | You can update your files any time to the current version, without downloading all again. If you have downloaded your copy by git, do in your <tt> | + | You can update your files any time to the current version, without downloading all again. If you have downloaded your copy by git, do in your <tt>WRF-SFIRE</tt> directory |
<pre> | <pre> | ||
| Line 36: | Line 32: | ||
==Verify== | ==Verify== | ||
| − | To identify the version of files you have, do in your <tt> | + | To identify the version of files you have, do in your <tt>WRF-SFIRE</tt> directory |
<pre> git log</pre> | <pre> git log</pre> | ||
| Line 45: | Line 41: | ||
==See also== | ==See also== | ||
| − | *[[How to run WRF- | + | *[[How to run WRF-SFIRE]] |
*[[WRF-Fire development notes]] | *[[WRF-Fire development notes]] | ||
*[[WRF-Fire#Support|WRF-Fire support]] | *[[WRF-Fire#Support|WRF-Fire support]] | ||
Latest revision as of 02:24, 9 October 2021
- Back to the WRF-SFIRE user guide.
The WRF-Fire code in WRF release has an old version of the code here, from 2010, with further modifications at NCAR and developments since WRF 4.0. We cannot support that version and it is not under our control. Many different features were added since then. Please get the current version from http://github.com/openwfm/WRF-SFIRE as described here, which includes current SFIRE and WRF. This is the only version we can support. We can even consider adding features on request.
SFIRE is maintained in a git repository. A git repository is a software version control system similar to CVS or SVN. There is a repository containing WRF-SFIRE and another repository containing WPS, and it is regularly synchronized with major WRF releases. They both need to be compiled with the same compiler and be present at the same directory level. In order to obtain the software from our repositories, you must first download and install the git software. The default view of the repository is the head of the master branch, which should contain a current stable and working code at any time.
The best view of current activity is available at http://repo.or.cz/git-browser/by-commit.html?r=WRF-SFIRE.git
Developers can get write access to the git repository on request, and must push changes to it.
Download
We strongly recommend to use download by git (as opposed to a tar or zip file, also available from the repository), because git allows easy updates and identification of the state of all files in case of problems. The following public, read-only mirrors are available.
- http://github.com/openwfm/WRF-SFIRE
git clone git://github.com/openwfm/WRF-SFIRE.git
- http://repo.or.cz/WRF-SFIRE.git
git clone git://repo.or.cz/WRF-SFIRE.git
The home page of the mirror allows you to browse the source code as well as examine changes and view the different development branches.
It is also possible to download the latest source code as a tarball or zip file from each mirror; however, this method is discouraged as it will be difficult to update to the latest version and we cannot support code that is not under git control.
Update
You can update your files any time to the current version, without downloading all again. If you have downloaded your copy by git, do in your WRF-SFIRE directory
git checkout master; git pull
If you have changed anything, the update will fail, and you have to commit your changes first by git commit -a. The git pull will then merge your changes with the new files from the repository. Please be sure you work with the latest files before contacting us for support. However, we may not be able to support code that you have changed.
Verify
To identify the version of files you have, do in your WRF-SFIRE directory
git log
To verify your files,
git diff
will give no output if your files have not changed from the version identified by git log.