deploy: 7db1c19

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 9b3fba783744d64d10cfea86ed98a866
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/api.rst.txt

@@ -0,0 +1,4 @@
+=============
+API
+=============
+Auto-harvested goodness, coming soon.

_sources/badges.rst.txt

@@ -0,0 +1,7 @@
+.. this file is explicitly for the hyperlinkage in the base README.md to the badge image files
+======
+Badges
+======
+
+.. image:: cov_badge.svg
+.. image:: pytest_badge.svg

_sources/contributing_to_doc.rst.txt

@@ -0,0 +1,62 @@
+.. last updated early Nov 2024.
+   could use some refinement
+===========================
+Documentation-Documentation
+===========================
+
+Welcome to ``fre-cli``'s Documentation-documentation- where we document how the documentation is
+documented
+
+How to Contribute to ``fre-cli``'s documentation
+================================================
+
+
+
+fork and poke at the settings
+-----------------------------
+
+* Fork ``fre-cli`` on github
+
+* On github, navigate to your ``fre-cli`` fork, and click “settings”
+
+* In “settings”, click “pages”
+
+* In “pages”, under “build and deployment”, make sure “source” is set to “Deploy from a branch”
+
+* Under that, find “Branch”, make sure the branch selected is ``gh-pages``
+
+* The branch ``gh-pages`` is "automagic”- i.e. do not change anything about it nor create a new one,
+  nor interact with anything in that branch directly
+
+
+enable workflows for your fork
+------------------------------
+
+note: this step may depend on user-specific settings!
+
+* Back on top where you found “settings”, find and click “actions” to the left
+
+* Enable running the workflow actions assoc with the ``fre-cli`` repo under ``.github/workflows``
+
+
+run your fork's first workflow
+------------------------------
+
+* The documentation builds as the last steps to ``create_test_conda_env.yml`` when theres a push to ``main``
+
+* To get your first workflow run on your fork, comment out the ``github.ref == ‘refs/heads/main’`` bit
+  so that it runs when you push to any branch, and make a small, trivial, commit somewhere to your
+  remote fork
+
+* You should be able to find the deployed webpage from a successful workflow at
+  https://your_username.github.io/fre-cli (if you did not change the fork’s name from ``fre-cli``, that is)
+
+* If you’re only editing docs, you can make the turn-around time on your workflow ~3 min faster by
+  commenting-out the ``pylint`` and ``pytest`` steps in ``create_test_conda_env.yml``, and disable running the
+  ``build_conda.yml`` workflow
+
+
+
+Other Helpful Things
+====================
+`restructured text cheat-sheet <https://gist.github.com/SMotaal/24006b13b354e6edad0c486749171a70#sections>`_

_sources/for-developers.rst.txt

@@ -0,0 +1,118 @@
+===============
+For developers
+===============
+
+Developers are free to use the user guide above to familiarize with the CLI and save time from
+having to install any dependencies, but development within a Conda environment is heavily
+recommended regardless.
+
+Gain access to the repository with ``git clone --recursive git@github.com:NOAA-GFDL/fre-cli.git`` or your fork's
+link (recommended) and an SSH RSA key. Once inside the repository, developers can test local changes
+by running a ``pip install .`` inside of the root directory to install the ``fre-cli`` package locally
+with the newest local changes. Test as a normal user would use the CLI.
+
+
+Adding New Tools
+================
+
+
+From Other Repositories
+-----------------------
+
+Currently, the solution to this task is to approach it using Conda packages. The tool that is being
+added must reside within a repository that contains a ``meta.yaml`` that includes Conda dependencies
+like the one in this repository and ideally a ``setup.py`` (may be subject to change due to deprecation)
+that may include any potentially needed pip dependencies
+
+* Once published as a Conda package, ideally on the `NOAA-GFDL conda channel <https://anaconda.org/NOAA-GFDL>`_,
+  an addition can be made to the ``run`` section under ``requirements`` in ``meta.yaml`` of the ``fre-cli``
+  following the syntax ``channel::package``
+
+* On pushes to the main branch, the package located at https://anaconda.org/NOAA-GFDL/fre-cli will automatically
+  be updated using by the workflow defined in ``.github/workflows/publish_conda.yml``
+
+
+Checklist
+---------
+
+For the new tool you are trying to develop, there are a few criteria to satisfy
+
+1. Create a subdirectory for the tool group inside the ``fre/`` directory; i.e. ``fre/<tool>``
+
+2. Add an ``__init__.py`` inside of ``fre/<tool>`` 
+
+* typically this file should be empty, but it depends on the ``<tool>``'s needs
+* even if empty, the file facillitates module importability and must be present
+
+3. Add a file named ``fre/<tool>/fre<tool>.py``. This will serve as the main entry point for ``fre``
+   into the ``<tool>``'s functionality
+
+4. Add a ``click`` group named after ``<tool>`` within ``fre/<tool>/fre<tool>.py``
+
+* This ``click`` group will contain all the functionality under the ``<tool>``
+
+5. Create separate files as needed for different commands; do not code out the full
+   implemetation of ``<tool>`` inside of a ``click`` command within ``fre/<tool>/fre<tool>.py``.
+
+* better yet, consider what structure your tool may need in the future for maintainability's sake
+* if you need, specify a ``<subtool>`` like ``fre/<tool>/<subtool>``. ``fre/app`` currently has
+  this structure
+
+6. Be sure to import the contents of the needed subcommand scripts inside of ``fre<tool>.py``
+
+* i.e. from ``fre.<tool>.toolCommandScript import *``
+
+7. At this point, you can copy and paste the parts of your main ``click`` command from its script
+   into ``fre<tool>.py`` when implementing the function reflective of the command function
+
+* Everything will remain the same; i.e. arguments, options, etc.
+
+* However, this new function within ``fre<tool>.py`` must a new line after the arguments, options,
+  and other command components; ``@click.pass_context``
+
+* Along with this, a new argument ``context`` must now be added to the parameters of the command
+  (preferably at the beginning, but it won't break it if it's not)
+
+8. From here, all that needs to be added after defining the command with a name is
+   ``context.forward(mainFunctionOfToolCommand)``, and done!
+
+9. The last step is to replicate the command in the same way as done in ``fre<tool>.py``
+	inside of ``fre.py``, but make sure to add ``from fre import <tool>`` and
+	``from fre.<tool> import *``
+
+Please refer to this issue when encountering naming issues:
+`NOAA-GFDL#31 <https://github.com/NOAA-GFDL/fre-cli/issues/31>`_
+
+
+Example ``fre/`` Directory Structure
+------------------------------------
+
+``fre/``
+├── ``__init__.py``
+├── ``fre.py``
+├── ``fre<tool>``
+│   ├── ``__init__.py``
+│   ├── ``toolCommandScript.py``
+│   └── ``fre<tool>.py``
+
+
+``MANIFEST.in``
+---------------
+
+In the case where non-python files like templates, examples, and outputs are to be included in the ``fre-cli`` package,
+``MANIFEST.in`` can provide the solution. Ensure that the file exists within the correct folder, and add a line to the
+``MANIFEST.in`` file saying something like ``include fre/fre<tool>/fileName.fileExtension``
+
+* For more efficiency, if there are multiple files of the same type needed, the ``MANIFEST.in`` addition can be something
+  like ``recursive-include fre/fre<tool> *.fileExtension`` which would recursively include every file matching that
+  ``fileExtension`` within the specified directory and its respective subdirectories.
+
+
+Adding Documentation
+--------------------
+
+see section "Documentation-Documentation"
+
+
+
+

