Skip to content

Commit e8a0f72

Browse files
committed
Prepackage changes. Update base solutions for one flow case.
1 parent df06b92 commit e8a0f72

File tree

8 files changed

+23
-15
lines changed

8 files changed

+23
-15
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,30 @@ Building CMS on Windows requires use of the Microsoft Visual Studio GUI. This re
2020
Once the sofware has been installed, the user should load the appropriate **solution file** for the UI.
2121

2222
## Linux platform
23-
To build CMS On linux you must have CMAKE software above 2.9 and 'gfortran' installed.
24-
1. `cd cms2d/source`
25-
2. `cmake .`
26-
3. `make`
27-
23+
To build CMS On linux:
24+
- You must have CMAKE software 3.5 or above
25+
- You must have the HDF5 (and Zlib) libraries installed on your system.
26+
27+
Instructions (updated 06/18/25):
28+
1. Clone repository or unzip CMS Source into a folder.
29+
2. Go to the root directory of the repo.
30+
3. Type `cmake .` at the prompt !(do not enter the ` characters)
31+
4. Type `make clean`
32+
5. Type `make`
33+
- This will make the XMDF library and the CMS executable using the XMDF library.
34+
- There may be a few warnings during XMDF compilation, but it should create a working library.
35+
36+
- If no errors, an executable named 'cms' will be in the 'source' directory. Move and rename the executable as needed.
2837
- This will leave you with an executable named 'cms' in your the "source" directory.
29-
- To clean all of the intermediate files and old executable, type 'make clean' from the "source" directory.
3038
Note: Linux builds have not been fully tested on HPC platform and some extra configuration may be necessary.
3139

3240
# File/Folder structure
3341
Below is a list of folders and descriptions of the contents.
3442
- **docs** - this folder contains the documentation files needed for the [CMS Documentation page](https://cms2d.readthedocs.io/) that is in progress.
43+
- **external_libraries** - subfolders containing third-party source and binary libraries to link with.
3544
- **Intel_vs2019** - this folder contains the solution file needed to load into Visual Studio 2019.
3645
- **Intel_vs2022** - this folder contains the solution file needed to load into Visual Studio 2022.
37-
- **GCTP** - this project folder contains library code needed to map information between horizontal projections.
38-
- **SPCS83** - this project folder contains library code needed for changes related to the State Plane coordinate system.
39-
- **UTM2GEO** - this project folder contains library code needed for converting to/from geographic coordinate space.
4046
- **source** - contains subfolders for all the main CMS code functionality separated into process type.
41-
- **external_libraries** - subfolders containing binary libraries to link with (no source).
4247
- **testing** - contains CI/CD tests
4348

4449
Additional files in the main folder and their descriptions:

docs/user/whatsnew.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
What's New
22
==========
33

4-
v5.4.5 (18 June 2025)
4+
v5.4.5 (23 June 2025)
55
-------------------------
66

77
Changes
@@ -10,7 +10,10 @@ Changes
1010
* Enabled XMDF compilation on Linux. Updated workflow to compile CMS including XMDF libraries.
1111
* Add canned test cases for XMDF that should work on Linux or Windows
1212
* Moved third-party libraries from root folder to be under the 'external_libraries' folder.
13-
13+
* Modified CI for CMS-Flow and added a few CMS-Wave tests (still to be added to CI)
14+
* Add extra print line for Hot Start indicating the starting date/time.
15+
* Bug fix in steering for printing out correct timestamp when it has only 8 digits instead of 12.
16+
* Ignore certain Advanced cards if they are already handled. Print warning message.
1417

1518
v5.4.4.4 (19 May 2025)
1619
-------------------------

source/logsheet.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
== Version 5.4.5 (06/20/2025) ==
1+
== Version 5.4.5 (06/23/2025) ==
22
* Bug fix - need to test for enabled sediment after reading in cards in prestart
33
* Enabled XMDF compilation on Linux. Updated workflow to compile CMS including XMDF libraries.
44
* Add canned test cases for XMDF that should work on Linux or Windows
55
* Moved third-party libraries from root folder to be under the 'external_libraries' folder.
6-
* Modified CI for CMS-Flow and added a few CMS-Wave tests
6+
* Modified CI for CMS-Flow and added a few CMS-Wave tests (still to be added to CI)
77
* Add extra print line for Hot Start indicating the starting date/time.
88
* Bug fix in steering for printing out correct timestamp when it has only 8 digits instead of 12.
99
* Ignore certain Advanced cards if they are already handled. Print warning message.

source/readme.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,5 +80,5 @@
8080
4. Type `make clean`
8181
5. Type `make`
8282
- This will make the XMDF library and the CMS executable using the XMDF library.
83-
- There may be a few warnings during XMDF compilation, but it should still create a library.
83+
- There may be a few warnings during XMDF compilation, but it should create a working library.
8484
6. If no errors, an exectuable named 'cms' will be in the 'source' directory. Move and rename the executable as needed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)