README.md

pyMASCDB - An API to query MASC data.

The code in this repository provides an API to query, filter and visualize MASC data.

The folder tutorials provides code examples to explore the capabilities of the MASCDB API. The tutorials are conceived for line-by-line execution for example using the spyder GUI. They cannot be run as scripts. They provide example usage for:

• Downloading MASCDB [00_download_mascdb.py]
• Data manipulation and other MASCDB API functionalities [01_data_manipulation.py]
• Exploratory data analysis (EDA) [02_eda.py]
• Image display and processing [03_image_processing.py]

The folder examples provides a link to some jupyter notebooks with a minimal selection of functionalities, the same as the ones used in the online documentation

The folder experiments currently provides examples for:

• Latent Space Exploration with UMAP / PCA
• Snowflake clustering with Self-Organizing Maps

Installation

For a local installation, follow the below instructions.

1. Clone this repository.

   git clone https://github.com/ltelab/pymascdb.git
   cd pymascdb

2. Install the dependencies using conda:

   conda env create -f environment.yml

3. Activate the mascdb conda environment

   conda activate mascdb

4. With mascdb environment activated, install the package:

   python setup.py install

In this way, mascdb can simply be loaded, from any directory, as:

import mascdb.api
from mascdb.api import MASC_DB

ATTENTION: The code has been currently tested only under Linux-Unix systems.

Documentation sources

Documentation is available at https://pymascdb.readthedocs.io/en/latest/index.html

Data source

The data should be downloaded from Zenodo at: https://doi.org/10.5281/zenodo.5578920

References

• Manuscript

Contributors

• Jacopo Grazioli
• Gionata Ghiggi

License

The content of this repository is released under the terms of the MIT license.