_sources/fre.app.freapp.rst.txt

@@ -0,0 +1,7 @@
+fre.app.freapp module
+=====================
+
+.. automodule:: fre.app.freapp
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.cdoTimeAverager.rst.txt

@@ -0,0 +1,7 @@
+fre.app.generate\_time\_averages.cdoTimeAverager module
+=======================================================
+
+.. automodule:: fre.app.generate_time_averages.cdoTimeAverager
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.frenctoolsTimeAverager.rst.txt

@@ -0,0 +1,7 @@
+fre.app.generate\_time\_averages.frenctoolsTimeAverager module
+==============================================================
+
+.. automodule:: fre.app.generate_time_averages.frenctoolsTimeAverager
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.frepytoolsTimeAverager.rst.txt

@@ -0,0 +1,7 @@
+fre.app.generate\_time\_averages.frepytoolsTimeAverager module
+==============================================================
+
+.. automodule:: fre.app.generate_time_averages.frepytoolsTimeAverager
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.generate_time_averages.rst.txt

@@ -0,0 +1,7 @@
+fre.app.generate\_time\_averages.generate\_time\_averages module
+================================================================
+
+.. automodule:: fre.app.generate_time_averages.generate_time_averages
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.rst.txt

@@ -0,0 +1,30 @@
+fre.app.generate\_time\_averages package
+========================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fre.app.generate_time_averages.tests
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fre.app.generate_time_averages.cdoTimeAverager
+   fre.app.generate_time_averages.frenctoolsTimeAverager
+   fre.app.generate_time_averages.frepytoolsTimeAverager
+   fre.app.generate_time_averages.generate_time_averages
+   fre.app.generate_time_averages.timeAverager
+
+Module contents
+---------------
+
+.. automodule:: fre.app.generate_time_averages
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.tests.rst.txt

@@ -0,0 +1,18 @@
+fre.app.generate\_time\_averages.tests package
+==============================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fre.app.generate_time_averages.tests.test_generate_time_averages
+
+Module contents
+---------------
+
+.. automodule:: fre.app.generate_time_averages.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.tests.test_generate_time_averages.rst.txt

@@ -0,0 +1,7 @@
+fre.app.generate\_time\_averages.tests.test\_generate\_time\_averages module
+============================================================================
+
+.. automodule:: fre.app.generate_time_averages.tests.test_generate_time_averages
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.generate_time_averages.timeAverager.rst.txt

@@ -0,0 +1,7 @@
+fre.app.generate\_time\_averages.timeAverager module
+====================================================
+
+.. automodule:: fre.app.generate_time_averages.timeAverager
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.mask_atmos_plevel.rst.txt

@@ -0,0 +1,7 @@
+fre.app.mask\_atmos\_plevel module
+==================================
+
+.. automodule:: fre.app.mask_atmos_plevel
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.regrid_xy.regrid_xy.rst.txt

@@ -0,0 +1,7 @@
+fre.app.regrid\_xy.regrid\_xy module
+====================================
+
+.. automodule:: fre.app.regrid_xy.regrid_xy
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.regrid_xy.rst.txt

@@ -0,0 +1,18 @@
+fre.app.regrid\_xy package
+==========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fre.app.regrid_xy.regrid_xy
+
+Module contents
+---------------
+
+.. automodule:: fre.app.regrid_xy
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.app.rst.txt

@@ -0,0 +1,28 @@
+fre.app package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fre.app.generate_time_averages
+   fre.app.regrid_xy
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   fre.app.freapp
+   fre.app.mask_atmos_plevel
+
+Module contents
+---------------
+
+.. automodule:: fre.app
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/fre.catalog.frecatalog.rst.txt

@@ -0,0 +1,7 @@
+fre.catalog.frecatalog module
+=============================
+
+.. automodule:: fre.catalog.frecatalog
+   :members:
+   :undoc-members:
+   :show-inheritance: