This is a test version of the OpenMindat Python package, designed to facilitate querying and retrieving data on minerals and geomaterials from the Mindat API. It provides classes for detailed queries based on various attributes like IMA status, keywords, and specific geomaterial properties.

GitHub Reposity: OpenMindat Python Package

If you do not have a Mindat API key, please refer to How to Get My Mindat API Key or Token?

foo@bar:~$ pip install openmindat

import openmindat

from openmindat import GeomaterialRetriever

gr = GeomaterialRetriever()
gr.density_min(2.0).density_max(5.0).crystal_system("Hexagonal")
gr.elements_exc("Au,Ag")
gr.saveto("/path/to/geomaterials_data")

from openmindat import MineralsIMARetriever

mir = MineralsIMARetriever()
mir.ima(1).fields("id,name,ima_formula,ima_year")
mir.saveto("/path/to/minerals_data")

from openmindat import GeomaterialSearchRetriever

gsr = GeomaterialSearchRetriever()
gsr.geomaterials_search("quartz, green, hexagonal")
gsr.save()

from openmindat import LocalitiesRetriever

lr = LocalitiesRetriever()
lr.country("France").txt("mine")
lr.save()

• GitHub Wiki: For comprehensive documentation, visit our GitHub Wiki.

• Built-in Help:

To explore detailed class and method documentation within the OpenMindat package, use Python's built-in help() function. This provides direct access to docstrings, showcasing usage examples and parameter details. Example:

from openmindat import GeomaterialRetriever

help(GeomaterialRetriever)

The help() is also available for the specific functions:

>>> from openmindat import MineralsIMARetriever

>>> help(MineralsIMARetriever.fields)

Press q to exit the help interface.

For further assistance or feedback, feel free to contact the development team at [email protected].

Apache

Jiyin Zhang

• This work is supported by NSF, Award #2126315.