anta-database 0.1.2__tar.gz → 0.1.4__tar.gz

anta_database-0.1.4/.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Deploy Jupyter Book to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'book/**' # Only trigger if changes are in the book/ folder
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          pip install jupyter-book ghp-import
+
+      - name: Build Jupyter Book
+        run: |
+          jupyter-book build book/
+
+      # Upload the book's HTML as an artifact
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "book/_build/html"
+
+      # Deploy the book's HTML to GitHub Pages
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

anta_database-0.1.4/.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+a[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+b[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/anta-database
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

anta_database-0.1.4/.gitignore

@@ -0,0 +1,8 @@
+*__pycache__/
+/anta_database.egg-info/
+*build/
+*.pyc
+venv/
+.env
+dist/
+archives/

anta_database-0.1.4/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: anta_database
+Version: 0.1.4
+Summary: SQLite database for the AntArchitecture Community Data
+Author: Antoine Hermant
+Author-email: antoine.hermant@etik.com
+License-Expression: MIT
+Project-URL: Homepage, https://antoinehermant.github.io/anta_database/intro
+Project-URL: Documentation, https://antoinehermant.github.io/anta_database/quick_start
+Project-URL: Repository, https://github.com/antoinehermant/anta_database.git
+Project-URL: Issues, https://github.com/antoinehermant/anta_database/issues
+Keywords: isochrones,database,IRH,radar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Programming Language :: Python
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: pyproj
+Requires-Dist: matplotlib
+Requires-Dist: colormaps
+Dynamic: license-file
+
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/antoinehermant/anta_database/main/book/logo.png" width="200">
+</h1><br>
+
+[![PyPi](https://img.shields.io/pypi/v/anta_database)](https://pypi.org/project/anta_database/)
+[![Downloads](https://img.shields.io/pypi/dm/anta_database)](https://pypi.org/project/anta_database)
+
+[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/antoinehermant/anta_database/issues)
+<!-- [![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://matplotlib.org/stable/devel/index.html) -->
+
+AntADatabase is an efficient SQLite database for browsing, visualizing and processing Internal Reflecting Horizons (isochrones) across Antarctica, curated by the AntArchitecture action group. It is specifically designed for ice dynamic modelers who need a fast, memory-efficient data structure to constrain their models.
+
+Visit the [Home Page](https://antoinehermant.github.io/anta_database/intro) for more information.
+
+# SQLite Database
+
+The database uses SQLite for efficient indexing. Data is sourced from the associated DOIs and stored as binary DataFrame files for each layer (IRH) and trace ID. This structure enables:
+
+-   Browsing by author (region), layer age, or trace ID.
+-   Memory efficiency: Only relevant data is read when needed.
+-   Fast read performance: Lightweight and optimized for speed.
+
+# Key Features
+
+-   Efficient SQLite indexing
+-   Quick visualization on Antarctica map
+-   Generate lazy data for later use
+
+# Installation
+
+The Python module can be directly installed from [PyPI](https://pypi.org/project/anta-database/) with:
+
+    pip install anta_database
+
+Note that this module is new and under development, so that the [PyPI](https://pypi.org/project/anta-database/) package may not contain the latest features. For the latest version and development, see the instruction below.
+To get started with the anta_database module, see the [Documentation](https://antoinehermant.github.io/anta_database).
+Also, you need the actual data to use this module. It is currently not available on any public repository, so please contact me.
+
+## Advanced installation
+
+One can install the latest commit from this GitHub directory with:
+
+    pip install git+https://github.com/antoinehermant/anta_database.git
+
+Or for development, you should clone this repo and install the module in development mode:
+
+    git clone git@github:antoinehermant/anta_database.git
+    pip install -e anta_database/
+
+# Support and contact
+
+You can email me for downloading the database: antoine.hermant@unibe.ch
+
+Feel free to raise an issue on the GitHub if you find any bug or if you would like a feature added.
+
+# Contribution
+
+If you like this database and wish to help me develop this module, do not hesitate to contact me. You should then fork the repo, build feature branches and pull request. That would be much appreciated!
+
+# Acknowledgments
+
+I am developing this tool as part of my PhD project, which is funded by the Swiss National Science Foundation (grant no. 211542, Project CHARIBDIS)
+Any data used through this database should be cited at source. For this, use the DOI provided in the metadata.
+If you used this tool for your work and this was useful, please cite this repo, so other people get to know that it exists.
+

anta_database-0.1.4/README.md

@@ -0,0 +1,65 @@
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/antoinehermant/anta_database/main/book/logo.png" width="200">
+</h1><br>
+
+[![PyPi](https://img.shields.io/pypi/v/anta_database)](https://pypi.org/project/anta_database/)
+[![Downloads](https://img.shields.io/pypi/dm/anta_database)](https://pypi.org/project/anta_database)
+
+[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/antoinehermant/anta_database/issues)
+<!-- [![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://matplotlib.org/stable/devel/index.html) -->
+
+AntADatabase is an efficient SQLite database for browsing, visualizing and processing Internal Reflecting Horizons (isochrones) across Antarctica, curated by the AntArchitecture action group. It is specifically designed for ice dynamic modelers who need a fast, memory-efficient data structure to constrain their models.
+
+Visit the [Home Page](https://antoinehermant.github.io/anta_database/intro) for more information.
+
+# SQLite Database
+
+The database uses SQLite for efficient indexing. Data is sourced from the associated DOIs and stored as binary DataFrame files for each layer (IRH) and trace ID. This structure enables:
+
+-   Browsing by author (region), layer age, or trace ID.
+-   Memory efficiency: Only relevant data is read when needed.
+-   Fast read performance: Lightweight and optimized for speed.
+
+# Key Features
+
+-   Efficient SQLite indexing
+-   Quick visualization on Antarctica map
+-   Generate lazy data for later use
+
+# Installation
+
+The Python module can be directly installed from [PyPI](https://pypi.org/project/anta-database/) with:
+
+    pip install anta_database
+
+Note that this module is new and under development, so that the [PyPI](https://pypi.org/project/anta-database/) package may not contain the latest features. For the latest version and development, see the instruction below.
+To get started with the anta_database module, see the [Documentation](https://antoinehermant.github.io/anta_database).
+Also, you need the actual data to use this module. It is currently not available on any public repository, so please contact me.
+
+## Advanced installation
+
+One can install the latest commit from this GitHub directory with:
+
+    pip install git+https://github.com/antoinehermant/anta_database.git
+
+Or for development, you should clone this repo and install the module in development mode:
+
+    git clone git@github:antoinehermant/anta_database.git
+    pip install -e anta_database/
+
+# Support and contact
+
+You can email me for downloading the database: antoine.hermant@unibe.ch
+
+Feel free to raise an issue on the GitHub if you find any bug or if you would like a feature added.
+
+# Contribution
+
+If you like this database and wish to help me develop this module, do not hesitate to contact me. You should then fork the repo, build feature branches and pull request. That would be much appreciated!
+
+# Acknowledgments
+
+I am developing this tool as part of my PhD project, which is funded by the Swiss National Science Foundation (grant no. 211542, Project CHARIBDIS)
+Any data used through this database should be cited at source. For this, use the DOI provided in the metadata.
+If you used this tool for your work and this was useful, please cite this repo, so other people get to know that it exists.
+

{anta_database-0.1.2 → anta_database-0.1.4}/anta_database/compiling/compile.py

@@ -49,8 +49,8 @@ class CompileDatabase:
         elif ext == '.csv':
             sep=','
         else:
-            print('File type not supported, exiting ...')
-            sys.exit()
+            print(f"{ext}: File type not supported...")
+            return
 
         for i, file in enumerate(raw_files):
             print('Processing', file, f'({i}/{len(raw_files)})')
@@ -96,8 +96,8 @@ class CompileDatabase:
             elif 'lon' in ds.columns and 'lat' in ds.columns and 'x' in ds.columns and 'y' in ds.columns:
                 pass
             else:
-                print('No coordinates found in the dataset, exiting ....')
-                sys.exit()
+                print('No coordinates found in the dataset')
+                return
 
             if self.file_type == 'layer':
                 age = str(ages[file_name_])
@@ -121,7 +121,11 @@ class CompileDatabase:
                         cumulative_distance = np.concatenate([[0], np.cumsum(distances)])
                         ds_trace['distance'] = cumulative_distance
 
-                    ds_trace_file = f'{dir_path}/pkl/{trace_id}/{file_name_}.pkl'
+                    if age in ['IceThk', 'BedElev', 'SurfElev']:
+                        ds_trace_file = f'{dir_path}/pkl/{trace_id}/{age}.pkl' # if var instead of age, call the file as var.pkl
+                    else:
+                        ds_trace_file = f'{dir_path}/pkl/{trace_id}/{file_name_}.pkl' # else use the same file name.pkl
+
                     os.makedirs(f'{dir_path}/pkl/{trace_id}' , exist_ok=True)
                     ds_trace.to_pickle(ds_trace_file)
                     print(ds_trace_file)
@@ -186,7 +190,10 @@ class CompileDatabase:
                         if var in ds.columns:
                             ds_IRH[var] = ds[var]
 
-                    ds_trace_file = f'{dir_path}/pkl/{trace_id}/{IRH}.pkl'
+                    if age in ['IceThk', 'BedElev', 'SurfElev']:
+                        ds_trace_file = f'{dir_path}/pkl/{trace_id}/{age}.pkl' # if var instead of age, call the file as var.pkl
+                    else:
+                        ds_trace_file = f'{dir_path}/pkl/{trace_id}/{IRH}.pkl' # else use IRH.pkl
 
                     ds_IRH.to_pickle(ds_trace_file)
                     print(ds_trace_file)

{anta_database-0.1.2 → anta_database-0.1.4}/anta_database/database/database.py

@@ -5,6 +5,7 @@ import numpy as np
 import matplotlib.pyplot as plt
 from matplotlib.colors import LinearSegmentedColormap
 import colormaps as cmaps
+from contextlib import contextmanager
 from typing import Union, List, Dict, Tuple
 
 class Database:
@@ -93,41 +94,6 @@ class Database:
         }
         return metadata
 
-    def __repr__(self):
-        """Return a pretty-printed string representation of the metadata."""
-        md = self.md
-        output = []
-        output.append("Metadata from query:")
-
-        output.append("\n  - author:")
-        for author in md['author']:
-            output.append(f"    {author}")
-
-        output.append("\n  - age:")
-        ages = " ".join(md['age'])
-        output.append(f"    {ages}")
-
-        output.append("\n  - var:")
-        for var in md['var']:
-            output.append(f"    {var}")
-
-        output.append("\n  - trace_id:")
-        trace_ids = " ".join(md['trace_id'])
-        output.append(f"    {trace_ids}")
-
-        output.append("\n  - reference:")
-        for ref in md['reference']:
-            output.append(f"    {ref}")
-
-        output.append("\n  - DOIs:")
-        for doi in md['doi']:
-            output.append(f"    {doi}")
-
-        output.append(f"\n  - database: {md['database_path']}/{md['file_db']}")
-        output.append(f"  - query params: {md['_query_params']}")
-
-        return "\n".join(output)
-
     def query(self, age: Union[None, str, List[str]]=None, var: Union[None, str, List[str]]=None,author: Union[None, str, List[str]]=None, trace_id: Union[None, str, List[str]]=None) -> 'MetadataResult':
         select_clause = 'a.name, a.citation, a.doi, d.age, d.var, d.trace_id'
         query, params = self._build_query_and_params(age, var, author, trace_id, select_clause)
@@ -189,7 +155,7 @@ class Database:
 
         return file_paths
 
-    def data_generator(self, metadata: Union[None, Dict] = None, data_dir: Union[None, str] = None, downscale_factor: Union[None, int] = None, downsample_distance: Union[None, float, int] = None):
+    def data_generator(self, metadata: Union[None, Dict, 'MetadataResult'] = None, data_dir: Union[None, str] = None, downscale_factor: Union[None, int] = None, downsample_distance: Union[None, float, int] = None):
         """
         Generates DataFrames and their associated author names from the database based on the provided metadata.
 
@@ -205,7 +171,7 @@ class Database:
             md = self.md
         else:
             print('Please provide metadata of the files you want to generate the data from. Exiting ...')
-            sys.exit()
+            return
 
         query_params = md['_query_params']
         age = query_params.get('age')
@@ -227,8 +193,8 @@ class Database:
         elif self.db_dir:
             data_dir = self.db_dir
         else:
-            print('No data dir provided, do not know where to look for data, exiting ...')
-            sys.exit()
+            print('No data dir provided, do not know where to look for data ...')
+            return
 
         for file_path, age in results:
             df = pd.read_pickle(os.path.join(data_dir, file_path))
@@ -256,9 +222,31 @@ class Database:
         )
         return custom_cmap
 
+    def is_notebook(self) -> bool:
+        from IPython import get_ipython
+        try:
+            shell = get_ipython().__class__.__name__
+            if shell == 'ZMQInteractiveShell':
+                return True   # Jupyter notebook or qtconsole
+            elif shell == 'TerminalInteractiveShell':
+                return False  # Terminal running IPython
+            else:
+                return False  # Other type (?)
+        except NameError:
+            return False      # Probably standard Python interpreter
+
+    @contextmanager
+    def plot_context(self, close=None):
+        if close is None:
+            close = not self.is_notebook()
+        try:
+            yield
+        finally:
+            if close:
+                plt.close()
 
     def plotXY(self,
-               metadata: Union[None, Dict] = None,
+               metadata: Union[None, Dict, 'MetadataResult'] = None,
                downscale_factor: Union[None, int] = None,
                title: str = '',
                xlim: tuple = (None, None),
@@ -267,13 +255,14 @@ class Database:
                latex:bool = False,
                save: Union[str, None] = None) -> None:
 
+
         if metadata:
             metadata = metadata
         elif self.md:
             metadata = self.md
         else:
-            print('Please provide metadata of the files you want to generate the data from. Exiting ...')
-            sys.exit()
+            print('Please provide metadata of the files you want to generate the data from...')
+            return
 
         cmaps = self.custom_cmap()
         authors = list(metadata['author'])
@@ -298,7 +287,7 @@ class Database:
         for author in authors:
             citation = self.query(author=author)['reference']
             plt.plot([], [], color=colors[author], label=citation)
-        plt.legend(loc='lower left')
+        plt.legend(loc='lower left', fontsize=16*scale_factor)
 
         x_extent = x1 - x0
         y_extent = y1 - y0
@@ -314,13 +303,83 @@ class Database:
         # self.scale_axes(ax, factor=1000)
         plt.title(title, fontsize=30*scale_factor)
         plt.tight_layout()
-        if save:
-            plt.savefig(save, dpi=200)
-            plt.close()
-            print('Figure saved as', save)
+
+        with self.plot_context():
+
+            if save:
+                plt.savefig(save, dpi=200)
+                print('Figure saved as', save)
+            else:
+                plt.show()
+
+    def plotXYDepth(self,
+                    metadata: Union[None, Dict, 'MetadataResult'] = None,
+                    downscale_factor: Union[None, int] = None,
+                    title: str = '',
+                    xlim: tuple = (None, None),
+                    ylim: tuple = (None, None),
+                    scale_factor: float = 1.0,
+                    latex:bool = False,
+                    cmaps = cmaps.torch_r,
+                    save: Union[str, None] = None) -> None:
+
+        if metadata:
+            metadata = metadata
+        elif self.md:
+            metadata = self.md
         else:
-            plt.show()
-            plt.close()
+            print('Please provide metadata of the files you want to generate the data from...')
+            return
+
+        if latex:
+            from matplotlib import rc
+            rc('font', **{'family': 'serif', 'serif': ['Computer Modern']})
+            rc('text', usetex=True)
+
+        fig, ax = plt.subplots(figsize=(10,6))
+        plt.plot(self.gl.x/1000, self.gl.y/1000, linewidth=1, color='k')
+        for df, md in self.data_generator(metadata, downscale_factor=downscale_factor):
+            if md['age']:
+                var = md['age']
+                label = f'{var} isochrone depth [m]'
+            elif md['var']:
+                var = md['var']
+                label = f'{var} [m]'
+            if 'var' in locals():
+                scatter = plt.scatter(df['x']/1000, df['y']/1000, c=df[var], cmap=cmaps, s=1)
+
+        x0, x1 = ax.get_xlim() if xlim == (None, None) else xlim
+        y0, y1 = ax.get_ylim() if ylim == (None, None) else ylim
+
+
+        x_extent = x1 - x0
+        y_extent = y1 - y0
+
+        aspect_ratio = y_extent / x_extent
+
+        # Set the figure size based on the aspect ratio and a scale factor
+        plt.gcf().set_size_inches(8 * scale_factor, 8 * aspect_ratio * scale_factor)
+        ax.set_xlabel('x [km]')
+        ax.set_ylabel('y [km]')
+        ax.set_xlim(*xlim)
+        ax.set_ylim(*ylim)
+        # self.scale_axes(ax, factor=1000)
+        plt.title(title, fontsize=30*scale_factor)
+
+        if 'scatter' in locals():
+            cbar = fig.colorbar(scatter, ax=ax, orientation='horizontal', pad=0.05, fraction=0.05)
+            cbar.ax.xaxis.set_ticks_position('bottom')
+            if 'label' in locals():
+                cbar.set_label(label)
+
+        plt.tight_layout()
+
+        with self.plot_context():
+            if save:
+                plt.savefig(save, dpi=200)
+                print('Figure saved as', save)
+            else:
+                plt.show()
 
 class MetadataResult:
     def __init__(self, metadata):
@@ -334,23 +393,13 @@ class MetadataResult:
         md = self._metadata
         output = []
         output.append("Metadata from query:")
-        output.append(f"\n  - author:")
-        for author in md['author']:
-            output.append(f"    {author}")
-        output.append(f"\n  - age:")
-        output.append(f"    {' '.join(md['age'])}")
-        output.append(f"\n  - var:")
-        for var in md['var']:
-            output.append(f"    {var}")
-        output.append(f"\n  - trace_id:")
-        output.append(f"    {' '.join(md['trace_id'])}")
-        output.append(f"\n  - reference:")
-        for ref in md['reference']:
-            output.append(f"    {ref}")
-        output.append(f"\n  - DOIs:")
-        for doi in md['doi']:
-            output.append(f"    {doi}")
-        output.append(f"\n  - database: {md['database_path']}/{md['file_db']}")
+        output.append(f"\n  - author: {', '.join(md['author'])}")
+        output.append(f"\n  - age: {', '.join(map(str, md['age']))}")
+        output.append(f"\n  - var: {', '.join(md['var'])}")
+        output.append(f"\n  - trace_id: {', '.join(md['trace_id'])}")
+        output.append(f"\n  - reference: {', '.join(md['reference'])}")
+        output.append(f"  - DOIs: {', '.join(md['doi'])}")
+        output.append(f"  - database: {md['database_path']}/{md['file_db']}")
         output.append(f"  - query params: {md['_query_params']}")
         return "\n".join(output)
 

anta_database-0.1.4/anta_database.egg-info/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: anta_database
+Version: 0.1.4
+Summary: SQLite database for the AntArchitecture Community Data
+Author: Antoine Hermant
+Author-email: antoine.hermant@etik.com
+License-Expression: MIT
+Project-URL: Homepage, https://antoinehermant.github.io/anta_database/intro
+Project-URL: Documentation, https://antoinehermant.github.io/anta_database/quick_start
+Project-URL: Repository, https://github.com/antoinehermant/anta_database.git
+Project-URL: Issues, https://github.com/antoinehermant/anta_database/issues
+Keywords: isochrones,database,IRH,radar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Programming Language :: Python
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: pyproj
+Requires-Dist: matplotlib
+Requires-Dist: colormaps
+Dynamic: license-file
+
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/antoinehermant/anta_database/main/book/logo.png" width="200">
+</h1><br>
+
+[![PyPi](https://img.shields.io/pypi/v/anta_database)](https://pypi.org/project/anta_database/)
+[![Downloads](https://img.shields.io/pypi/dm/anta_database)](https://pypi.org/project/anta_database)
+
+[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/antoinehermant/anta_database/issues)
+<!-- [![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://matplotlib.org/stable/devel/index.html) -->
+
+AntADatabase is an efficient SQLite database for browsing, visualizing and processing Internal Reflecting Horizons (isochrones) across Antarctica, curated by the AntArchitecture action group. It is specifically designed for ice dynamic modelers who need a fast, memory-efficient data structure to constrain their models.
+
+Visit the [Home Page](https://antoinehermant.github.io/anta_database/intro) for more information.
+
+# SQLite Database
+
+The database uses SQLite for efficient indexing. Data is sourced from the associated DOIs and stored as binary DataFrame files for each layer (IRH) and trace ID. This structure enables:
+
+-   Browsing by author (region), layer age, or trace ID.
+-   Memory efficiency: Only relevant data is read when needed.
+-   Fast read performance: Lightweight and optimized for speed.
+
+# Key Features
+
+-   Efficient SQLite indexing
+-   Quick visualization on Antarctica map
+-   Generate lazy data for later use
+
+# Installation
+
+The Python module can be directly installed from [PyPI](https://pypi.org/project/anta-database/) with:
+
+    pip install anta_database
+
+Note that this module is new and under development, so that the [PyPI](https://pypi.org/project/anta-database/) package may not contain the latest features. For the latest version and development, see the instruction below.
+To get started with the anta_database module, see the [Documentation](https://antoinehermant.github.io/anta_database).
+Also, you need the actual data to use this module. It is currently not available on any public repository, so please contact me.
+
+## Advanced installation
+
+One can install the latest commit from this GitHub directory with:
+
+    pip install git+https://github.com/antoinehermant/anta_database.git
+
+Or for development, you should clone this repo and install the module in development mode:
+
+    git clone git@github:antoinehermant/anta_database.git
+    pip install -e anta_database/
+
+# Support and contact
+
+You can email me for downloading the database: antoine.hermant@unibe.ch
+
+Feel free to raise an issue on the GitHub if you find any bug or if you would like a feature added.
+
+# Contribution
+
+If you like this database and wish to help me develop this module, do not hesitate to contact me. You should then fork the repo, build feature branches and pull request. That would be much appreciated!
+
+# Acknowledgments
+
+I am developing this tool as part of my PhD project, which is funded by the Swiss National Science Foundation (grant no. 211542, Project CHARIBDIS)
+Any data used through this database should be cited at source. For this, use the DOI provided in the metadata.
+If you used this tool for your work and this was useful, please cite this repo, so other people get to know that it exists.
+