Remove examples and update docs

.gitignore

@@ -1,4 +1,2 @@
 .idea
-Pipfile.lock
-*-checkpoint.ipynb
 docs/_build

README.md

@@ -9,12 +9,11 @@ temporal and spatio-temporal data based on [MobilityDB](https://mobilitydb.com/)
 
 PyMEOS is a library built on top of MEOS that provides all of its functionality wrapped in a set of Python classes.
 
-This repository contains 3 subprojects:
+This repository contains 2 subprojects:
 
 - [PyMEOS CFFI](./pymeos_cffi): wrapper of the MEOS C Library built using CFFI.
 - [PyMEOS](./pymeos): library that exposes the set of classes that should be used by the developer. Built on top of
   PyMEOS CFFI.
-- [PyMEOS Examples](./pymeos_examples): set of example programs using PyMEOS.
 
 # Usage
 
@@ -50,6 +49,8 @@ print(f'Speeds: {speed}')
 pymeos_finalize()
 ````
 
+For more examples, see [PyMEOS Examples repository](https://github.com/MobilityDB/PyMEOS-Examples)
+
 # Documentation
 
 Visit our [ReadTheDocs page](https://pymeos.readthedocs.io/en/latest/) for a more complete and detailed documentation, including an installation manual and several examples.

docs/conf.py

@@ -47,3 +47,23 @@
 
 html_theme = 'sphinx_book_theme'
 html_static_path = ['_static']
+
+import requests
+
+
+def download_file(url, dest_path):
+    response = requests.get(url, stream=True)
+    response.raise_for_status()  # Ensure we got a successful response
+
+    with open(dest_path, 'wb') as file:
+        for chunk in response.iter_content(chunk_size=8192):
+            file.write(chunk)
+
+
+prefix = "https://raw.githubusercontent.com/MobilityDB/PyMEOS-Examples/main/"
+download_file(
+    f"{prefix}PyMEOS_Examples/AIS.ipynb",
+    "src/examples/AIS.ipynb")
+download_file(
+    f"{prefix}PyMEOS_Examples/BerlinMOD.ipynb",
+    "src/examples/BerlinMOD.ipynb")

docs/src/examples.rst

@@ -2,7 +2,7 @@ Examples
 ====================
 
 Section under construction. However, you can check the existing examples available in the
-`PyMEOS repository <https://github.com/MobilityDB/PyMEOS>`__ and the
+`PyMEOS Examples repository <https://github.com/MobilityDB/PyMEOS_Examples>`__ and the
 `PyMEOS-Demo repository <https://github.com/Diviloper/PyMEOS-demo>`__.
 
 .. toctree::

docs/src/installation.rst

@@ -19,12 +19,12 @@ time of the PyMEOS release. Install the binary wheel with pip as follows:
     $ pip install pymeos
 
 
-Installation using conda (incoming, not available yet)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Installation using conda
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 PyMEOS is available on the conda-forge channel. Install as follows::
 
-    $ conda install pymeos --channel conda-forge
+    $ conda install conda-forge::pymeos
 
 
 Installation from source with custom MEOS library