Commit 597e5be1 authored by Sasa Zhang's avatar Sasa Zhang
Browse files

modified README file

parent 0fe61794
Pipeline #195290 passed with stage
in 1 minute and 42 seconds
......@@ -64,8 +64,10 @@ To compile the Fortran model you will need to perform the following action:
== Release ==
=============
1) Make a tag in SVN for the release of that version. You will need an access to the metro project on GNA to do that.
The following is an exemple of the user Francois Fortin making a tags for the 3.2.4 version
1) Make a tag in SVN for the release of that version.
You will need an access to the metro project on GNA to do that.
The following is an example of the user Francois Fortin making a tags
for the 3.2.4 version
svn copy svn+ssh://francois_fortin@svn.gna.org/svn/metro/metro/trunk \
svn+ssh://francois_fortin@svn.gna.org/svn/metro/metro/tags/metro-3.2.4
......@@ -73,14 +75,15 @@ To compile the Fortran model you will need to perform the following action:
2) Upload package to the GNA web site (http://download.gna.org/metro/)
scp metro-3.2.4.tar.bz2 metro-3.2.4.tar.bz2.sig francois_fortin@download.gna.org:/upload/metro/
3) Create a new LATEST_RELEASE file with the new version number. The content of the file is:
3) Create a new LATEST_RELEASE file with the new version number.
The content of the file is:
------------------------------------- cut here --------------------------------
Please note:
------------------------------------- cut here --------------------------------
Please note:
- The latest stable version of the METRo package is:
- The latest stable version of the METRo package is:
metro-3.2.4
------------------------------------- cut here --------------------------------
------------------------------------- cut here --------------------------------
4) Upload the LATEST_RELEASE file to the GNA web site (http://download.gna.org/metro/)
scp LATEST_RELEASE francois_fortin@download.gna.org:/upload/metro/
......
-----------------------------------------------------------------------------------------
-------------------------------------------------------------------------------
METRo test_suite README file
-----------------------------------------------------------------------------------------
-------------------------------------------------------------------------------
You are currently reading the test_suite README file of the release 4.0.0 (December 2019)
You are reading the test_suite README file of the release 4.0.0 (December 2019)
============================= What is test_suite.py of METRo? ===========================
======================== What is test_suite.py of METRo? ======================
The test_suite.py of METRo is created to run pre-selected case(s) automatically.
Once test_suite.py finishes running, it generates the running result and outputs a forecast
file named "roadcast_test_suite_run.xml" for each individual pre-selected case. It then
compares the forecast file "roadcast_test_suite_run.xml" with the given benchmark forecast
file "roadcast_reference.xml" and displays the comparison result for each pre-selected case.
Once test_suite.py finishes running, it generates the running result and outputs
a forecast file named "roadcast_test_suite_run.xml" for each individual pre-
selected case. It then compares the forecast file "roadcast_test_suite_run.xml"
with the given benchmark forecast file "roadcast_reference.xml" and displays the
comparison result for each pre-selected case.
============================ Where is test_suite.py located? =============================
test_suite.py is placed in the directory "test_suite" which is located in the absolute path
"~/usr/share/metro/data/test_suite" where "~" represents the home directory of the software
METRo.
======================= Where is test_suite.py located? =======================
test_suite.py is placed in the directory "test_suite" which is located in the
absolute path "usr/share/metro/data/test_suite" from the home directory of the
software METRo.
============================ Where is each test case located? =============================
Within the directory "test_suite", it contains all the subdirectories of test cases.
Each test case has one subdirectory named "casexxx" and "xxx" represents a three digits
case number (For instance, "case001" represents a case having case number 1, and "case100"
represents a case having case number 100).
======================= Where is each test case located? ======================
Within the directory "test_suite", it contains all the subdirectories of test
cases. Each test case has one subdirectory named "casexxx" and "xxx" represents
a three digits case number (For instance, "case001" represents a case having
case number 1, and "case100" represents a case having case number 100).
============= What are all the possible files included inside a case directory? ============
====== What are all the possible files included inside a case directory? ======
config.json:
This is the configuration file and it includes three attributes: "description",
"addition_to_command_line" and "expected_running_result".
One extra attribute "error_tolerance" can be added and the value of this
attribute has to be in decimal places (For example, having the value of "0.05"
as the "error_tolerance", the comparison result between
"roadcast_test_suite_run.xml" and "roadcast_reference.xml" lies outside the
range of 0.05; in other words, any comparison differences within 0.05 are ignored).
Note: If you would like to use the default error tolerance of "0.01", there is no
need to add this extra attribute in "config.json".
This is the configuration file and it includes three attributes:
"description", "addition_to_command_line" and
"expected_running_result".
One extra attribute "error_tolerance" can be added and the value of
this attribute has to be in decimal places (For example, having the
value of "0.05" as the "error_tolerance", the comparison result
between "roadcast_test_suite_run.xml" and "roadcast_reference.xml"
lies outside the range of 0.05; in other words, any comparison
differences within 0.05 are ignored).
Note: If you would like to use the default error tolerance of "0.01",
there is no need to add this extra attribute in "config.json".
forecast.xml, observation.xml and station.xml:
These are the input files and each case should have these three files in order
for METRo to generate possible forecast.
These are the input files and each case should have these three files
in order for METRo to generate possible forecast.
roadcast_reference.xml:
This is a benchmark forecast file and it only exists for those cases whose
attribute "expected_running_result" has value of "SUCCESS".
This is a benchmark forecast file and it only exists for those cases
whose attribute "expected_running_result" has value of "SUCCESS".
=========================== How to run test_suite.py? ======================================
1. Go to the directory "~/usr/share/metro/data/test_suite" where "~" represents the home
======================== How to run test_suite.py? ============================
1. Go to the directory "usr/share/metro/data/test_suite" from the home
directory of METRo.
2. Enter general command "python3 test_suite.py" to run all the cases inside the directory
"test_suite" and displays the running results in a simplified version.
2. Enter general command "python3 test_suite.py" to run all the cases inside
the directory "test_suite" and displays the running results in a simplified
version.
Possible parameters to run altogether with the general command:
"-v":
test_suite.py runs all cases inside the directory "test_suite" and displays
the detailed information of running processes and outputs the running results
in a verbose version.
Note: "-v" can be used in combination with either "-c" or "-s" and "-e".
"-v":
test_suite.py runs all cases inside the directory "test_suite" and
displays the detailed information of running processes and outputs
the running results in a verbose version.
"-c XX, XX, XX, ..." where XX represents the case number:
"-c XX XX ..." where XX represents the case number:
test_suite.py runs the case(s) whose number(s) is/are entered after "-c".
You can enter as many case numbers as you would like to run, but you have to
enter at least one case number in order to active "-c".
You can enter as many case numbers as you would like to run, but you
have to enter at least one case number in order to active "-c".
Note: "-c" and "-s" cannot be used simultaneously.
"-s XX, XX, XX, ..." where XX represents the case number:
test_suite.py runs by skipping the case(s) whose number(s) is/are entered after
"-s". You can enter as many case numbers as you would like to skip, but you have
to enter at least one case number in order to active "-s".
"-s XX XX ..." where XX represents the case number:
test_suite.py runs by skipping the case(s) whose number(s) is/are
entered after "-s". You can enter as many case numbers as you would
like to skip, but you have to enter at least one case number in
order to active "-s".
Note: "-c" and "-s" cannot be used simultaneously.
"-e YY" where YY represents the error tolerance in floating points:
test_suite.py runs all cases inside the directory "test_suite" and compares
"roadcast_test_suite_run.xml" with "roadcast_reference.xml" and outputs
comparison result(s) using YY instead of the default value of 0.01 as error
of tolerance.
Note: "-e" can be used in combination with either "-c" or "-s" and "-v".
test_suite.py runs all cases inside the directory "test_suite" and
compares "roadcast_test_suite_run.xml" with "roadcast_reference.xml"
and outputs comparison result(s) using YY instead of the default
value of 0.01 as error of tolerance.
"--clean":
test_suite.py deletes all the files named "roadcast_test_suite_run.xml" within
the directory "test_suite".
test_suite.py deletes all the files "roadcast_test_suite_run.xml"
within the directory "test_suite".
Note: "--clean" can be used in combination with "-v" which displays all the
directory/directories where the "roadcast_test_suite_run.xml" is/are deleted.
Note: "--clean" can only be used in combination with "-v" which
displays all the directory/directories where the
"roadcast_test_suite_run.xml" is/are deleted.
Note: You can always enter "python3 test_suite.py --help" for more information on how to use
above argument(s) to run test_suite.py
\ No newline at end of file
"--help":
test_suite.py displays all the detailed information regarding above
mentioned parameters.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment