v0.5.8 (#102)

* Delete test-requirements.txt

This file is no longer used

* Delete pkg-requirements.txt

This file is no longer used

* Clearer badges

Fix breaklines in badge

* Update dependabot.yml

* Update dependabot.yml as in master

* Bump actions/configure-pages from 4 to 5 (#87)

Bumps [actions/configure-pages](https://github.com/actions/configure-pages) from 4 to 5.
- [Release notes](https://github.com/actions/configure-pages/releases)
- [Commits](actions/configure-pages@v4...v5)

---
updated-dependencies:
- dependency-name: actions/configure-pages
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump pyarrow from 15.0.0 to 15.0.2 (#92)

* Update dependabot.yml

* Bump pyarrow from 15.0.0 to 15.0.2

Bumps [pyarrow](https://github.com/apache/arrow) from 15.0.0 to 15.0.2.
- [Commits](apache/arrow@go/v15.0.0...go/v15.0.2)

---
updated-dependencies:
- dependency-name: pyarrow
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Samuel Juhel <10011382+spjuhel@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump pydata-sphinx-theme from 0.13.3 to 0.15.2 (#91)

* Update dependabot.yml

* Bump pydata-sphinx-theme from 0.13.3 to 0.15.2

Bumps [pydata-sphinx-theme](https://github.com/pydata/pydata-sphinx-theme) from 0.13.3 to 0.15.2.
- [Release notes](https://github.com/pydata/pydata-sphinx-theme/releases)
- [Changelog](https://github.com/pydata/pydata-sphinx-theme/blob/main/RELEASE.md)
- [Commits](pydata/pydata-sphinx-theme@v0.13.3...v0.15.2)

---
updated-dependencies:
- dependency-name: pydata-sphinx-theme
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Samuel Juhel <10011382+spjuhel@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump ipykernel from 6.29.2 to 6.29.4 (#90)

* Update dependabot.yml

* Bump ipykernel from 6.29.2 to 6.29.4

Bumps [ipykernel](https://github.com/ipython/ipykernel) from 6.29.2 to 6.29.4.
- [Release notes](https://github.com/ipython/ipykernel/releases)
- [Changelog](https://github.com/ipython/ipykernel/blob/v6.29.4/CHANGELOG.md)
- [Commits](ipython/ipykernel@v6.29.2...v6.29.4)

---
updated-dependencies:
- dependency-name: ipykernel
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Samuel Juhel <10011382+spjuhel@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump progressbar2 from 4.4.1 to 4.4.2 (#89)

Bumps [progressbar2](https://github.com/wolph/python-progressbar) from 4.4.1 to 4.4.2.
- [Release notes](https://github.com/wolph/python-progressbar/releases)
- [Changelog](https://github.com/wolph/python-progressbar/blob/develop/CHANGES.rst)
- [Commits](wolph/python-progressbar@v4.4.1...v4.4.2)

---
updated-dependencies:
- dependency-name: progressbar2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* 📝 🚧 Update documentation of Events

* 📝 Event doc update [WIP]

* 🤖 📝 Updated doc building config

Notably fixes some problems with typehints
[WIP] On improving the overal structure of the API

* 📝 New autoapi directory

* remove doc build folder from git tracking

* 📝 (event): Doc update

Better description of each type of events

Also some brief descriptions in the main module docstring and model base.

* 📝 Update documentation structure, WIP for doc versionning

- Use of autosummary instead of autoapimod for simplicity and per Class page.
Thus update of the module and class templates

- Added a python script to build the doc for multiple versions (untested)
- Added a version switcher to the website

* Fix filename for versions (testing)

* testing

* fix doc output path and static website

* remove edit this page button (failing at the moment)

* fixed build dir for doc

* updated switcher.json

* fixed switcher

* fixing commas

* fixed switcher link

* updated gitignore

* 📝 Update documentation structure

* Created a Tutorials page instead of the Examples one
* Updated the quickstart example to streamline it
* Separated the differents subsection of the one pager into their own pages for clarity and future improvements of those pages.
* Moved the pages on event definitions

* Bump black from 23.12.1 to 24.4.0 (#101)

Bumps [black](https://github.com/psf/black) from 23.12.1 to 24.4.0.
- [Release notes](https://github.com/psf/black/releases)
- [Changelog](https://github.com/psf/black/blob/main/CHANGES.md)
- [Commits](psf/black@23.12.1...24.4.0)

---
updated-dependencies:
- dependency-name: black
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* poetry update

* black with v24

* Bump sphinx-autoapi from 2.1.1 to 3.0.0 (#99)

Bumps [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi) from 2.1.1 to 3.0.0.
- [Release notes](https://github.com/readthedocs/sphinx-autoapi/releases)
- [Changelog](https://github.com/readthedocs/sphinx-autoapi/blob/main/CHANGELOG.rst)
- [Commits](readthedocs/sphinx-autoapi@v2.1.1...v3.0.0)

---
updated-dependencies:
- dependency-name: sphinx-autoapi
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Cleanup wrongly add file

* bump version

* update paper.md and paper.bib

Added a paragraph on other existing implementation
in state of need section.

* Update quickstart notebook

* update build_doc so that latest doc is in root html

* 📝 Documentation update

- Added conda-forge install
- updated some urls
- updated python version and OS supported.
- Some minor changes here and there (e.g., mrio -> mriot)

* 📝 found a typo

* Improved model lit review section

* update version switcher files

* possible typo in switcher

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: sjuhel <pro@sjuhel.org>

Author: spjuhel

.gitignore

@@ -8,6 +8,7 @@ archive.py
 pyrightconfig.json
 shortlicence
 src/docs/source/_build
+docs/pages
 testing
 
 snakejob.*
@@ -23,7 +24,6 @@ launch.json
 __pycache__/
 *.py[cod]
 *$py.class
-*.ipynb
 
 # C extensions
 *.so

README.rst

@@ -4,33 +4,27 @@
 #######
 BoARIO
 #######
+|build-status| |black| |contribute| |licence| |pypi| |pythonv| |joss|
 
-
-.. image:: https://img.shields.io/github/actions/workflow/status/spjuhel/boario/CI.yml
+.. |build-status| image:: https://img.shields.io/github/actions/workflow/status/spjuhel/boario/CI.yml
    :target: https://github.com/spjuhel/BoARIO/actions/workflows/CI.yml
    :alt: GitHub Actions Workflow Status
-
-.. image:: https://img.shields.io/badge/code%20style-black-000000
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000
    :target: https://github.com/psf/black
    :alt: Code Style - Black
-
-.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
+.. |contribute| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
    :target: https://github.com/spjuhel/BoARIO/issues
    :alt: Contribution - Welcome
-
-.. image:: https://img.shields.io/badge/License-GPLv3-blue
+.. |licence| image:: https://img.shields.io/badge/License-GPLv3-blue
    :target: https://www.gnu.org/licenses/gpl-3.0
    :alt: Licence - GPLv3
-
-.. image:: https://img.shields.io/pypi/v/boario
+.. |pypi| image:: https://img.shields.io/pypi/v/boario
    :target: https://pypi.org/project/boario/
    :alt: PyPI - Version
-
-.. image:: https://img.shields.io/pypi/pyversions/boario
+.. |pythonv| image:: https://img.shields.io/pypi/pyversions/boario
    :target: https://pypi.org/project/boario/
    :alt: PyPI - Python Version
-
-.. image:: https://joss.theoj.org/papers/71386aa01a292ecff8bafe273b077701/status.svg
+.. |joss| image:: https://joss.theoj.org/papers/71386aa01a292ecff8bafe273b077701/status.svg
    :target: https://joss.theoj.org/papers/71386aa01a292ecff8bafe273b077701
    :alt: Joss Status
 
@@ -88,6 +82,12 @@ You can install BoARIO from ``pip`` with:
 
    pip install boario
 
+Or from ``conda-forge`` using conda (or mamba):
+
+.. code:: console
+
+   conda install -c conda-forge boario
+
 
 The full source code is also available on Github at: https://github.com/spjuhel/BoARIO
 
@@ -113,7 +113,7 @@ And produce the following outputs:
 Example of use
 =================
 
-See `Boario quickstart <https://spjuhel.github.io/BoARIO/boario-quickstart.html>`_.
+See `Boario quickstart <https://spjuhel.github.io/BoARIO/boario-tutorials.html>`_.
 
 Credits
 ========
@@ -134,7 +134,7 @@ This work was supported by the French Environment and Energy Management Agency
 Development
 ------------
 
-* Samuel Juhel (pro@sjuhel.org)
+** Samuel Juhel (pro@sjuhel.org)
 
 Contributions
 ---------------

boario/__init__.py

@@ -13,6 +13,9 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""BoARIO : The Adaptative Regional Input Output model in python."""
+
 try:
     import coloredlogs as coloredlogs  # noqa: F401
 except ImportError: