Chore/bump code coverage

.github/workflows/ci.yml

@@ -39,6 +39,9 @@ jobs:
           poetry config virtualenvs.in-project false
           poetry config virtualenvs.path ~/.virtualenvs
 
+      - name: Install netcdf4
+        run: poetry run pip install netcdf4
+
       - name: Install Dependencies
         run: poetry install
         if: steps.cache.outputs.cache-hit != 'true'

README.md

@@ -11,6 +11,27 @@
 # Official Documentation.
 Check our official GitHub pages documentation at [https://deltares.github.io/NBSDynamics/](https://deltares.github.io/NBSDynamics/).
 
+# Quickguide
+Thanks to the latest version of Pypi you can get all setup by just installing the package in the edit mode, so we offer the following options:
+
+* Contributing to the project:
+    * [Full guide](https://deltares.github.io/NBSDynamics/guides/contribute/)
+    * Quick installation (without poetry) __for development__: 
+        * Navigate to the checked-out directory.
+        * Update your 'pip' to the latest version.
+        * Install the package in edit mode:
+        ```cli
+        pip install -e .
+        ```
+* Using the package as an external library:
+    ```cli
+    pip install git+https://github.com/Deltares/NBSDynamics.git
+    ```
+    | We recommend installing the latest available release at the time instead of from 'master'. For that just add @branch_name at the end of the previous pip call. 
+
+### Potential Errors
+We found out that packages such as `netcdf4` or `pypiwin32` / `pywin32` might give problems. In case you run against said problems while installing the package we recommend installing them beforehand.
+
 # Current supported models.
 Currently we support the Vegetation and Coral models. More details of how to run them can be found at their respective documentation pages.
 In addition, quick links on how to run models in this package:

docs/guides/contribute.md

@@ -26,6 +26,18 @@ After installation, make sure it's available on your `PATH` and run it in the HY
 To install the package (by default in editable mode) run `poetry install`. We advise using `virtualenv`s, Poetry will create one for you.
 If you need to use an already existing Python installation, you can activate it and run `poetry env use system` before `poetry install`.
 
+#### Pip
+Latest versions of `pip` support installing packages from a .toml file. This streamlines the process so that you do not need to use poetry (although we highly recommend it in order to add packages that are compliant with the rest of the repository).
+
+You can easily develop your own features using the pip edit mode from the root of the NBSDynamics checked out repository:
+
+```
+pip install -e .
+```
+
+#### Known issues 
+We found out that packages such as `netcdf4` or `pypiwin32` / `pywin32` might give problems. In case you run against said problems while installing the package we recommend installing them beforehand.
+
 ### 1.2. Code convention / Linters
 This project uses both black and isort as an autoformatter. It is recommended following the rules defined in pyproject.toml to avoid conflicts before a merge.