Merge branch 'main' of https://github.com/daniloceano/LorenzCycleToolkit

 into joss-submission

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.4] - 2024-08-28
+
+### Added
+- Added a `support` section in the documentation to provide guidelines for users seeking help or reporting issues. Users are encouraged to use the GitHub repository for reporting, with the option to contact via email if needed.
+
+### Updated
+- Updated the "Moving (Semi-Lagrangian) Framework Example" section in the documentation to include information about using the default track file for testing and the requirement to overwrite the `inputs/track` file with custom track data.
+- Clarified that the preferred method for running the LorenzCycleToolkit is through command line arguments executed from the top-level directory of the project.
+
+### Fixed
+- Improved clarity in the documentation by specifying the appropriate directories and command usage for various examples and tutorials.
+
 ## [1.0.3] - 2024-07-27
 ### Bug Fixes
 - Deploying documentation

docs/source/examples_and_tutorials.rst

@@ -1,9 +1,11 @@
 Examples and Tutorials
 ======================
 
+The preferred method for using the LorenzCycleToolkit is through command line arguments executed from the top-level directory of the project. Below are examples demonstrating how to configure and run the toolkit using different frameworks.
+
 Fixed (Eulerian) Framework Example
 ----------------------------------
-1. Prepare the `inputs/box_limits` file.
+1. Prepare the `inputs/box_limits` file.  
    The `box_limits` file should define the spatial domain as a CSV file with the following format:
 
    .. code-block:: text
@@ -13,7 +15,7 @@ Fixed (Eulerian) Framework Example
        min_lat;-42.5
        max_lat;-17.5
 
-2. Prepare the `inputs/namelist` file.
+2. Prepare the `inputs/namelist` file.  
    The `namelist` file specifies the variable names and units used in the input NetCDF file. Here is an example for the National Center for Environmental Protection Reanalysis 2 (NCEP-R2) dataset:
 
    .. code-block:: text
@@ -29,15 +31,16 @@ Fixed (Eulerian) Framework Example
        Time;;initial_time0_hours
        Vertical Level;;lv_ISBL3
 
-3. Run the following command::
+3. From the top-level directory of the project, run the following command::
 
        python lorenzcycletoolkit.py samples/testdata_NCEP-R2.nc -r -f
 
    This will execute the LorenzCycleToolkit using the fixed (Eulerian) framework.
 
-Moving (Semi-Lagrangian) Framework Example
+Moving (Semi-Lagrangian) Framework Example  
 ------------------------------------------
-1. Prepare the `inputs/track_file`.
+
+1. Prepare the `inputs/track_file`.  
    The `track_file` should define the system's center over time. Optionally, add length and width columns to adjust the domain size. Example:
 
    .. code-block:: text
@@ -49,15 +52,23 @@ Moving (Semi-Lagrangian) Framework Example
        2005-08-08-1800;-22.8;-44.7
        2005-08-09-0000;-22.9;-44.6
 
-2. Run the following command::
+   A default track file for testing purposes is also provided and can be used by running the following command:
+
+   .. code-block:: shell
+
+       cp inputs/track_testdata_NCEP-R2 inputs/track
+
+   The program will always use the `inputs/track` file for processing. Therefore, if you have a custom track file, you need to overwrite the `inputs/track` file with the desired track data before running the program.
+
+2. From the top-level directory of the project, run the following command::
 
        python lorenzcycletoolkit.py samples/testdata__NCEP-R2.nc -r -t
 
    This will execute the LorenzCycleToolkit using the moving (Semi-Lagrangian) framework.
 
 Interactive Domain Selection Example
 ------------------------------------
-1. Run the following command::
+1. From the top-level directory of the project, run the following command::
 
        python lorenzcycletoolkit.py samples/testdata__NCEP-R2.nc -r -c
 

docs/source/index.rst

@@ -22,5 +22,6 @@ Welcome to the LorenzCycleToolkit documentation! This toolkit is designed to cal
    results
    math
    contributing
+   support
    license
    references

docs/source/support.rst

@@ -0,0 +1,31 @@
+Support and Issue Reporting
+===========================
+
+Getting Support
+---------------
+
+If you need help with using the LorenzCycleToolkit, the preferred method is to reach out via our GitHub repository. You can also contact me directly via email if necessary.
+
+- **GitHub Repository:** [LorenzCycleToolkit Issues](https://github.com/daniloceano/LorenzCycleToolkit/issues)
+- **Email:** [email protected]
+
+When asking for support, please include the following information:
+- The version of LorenzCycleToolkit you are using.
+- A detailed description of the issue or question.
+- Any relevant error messages or logs.
+- Steps to reproduce the problem, if applicable.
+
+Reporting Issues
+----------------
+
+For reporting bugs or requesting features, please use the GitHub issue tracker:
+
+- **Issue Tracker:** [LorenzCycleToolkit Issues](https://github.com/daniloceano/LorenzCycleToolkit/issues)
+
+When reporting an issue, please provide:
+- A clear and concise title for the issue.
+- A detailed description of the problem or request.
+- Steps to reproduce the issue, if applicable.
+- Any relevant screenshots, logs, or files.
+
+We appreciate your contributions and feedback to improve LorenzCycleToolkit!

setup.py

@@ -13,7 +13,7 @@ def read_requirements():
 
 setup(
     name='LorenzCycleToolkit',
-    version='1.0.3',
+    version='1.0.4',
     packages=find_packages(),
     include_package_data=True,
     install_requires=read_requirements(),