Home

Welcome to the OpenMindat Wiki

Overview

Welcome to the OpenMindat Python package Wiki! This package provides a comprehensive suite of tools for querying and retrieving mineral and geomaterial data from the Mindat API. It's designed to facilitate researchers, enthusiasts, and professionals in the field of geology and mineralogy to access a vast repository of mineral data easily.

This Wiki serves as your guide to using the OpenMindat package effectively. Below you'll find links to detailed pages for each class, along with general information on installation, usage, and support.

Getting Started

• Installation: Follow the instructions in the README to install the OpenMindat package in your Python environment.
• Basic Usage: After installation, you can import the OpenMindat package in your Python scripts using import openmindat as om. For more detailed usage instructions, refer to the Usage Examples section in the README.

Class Documentation

Detailed documentation for each class in the OpenMindat package is available on the following pages:

1. GeomaterialRetriever: A class for performing detailed queries on geomaterials.
2. MineralsIMARetriever: A class for querying mineral data based on IMA status and other parameters.
3. GeomaterialSearchRetriever: A class for searching geomaterials using specific keywords.
4. LocalitiesRetriever: A class for retrieving localities using detailed queries.
5. LocalitiesIdRetriever: A class for retrieving localities by id

Support and Contribution

• Reporting Issues: Encountered a bug or have a feature request? Please post it on our Issues page.
• Contributing: Interested in contributing to OpenMindat? Check out our Contribution Guidelines for more information.

Community

• Contact Us: If you have specific queries or need further assistance, please contact jiyinz@uidaho.edu.