Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Contributors_Guide/github_repository.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
*********************************************
Organization of Code in the Github Repository
Organization of Code in the GitHub Repository
*********************************************

The relevant plotting code resides in one of two directories
Expand Down
8 changes: 4 additions & 4 deletions docs/Contributors_Guide/new_plot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Place all code in the appropriate locations:

b.
Sample data for testing should be placed in *test/<plotname>* directory,
where **<plotname>** is replaced with the name of the plot (e.g. bar, box,
where **<plotname>** is replaced with the name of the plot (e.g., bar, box,
etc.). The size of the sample data must be **under 50 MB.**

c.
Expand All @@ -28,7 +28,7 @@ Place all code in the appropriate locations:

d.
Test code should be placed in the *test/<plotname>* directory,
where **<plotname>** is replaced with the name of the plot (e.g. bar, box,
where **<plotname>** is replaced with the name of the plot (e.g., bar, box,
etc.). The test code should be created using the pytest framework,
utilizing sample data that can be readily run.

Expand All @@ -48,12 +48,12 @@ a default configuration file and a custom config file.
The default configuration files are used by METviewer and are located in
*metplotpy/plots/config*. The default config file should be named using the
naming convention **<plotname>_defaults.yaml**, where **<plotname>** is replaced
with the name of the plot (e.g. bar, box, etc.).
with the name of the plot (e.g., bar, box, etc.).

The custom configuration file is required. It can be an empty file if the
default settings are to be applied. Custom configuration files are located
in the *test/<plotname>* directory, where **<plotname>** is replaced with the name
of the plot (e.g. box, bar, etc.). In addition to being used for testing,
of the plot (e.g., box, bar, etc.). In addition to being used for testing,
these custom configuration files are used in the user documentation to
illustrate how to generate the plot.

Expand Down
2 changes: 1 addition & 1 deletion docs/Contributors_Guide/pull_request.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
***********************
Pull Requests in Github
Pull Requests in GitHub
***********************

Please refer to the `Open a Pull Request
Expand Down
9 changes: 4 additions & 5 deletions docs/Contributors_Guide/tests_github_actions.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
****************************************
Generate Tests and Add to Github Actions
Generate Tests and Add to GitHub Actions
****************************************

Create a subdirectory under the *test* directory
(e.g. *test/<newplot>* where **<newplot>** is replaced with the
(e.g., *test/<newplot>* where **<newplot>** is replaced with the
name of the plot type that is being added to the repository.)

Add sample data (see applicable information in the
`Adding a New Plot
<https://metplus.readthedocs.io/projects/metplotpy/en/develop/Contributors_Guide/new_plot.html#adding-a-new-plot>`_
section).

Use the pytest framework to generate tests. For more information review
this `pytest documentation <https://docs.pytest.org/en/7.2.x>`_ for
more information.
Use the pytest framework to generate tests. For more information, review
this `pytest documentation <https://docs.pytest.org/en/7.2.x>`_.

Add an entry for the test in the
*.github/workflows/unit_tests.yaml* file.
2 changes: 1 addition & 1 deletion docs/Contributors_Guide/third_party_packages.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
***************************************************************
Add Additional Third-Party Packages to the Github actions tests
Add Additional Third-Party Packages to the GitHub Actions tests
***************************************************************

If necessary, modify the **requirements.txt** file
Expand Down
10 changes: 5 additions & 5 deletions docs/Contributors_Guide/user_doc.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*********************
Add User Documenation
*********************
**********************
Add User Documentation
**********************

Documentation should be added in the *docs/Users_Guide* directory.

Expand Down Expand Up @@ -29,10 +29,10 @@ Add images.
Review and check for errors in the automatically generated documentation.

Once the documentation has been committed and pushed to GitHub,
GitHub actions will automatically create the online documentation.
GitHub Actions will automatically create the online documentation.

Contributors will be able to view the run for the build of the documentation
in the GitHub actions section of the METplotpy repository, which will
in the GitHub Actions section of the METplotpy repository, which will
be named with the text of the last commit message and the
text “Documentation” underneath.

Expand Down
24 changes: 12 additions & 12 deletions docs/Users_Guide/bar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A bar plot shows comparisons among discrete categories. One axis of the
chart shows the specific categories being compared, while the other
represents some measured value. The heights or lengths are proportional to
the values that they represent. Bar plots are simple and flexible, unlike
some other METview plot types. Rather than using prescribed statistics in
some other METviewer plot types. Rather than using prescribed statistics in
a specific way, the user can select both axes.

Bar plots are distinct from histograms and the two are not interchangeable.
Expand Down Expand Up @@ -38,14 +38,14 @@ METplotpy repository, where the bar plot tests are located:
*$METPLOTPY_BASE* is the directory where the METplotpy code is saved.
The data is text output from MET in columnar format.

e.g.
e.g.,

*/usr/path/to/METplotpy* if the source code was cloned or forked from the Github repository
*/usr/path/to/METplotpy* if the source code was cloned or forked from the GitHub repository

or

*/usr/path/to/METplotpy-x.y.z* if the source code was downloaded as a zip or gzip'd tar file from the Release link of
the Github repository. The *x.y.z* is the release number.
the GitHub repository. The *x.y.z* is the release number.


Configuration Files
Expand All @@ -62,7 +62,7 @@ required. The first is a default configuration file, **bar_defaults.yaml**,
which is found in the
*$METPLOTPY_BASE/metplotpy/plots/config* directory. All default
configuration files are located in the
*$METPLOTPY_BASE/metplotpy/plots/config* directory. *$METPLOTPY_BASE* is base directory where the
*$METPLOTPY_BASE/metplotpy/plots/config* directory. *$METPLOTPY_BASE* is the base directory where the
METplotpy source code has been saved. **Default configuration files are
automatically loaded by the plotting code and do not need to be explicitly
specified when generating a plot**.
Expand All @@ -79,15 +79,15 @@ Default Configuration File
--------------------------

The following is the *mandatory*, **bar_defaults.yaml** configuration file,
which serves as a good starting point for creating a line
which serves as a good starting point for creating a bar
plot as it represents the default values set in METviewer.

**NOTE**: This default configuration file is automatically loaded by
**bar.py**.

.. literalinclude:: ../../metplotpy/plots/config/bar_defaults.yaml

In the default config file, logging is set to stdout and the log level is ERROR (i.e. only log messages
In the default config file, logging is set to stdout and the log level is ERROR (i.e., only log messages
of type ERROR will be logged). If the log_filename and log_level are
not specified in the custom configuration file, these settings will be used.

Expand All @@ -112,7 +112,7 @@ saved to the working directory:
Modify the *stat_input* setting in the
**$METPLOTPY_BASE/test/bar/custom_bar.yaml**
file to explicitly point to the $METPLOTPY_BASE/test/bar
directory by replacing the relative paths (e.g. *./bar.data*) with the full path
directory by replacing the relative paths (e.g., *./bar.data*) with the full path
*$METPLOTPY_BASE/test/bar/bar.data* (including replacing *$METPLOTPY_BASE*
with the full path to the METplotpy installation on the system). Modify the
*plot_filename* setting to explicitly point to the directory of the plot,
Expand All @@ -126,7 +126,7 @@ For example:

This is where */username/myworkspace/METplotpy* corresponds to $METPLOTPY_BASE and
*/username/working_dir* corresponds to $WORKING_DIR. Make sure that the
$WORKING_DIR directory that is specifed exists and has the appropriate
$WORKING_DIR directory that is specified exists and has the appropriate
read and write permissions.
The path listed for *plot_filename* may be changed to the output directory
of one’s choosing. If this is not set, then the *plot_filename* setting
Expand All @@ -143,7 +143,7 @@ the *points_path* setting.

*points_path: '/dir_to_save_points1_file'*

Replace the */dir_to_save_points1_file* to the same directory where
Replace the */dir_to_save_points1_file* with the same directory where
the **.points1** file is saved.
If points_path is commented out (indicated by a '#' symbol in front of it),
remove the '#' symbol to uncomment
Expand All @@ -155,7 +155,7 @@ file is desired.

To save the log output to a file, uncomment the *log_filename* entry and specify the path and
name of the log file. Select a directory with the appropriate read and write
privileges. To modify the verbosity of logging than what is set in the default config
privileges. To modify the verbosity of logging from what is set in the default config
file, uncomment the *log_level* entry and specify the log level (debug and info are higher verbosity, warning and error
are lower verbosity).

Expand All @@ -171,7 +171,7 @@ The **custom_bar.yaml** configuration file, in combination with the
To generate the above bar plot, perform the following:

* If using the conda environment,
verify the conda environment is running and has has the required
verify the conda environment is running and has the required
Python packages outlined in the `requirements section
<https://metplus.readthedocs.io/projects/metplotpy/en/latest/Users_Guide/installation.html#python-requirements>`_.

Expand Down
22 changes: 11 additions & 11 deletions docs/Users_Guide/box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ of values using Tukey's 5-number summary
(:ref:`Hoaglin et al., 1983<Hoaglin>`). The dark
line in the middle of the boxes (sometimes called the 'waist') is the
median of data. Half of the data values have a value greater than the
median, and half have a value lower. The actual box (i.e. the central
median, and half have a value lower. The actual box (i.e., the central
rectangle) spans the first quartile to the third quartile (or the
interquartile range or IQR). Whiskers extend to 1.5 times the height
of the box or, if closer to the median, the minimum or maximum values
Expand Down Expand Up @@ -41,14 +41,14 @@ METplotpy repository, where the box plot tests are located:

*$METPLOTPY_BASE* is the directory where the METplotpy code is saved

e.g.
e.g.,

*/usr/path/to/METplotpy* if the source code was cloned or forked from the Github repository
*/usr/path/to/METplotpy* if the source code was cloned or forked from the GitHub repository

or

*/usr/path/to/METplotpy-x.y.z* if the source code was downloaded as a zip or gzip'd tar file from the Release link of
the Github repository. The *x.y.z* is the release number.
the GitHub repository. The *x.y.z* is the release number.


Configuration Files
Expand Down Expand Up @@ -83,7 +83,7 @@ Default Configuration File
--------------------------

The following is the *mandatory*, **box_defaults.yaml** configuration file,
which serves as a good starting point for creating a line
which serves as a good starting point for creating a box
plot as it represents the default values set in METviewer.

.. literalinclude:: ../../metplotpy/plots/config/box_defaults.yaml
Expand Down Expand Up @@ -144,7 +144,7 @@ setting to True. Uncomment or add (if it doesn't exist) the
*points_path: '/dir_to_save_points1_file'*


Replace the **/dir_to_save_points1_file** to the same directory where
Replace the **/dir_to_save_points1_file** with the same directory where
the **.points1** file is saved.
If *points_path* is commented out (indicated by a '#' symbol in front of it),
remove the '#' symbol to uncomment the points_path so that it will be used
Expand All @@ -155,7 +155,7 @@ unless saving the intermediate **.points1** file is desired.

To save the log output to a file, uncomment the *log_filename* entry and specify the path and
name of the log file. Select a directory with the appropriate read and write
privileges. To modify the verbosity of logging than what is set in the default config
privileges. To modify the verbosity of logging from what is set in the default config
file, uncomment the *log_level* entry and specify the log level (debug and info are higher verbosity, warning and error
are lower verbosity).

Expand Down Expand Up @@ -191,7 +191,7 @@ files are located. Set the *stat_input* to

*plot_filename: $WORKING_DIR/output_plots/box_default.png*

Where *$WORKING_DIR* is the working directory where where all the custom
Where *$WORKING_DIR* is the working directory where all the custom
configuration files are being saved. **NOTE**: If the *plot_filename*
(output directory) is specified to a directory other than the
*$WORKING_DIR/output_plots*, the user must have read and write permissions
Expand All @@ -200,7 +200,7 @@ to that directory.
**NOTE**: This file does not plot any data, its purpose is to provide a
template for setting the margins, plot size, labels, etc.

In the default config file, logging is set to stdout and the log level is ERROR (i.e. only log messages
In the default config file, logging is set to stdout and the log level is ERROR (i.e., only log messages
of type ERROR will be logged). If the log_filename and log_level are
not specified in the custom configuration file, these settings will be used.

Expand Down Expand Up @@ -253,7 +253,7 @@ Perform the following to generate the plots:

.. image:: figure/box_default.png

To generate the above *"defaults"* plot (i.e using default configuration
To generate the above *"defaults"* plot (i.e., using default configuration
settings), use the "minimal" custom configuration file, **minimal_box.yaml**.


Expand All @@ -265,4 +265,4 @@ Perform the following to generate the plots:

* A **box_default.png** output file will be created in the
directory specified in the *plot_filename* configuration setting in
the **box_minimal.yaml** config file.
the **minimal_box.yaml** config file.
20 changes: 10 additions & 10 deletions docs/Users_Guide/contour.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Description

Contour plots are a very general plot type somewhat similar to a scatter
plot. The axes are specified by the user, and any will do so long as the
entire set of x and y locations has some value (i.e. not missing data). The
entire set of x and y locations has some value (i.e., not missing data). The
value is then contoured. This type of plot is often used to examine
statistics over a series of time or heights.
For more information on Contour plots, please refer to the
Expand All @@ -32,14 +32,14 @@ repository:

*$METPLOTPY_BASE* is the directory where the METplotpy code is saved:

e.g.
e.g.,

*/usr/path/to/METplotpy* if the source code was cloned or forked from the Github repository
*/usr/path/to/METplotpy* if the source code was cloned or forked from the GitHub repository

or

*/usr/path/to/METplotpy-x.y.z* if the source code was downloaded as a zip or gzip'd tar file from the Release link of
the Github repository. The *x.y.z* is the release number.
the GitHub repository. The *x.y.z* is the release number.



Expand All @@ -51,7 +51,7 @@ input data is located and to set plot attributes. These plot attributes
correspond to values that can be set via the METviewer tool. YAML is a
recursive acronym for "YAML Ain't Markup Language" and according to
`yaml.org <https://yaml.org>`_,
it is a "human-friendly data serialization language. It is commonly used for
it is a "human-friendly data serialization language". It is commonly used for
configuration files and in applications where data is being stored or
transmitted. Two configuration files are required. The first is a
default configuration file, **contour_defaults.yaml**,
Expand Down Expand Up @@ -85,7 +85,7 @@ contour plot, as it represents the default values set in METviewer.

.. literalinclude:: ../../metplotpy/plots/config/contour_defaults.yaml

In the default config file, logging is set to stdout and the log level is ERROR (i.e. only log messages
In the default config file, logging is set to stdout and the log level is ERROR (i.e., only log messages
of type ERROR will be logged). If the log_filename and log_level are
not specified in the custom configuration file, these settings will be used.

Expand Down Expand Up @@ -143,7 +143,7 @@ Uncomment or add (if it doesn't exist) the *points_path* setting:

*points_path: '/dir_to_save_points1_file'*

Replace the */dir_to_save_points1_file* to the same directory where the
Replace the */dir_to_save_points1_file* with the same directory where the
**.points1** file is saved.
If *points_path* is commented out (indicated by a '#' symbol in front of it),
remove the '#' symbol to uncomment
Expand All @@ -155,7 +155,7 @@ file unless saving the intermediate **.points1** file is desired.

To save the log output to a file, uncomment the *log_filename* entry and specify the path and
name of the log file. Select a directory with the appropriate read and write
privileges. To modify the verbosity of logging than what is set in the default config
privileges. To modify the verbosity of logging from what is set in the default config
file, uncomment the *log_level* entry and specify the log level (debug and info are higher verbosity, warning and error
are lower verbosity).

Expand All @@ -164,13 +164,13 @@ are lower verbosity).
Run from the Command Line
=========================

To generate a contour plot (i.e. using settings in the
To generate a contour plot (i.e., using settings in the
**custom_contour.yaml** configuration file),
perform the following:


* If using the conda environment, verify the conda environment
is running and has has the required Python packages outlined in the
is running and has the required Python packages outlined in the
`requirements section
<https://metplus.readthedocs.io/projects/metplotpy/en/latest/Users_Guide/installation.html#python-requirements>`_.

Expand Down
Loading
Loading