From 1c1c8269f2ddf53b35f5b9afa68c121a47e4cde7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 29 Nov 2024 16:46:09 +0000 Subject: [PATCH] Update documentation --- _sources/docfiles/markdown/QUICKSTART.md.txt | 17 ----- .../docfiles/markdown/TROUBLESHOOTING.md.txt | 9 --- .../additional_modules/logconfig.html | 2 +- docfiles/code/vibe_core_data/core_types.html | 66 +++++++++++++++--- docfiles/code/vibe_core_data/rasters.html | 2 +- docfiles/markdown/QUICKSTART.html | 15 ---- docfiles/markdown/TROUBLESHOOTING.html | 7 -- genindex.html | 10 ++- objects.inv | Bin 7778 -> 7819 bytes searchindex.js | 2 +- 10 files changed, 70 insertions(+), 60 deletions(-) diff --git a/_sources/docfiles/markdown/QUICKSTART.md.txt b/_sources/docfiles/markdown/QUICKSTART.md.txt index 878f3b27..6963a861 100644 --- a/_sources/docfiles/markdown/QUICKSTART.md.txt +++ b/_sources/docfiles/markdown/QUICKSTART.md.txt @@ -22,9 +22,6 @@ In order to run FarmVibes.AI cluster, you need the following: the repository. If you already have access to the source code, then Git is not required. - * [Git LFS](https://git-lfs.com/) to restore some of the large files in the - repository (e.g., model weights). - * [Docker](https://docs.docker.com/engine/install/ubuntu/). Make sure you can run the docker client without running `sudo` by adding your user account to the `docker` group (which might require a logout/login when adding oneself @@ -63,20 +60,6 @@ bash ./resources/vm/setup_farmvibes_ai_vm.sh You might needed to restart your shell session once the script finishes. -## Restore files with Git LFS - -In case you did not have Git LFS installed when cloning the repository, you will need to do so -to restore the large files in the repository. Note that the last step -["Installing software dependencies](#optional-installing-software-dependencies) already installs -Git LFS. - -To restore the missing files, you can run the following command in the root of the repository: - -```shell -git lfs install -git lfs pull -``` - ## Install the FarmVibes.AI cluster With python3.8+ and pip installed on your machine, please install diff --git a/_sources/docfiles/markdown/TROUBLESHOOTING.md.txt b/_sources/docfiles/markdown/TROUBLESHOOTING.md.txt index ca53bfde..d3e54963 100644 --- a/_sources/docfiles/markdown/TROUBLESHOOTING.md.txt +++ b/_sources/docfiles/markdown/TROUBLESHOOTING.md.txt @@ -122,15 +122,6 @@ that are currently being addressed by the development team. -
- Updating cluster in the `dev` branch after pulling files with Git LFS - - If you did not have Git LFS installed when cloning the repository and checking out to `dev`, - you will be missing some of the large files in the repository (e.g., ONNX models). Make sure - to install and setup Git LFS as described in the [Quickstart guide](QUICKSTART.md#restore-files-with-git-lfs). - You will also need to update your cluster with `make local`. -
-
- **Composing and running workflows:** diff --git a/docfiles/code/vibe_core_client/additional_modules/logconfig.html b/docfiles/code/vibe_core_client/additional_modules/logconfig.html index bb44a0ed..d36e8fee 100644 --- a/docfiles/code/vibe_core_client/additional_modules/logconfig.html +++ b/docfiles/code/vibe_core_client/additional_modules/logconfig.html @@ -208,7 +208,7 @@
-vibe_core.logconfig.configure_logging(default_level=None, logdir=None, max_log_file_bytes=None, log_backup_count=None, logfile='8e72b7ebc1a2.log', json=True, appname='')
+vibe_core.logconfig.configure_logging(default_level=None, logdir=None, max_log_file_bytes=None, log_backup_count=None, logfile='2b1f2ea3e47e.log', json=True, appname='')

Configure logging for the calling process.

This method will create a logger and set its level to the given default_level argument. It will also create a StreamHandler and FileHandler if the logdir argument is provided, diff --git a/docfiles/code/vibe_core_data/core_types.html b/docfiles/code/vibe_core_data/core_types.html index 2f1e4a2a..6defdf9d 100644 --- a/docfiles/code/vibe_core_data/core_types.html +++ b/docfiles/code/vibe_core_data/core_types.html @@ -69,6 +69,7 @@

  • AssetVibe
  • BaseVibe
  • CarbonOffsetInfo
    • +
  • ChipWindow
  • DataSequence
  • DataSummaryStatistics
  • DataVibe
    • @@ -92,7 +93,6 @@
  • get_filtered_init_fields()
  • get_init_field_names()
  • BBox
    • -
  • ChipWindow
  • Point
  • TimeRange
    • @@ -352,6 +352,63 @@

    Hierarchy +
    +class vibe_core.data.core_types.ChipWindow(col_offset, row_offset, width, height)
    +

    Bases: tuple

    +

    Represent a window of a raster chip.

    +
    +
    +
    +
    +col_offset
    +

    The column offset of the window with relation to the raster chip.

    +
    + +
    +
    +row_offset
    +

    The row offset of the window with relation to the raster chip.

    +
    + +
    +
    +width
    +

    The width of the window.

    +
    + +
    +
    +height
    +

    The height of the window.

    +
    + +
    +
    +col_offset: float
    +

    Alias for field number 0

    +
    + +
    +
    +height: float
    +

    Alias for field number 3

    +
    + +
    +
    +row_offset: float
    +

    Alias for field number 1

    +
    + +
    +
    +width: float
    +

    Alias for field number 2

    +
    + +

    +
    class vibe_core.data.core_types.DataSequence(id, time_range, geometry, assets, asset_order=<factory>, asset_time_range=<factory>, asset_geometry=<factory>)
    @@ -1223,13 +1280,6 @@

    HierarchyTuple[float, float, float, float]

    -
    -
    -vibe_core.data.core_types.ChipWindow
    -

    Type alias representing a raster chip window, as (col_offset, row_offset, width, height).

    -

    alias of Tuple[float, float, float, float]

    -
    -
    vibe_core.data.core_types.Point
    diff --git a/docfiles/code/vibe_core_data/rasters.html b/docfiles/code/vibe_core_data/rasters.html index 1ab4f259..a6f5d8de 100644 --- a/docfiles/code/vibe_core_data/rasters.html +++ b/docfiles/code/vibe_core_data/rasters.html @@ -416,7 +416,7 @@

    Hierarchy
    -chip_window: Tuple[float, float, float, float]
    +chip_window: ChipWindow

    The chip window (col_offset, row_offset, width, height) covered by this raster.

    diff --git a/docfiles/markdown/QUICKSTART.html b/docfiles/markdown/QUICKSTART.html index fa0f13fe..b4618953 100644 --- a/docfiles/markdown/QUICKSTART.html +++ b/docfiles/markdown/QUICKSTART.html @@ -53,7 +53,6 @@
  • Requirements
  • Clone the repository
  • Optional: Installing software dependencies
    • -
  • Restore files with Git LFS
  • Install the FarmVibes.AI cluster
  • Check FarmVibes.AI Installation
    • @@ -129,8 +128,6 @@

    RequirementsGit to download the repository. If you already have access to the source code, then Git is not required.

    -

  • Git LFS to restore some of the large files in the -repository (e.g., model weights).

  • Docker. Make sure you can run the docker client without running sudo by adding your user account to the docker group (which might require a logout/login when adding oneself @@ -165,18 +162,6 @@

    Optional: Installing software dependencies -

    Restore files with Git LFS

    -

    In case you did not have Git LFS installed when cloning the repository, you will need to do so -to restore the large files in the repository. Note that the last step -“Installing software dependencies already installs -Git LFS.

    -

    To restore the missing files, you can run the following command in the root of the repository:

    -
    git lfs install
-git lfs pull
-
    -
    -

    Install the FarmVibes.AI cluster

    With python3.8+ and pip installed on your machine, please install diff --git a/docfiles/markdown/TROUBLESHOOTING.html b/docfiles/markdown/TROUBLESHOOTING.html index b7162d0d..d8ce860f 100644 --- a/docfiles/markdown/TROUBLESHOOTING.html +++ b/docfiles/markdown/TROUBLESHOOTING.html @@ -195,13 +195,6 @@

    Troubleshootingdev, -you will be missing some of the large files in the repository (e.g., ONNX models). Make sure -to install and setup Git LFS as described in the Quickstart guide. -You will also need to update your cluster with make local.

    -


    • diff --git a/genindex.html b/genindex.html index 40b25eb0..ccd3d192 100644 --- a/genindex.html +++ b/genindex.html @@ -290,7 +290,7 @@

    C

  • chip_window (vibe_core.data.rasters.SamMaskRaster attribute)
    • -
  • ChipWindow (in module vibe_core.data.core_types) +
  • ChipWindow (class in vibe_core.data.core_types)
  • ChirpsProduct (class in vibe_core.data.products)
    • @@ -317,6 +317,8 @@

    C

  • CloudRaster (class in vibe_core.data.rasters)
  • ClusterType (class in vibe_core.client) +
    • +
  • col_offset (vibe_core.data.core_types.ChipWindow attribute), [1]
  • configure_logging() (in module vibe_core.logconfig)
    • @@ -715,6 +717,8 @@

    H