diff --git a/.github/workflows/check_formatting.yml b/.github/workflows/check_formatting.yml index b19a31fd..b6f8ec27 100644 --- a/.github/workflows/check_formatting.yml +++ b/.github/workflows/check_formatting.yml @@ -19,4 +19,5 @@ jobs: shell: bash -l {0} run: mamba install --quiet --yes --file requirements.txt black && - black tobac --check --diff + black --version && + black tobac --check --diff diff --git a/doc/tobac.rst b/doc/tobac.rst index 87cd45ab..5e651222 100644 --- a/doc/tobac.rst +++ b/doc/tobac.rst @@ -7,7 +7,26 @@ Submodules tobac.analysis module --------------------- -.. automodule:: tobac.analysis +tobac.analysis.cell_analysis module +--------------------- + +.. automodule:: tobac.analysis.cell_analysis + :members: + :undoc-members: + :show-inheritance: + +tobac.analysis.feature_analysis module +--------------------- + +.. automodule:: tobac.analysis.feature_analysis + :members: + :undoc-members: + :show-inheritance: + +tobac.analysis.spatial module +--------------------- + +.. automodule:: tobac.analysis.spatial :members: :undoc-members: :show-inheritance: @@ -71,18 +90,26 @@ tobac.tracking module tobac.utils modules ------------------ -tobac.utils.general module +tobac.utils.bulk_statistics module ------------------ -.. automodule:: tobac.utils.general +.. automodule:: tobac.utils.bulk_statistics :members: :undoc-members: :show-inheritance: -tobac.utils.bulk_statistics module +tobac.utils.decorators module ------------------ -.. automodule:: tobac.utils.bulk_statistics +.. automodule:: tobac.utils.decorators + :members: + :undoc-members: + :show-inheritance: + +tobac.utils.general module +------------------ + +.. automodule:: tobac.utils.general :members: :undoc-members: :show-inheritance: @@ -95,6 +122,14 @@ tobac.utils.mask module :undoc-members: :show-inheritance: +tobac.utils.periodic_boundaries module +------------------ + +.. automodule:: tobac.utils.periodic_boundaries + :members: + :undoc-members: + :show-inheritance: + tobac.wrapper module -------------------- diff --git a/examples/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D.ipynb b/examples/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D.ipynb index 00702937..35c026ab 100644 --- a/examples/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D.ipynb +++ b/examples/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D.ipynb @@ -36,17 +36,19 @@ "cell_type": "code", "execution_count": 1, "id": "46abd7ad", - "metadata": { - "execution": { - "iopub.execute_input": "2024-02-17T12:46:46.604370Z", - "iopub.status.busy": "2024-02-17T12:46:46.603803Z", - "iopub.status.idle": "2024-02-17T12:47:02.061962Z", - "shell.execute_reply": "2024-02-17T12:47:02.059167Z" + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "using tobac version 1.5.2\n" + ] } - }, - "outputs": [], + ], "source": [ "import tobac\n", + "print('using tobac version', str(tobac.__version__))\n", "\n", "# we add testing here to create test dataset (typically not needed in standard applications)\n", "import tobac.testing" @@ -64,14 +66,7 @@ "cell_type": "code", "execution_count": 2, "id": "a28f3ba2", - "metadata": { - "execution": { - "iopub.execute_input": "2024-02-17T12:47:02.069480Z", - "iopub.status.busy": "2024-02-17T12:47:02.068740Z", - "iopub.status.idle": "2024-02-17T12:47:03.098546Z", - "shell.execute_reply": "2024-02-17T12:47:03.096911Z" - } - }, + "metadata": {}, "outputs": [], "source": [ "import matplotlib.pyplot as plt\n", @@ -93,14 +88,7 @@ "cell_type": "code", "execution_count": 3, "id": "fd75ee85", - "metadata": { - "execution": { - "iopub.execute_input": "2024-02-17T12:47:03.105232Z", - "iopub.status.busy": "2024-02-17T12:47:03.104769Z", - "iopub.status.idle": "2024-02-17T12:47:03.716692Z", - "shell.execute_reply": "2024-02-17T12:47:03.715384Z" - } - }, + "metadata": {}, "outputs": [], "source": [ "import seaborn as sns\n", @@ -137,14 +125,7 @@ "cell_type": "code", "execution_count": 4, "id": "1ecce2f7", - "metadata": { - "execution": { - "iopub.execute_input": "2024-02-17T12:47:03.720546Z", - "iopub.status.busy": "2024-02-17T12:47:03.720174Z", - "iopub.status.idle": "2024-02-17T12:47:03.806021Z", - "shell.execute_reply": "2024-02-17T12:47:03.805262Z" - } - }, + "metadata": {}, "outputs": [ { "data": { @@ -521,7 +502,7 @@ " latitude (y, x) float64 ...\n", " longitude (y, x) float64 ...\n", "Attributes:\n", - " units: m s-1
<xarray.DataArray 'w' ()>\n", - "array(10.)" + "array(10.) " ], "text/plain": [ "
Segmentation Mask (unknown) | \n", - "time | \n", - "projection_y_coordinate | \n", - "projection_x_coordinate | \n", - "
---|---|---|---|
Shape | \n", - "100 | \n", - "50 | \n", - "100 | \n", - "
Dimension coordinates | \n", - "\n", - " | \n", - " | \n", - " |
\ttime | \n", - "x | \n", - "- | \n", - "- | \n", - "
\tprojection_y_coordinate | \n", - "- | \n", - "x | \n", - "- | \n", - "
\tprojection_x_coordinate | \n", - "- | \n", - "- | \n", - "x | \n", - "
Auxiliary coordinates | \n", - "\n", - " | \n", - " | \n", - " |
\tlatitude | \n", - "- | \n", - "x | \n", - "x | \n", - "
\tlongitude | \n", - "- | \n", - "x | \n", - "x | \n", - "