[JTH] add more docs to new sphinx documentation

Author: tausiaj

bluemath_tk/interpolation/rbf.py

@@ -162,6 +162,7 @@ class RBF(BaseInterpolation):
         )
 
         rbf = RBF()
+
         predictions = rbf.fit_predict(
             subset_data=subset,
             subset_directional_variables=["Dir"],
@@ -172,11 +173,7 @@ class RBF(BaseInterpolation):
             num_workers=4,
             iteratively_update_sigma=True,
         )
-
-        rbf.get_metrics(
-            data1=target,
-            data2=predictions.drop(columns=["DirPred_u", "DirPred_v"], inplace=False),
-        )
+        print(predictions.head())
 
     References
     ----------

docs/source/_static/bluemath-logo.png

@@ -19,6 +19,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.doctest",
     "jupyter_sphinx",
+    "myst_parser",
 ]
 
 templates_path = ["_templates"]

docs/source/_static/sketch_tk.png

@@ -0,0 +1,115 @@
+# Contributions
+
+Thank you for considering contributing to the BlueMath package! We welcome contributions from the community and are grateful for your support.
+
+## How to Contribute
+
+### 1. Fork the Repository (skip if you are GeoOcean)
+
+Start by forking the repository to your GitHub account. This will create a copy of the repository under your GitHub account.
+
+### 2. Clone the Repository
+
+Clone the forked repository to your local machine using the following command:
+
+```sh
+git clone https://github.com/geoocean/BlueMath.git
+```
+
+### 3. Create a branch
+
+Create a new branch for your contribution. Use a descriptive name for your branch:
+
+```sh
+git checkout -b feature/your-feature-name
+```
+
+An example branch could be `feature/xbeach-wrapper`.
+
+### 4. Make changes
+
+Make the necessary changes to the codebase. Ensure that your code follows the project's coding standards and guidelines.
+
+### 5. Commit changes
+
+```sh
+git add .
+git commit -m "Add your commit message here"
+```
+
+### 6. Push changes
+
+Push your changes to your forked repository (Remember repo is not forked if your GeoOcean):
+
+```sh
+git push origin feature/your-feature-name
+```
+
+### 7. Create a Pull Request
+
+Go to the original repository on GitHub and create a pull request from your forked repository. Provide a clear and detailed description of your changes and the problem they solve.
+
+### 8. Review Process
+
+Your pull request will be reviewed by the maintainers. Please be responsive to any feedback or questions they may have. Once your pull request is approved, it will be merged into the main branch.
+
+### 9. Reporting Issues
+
+If you encounter any issues or bugs, please report them by creating a new issue on the GitHub repository. Provide as much detail as possible to help us understand and resolve the issue.
+
+### 10. Code of Conduct
+
+Please adhere to our Code of Conduct to ensure a welcoming and inclusive environment for everyone.
+
+### 11. License
+
+By contributing to the BlueMath package, you agree that your contributions will be licensed under the MIT License.
+
+### 12. Contact
+
+If you have any questions or need further assistance, feel free to reach out to the maintainers.
+
+Thank you for your contributions and support!
+
+## Documentation
+
+When creating new `python` code, it is essential to properly document all new classes and functions. Below, we show how the **docstrings** of classes should look, so the community can properly learn how to use **BlueMath**.
+
+Code example:
+```python
+import numpy as np
+
+class HyWavesExample:
+    """
+    This class implements a HyWaves Metamodel Example for nearshore wave propagations.
+
+    Attributes
+    ----------
+    waves_model : str
+        The waves numerical model to use.
+    statistical_model : str, optional
+        The statistical model to use. Default is "MDA".
+
+    Methods
+    -------
+    run_model -> np.ndarray
+        Runs the waves numerical model and returns the output.
+    """
+
+    def __init__(self, waves_model: str, statistical_model: str = "MDA") -> None:
+        self.waves_model = waves_model
+        self.statistical_model = statistical_model
+
+    def run_model(self, launcher: str) -> np.ndarray:
+        """
+        Runs the numerical waves model.
+
+        Parameters
+        ----------
+        launcher : str
+            The launcher to use.
+        """
+
+        self.run_model(launcher=launcher, model=self.waves_model)
+        return self.get_model_ouput()
+```

docs/source/conf.py

@@ -15,6 +15,9 @@ documentation for details.
    :maxdepth: 2
    :caption: Contents:
 
+   intro
+   installation
+   contribute
    modules
 
 Indices and tables

docs/source/contribute.md

@@ -0,0 +1,26 @@
+# Installation for Developers
+
+BlueMath is already available via `pip` or `conda`.
+
+To test its capabilities locally, please run the following commands:
+
+1. Clone the repository from GitHub:
+```sh
+git clone https://github.com/GeoOcean/BlueMath_tk.git
+```
+2. Move inside the directory to install everything:
+```sh
+cd BlueMath_tk
+```
+3. Create a compatible conda environment:
+```sh
+conda env create -f environment.yml
+```
+4. Then activate the environment using:
+```sh
+conda activate bluemath
+```
+5. Finally, install package in development mode:
+```sh
+pip install -e .
+```

docs/source/index.rst

@@ -0,0 +1,17 @@
+# Introduction
+
+<img src="_static/sketch_tk.png" alt="picture" width="800"/>
+
+## Installation
+
+```sh
+pip install bluemath-tk
+```
+
+## Authors
+
+Demo codes have been developed through a collaborative effort by members of the GeoOcean group at the University of Cantabria. For inquiries, please contact Fernando Méndez at mendezf@unican.es
+
+## Project status
+
+- UNDER DEVELOPMENT

docs/source/installation.md

@@ -50,7 +50,7 @@ dependencies = [
 
 [project.optional-dependencies]
 
-docs = ["sphinx", "sphinx-rtd-theme", "jupyter-sphinx"]
+docs = ["sphinx", "sphinx-rtd-theme", "jupyter-sphinx", "myst-parser"]
 deep = ["tensorflow", "keras"]
 num-models = ["hydromt-sfincs"]
 waves = ["wavespectra"]