rajuranpe / eis_toolkit

Python library for mineral prospectivity mapping

Home Page:https://eis-he.eu/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

EIS Toolkit

tests EUPL1.2 license Code style: black Imports: isort

Python library for mineral prospectivity mapping

EIS Toolkit will be a comprehensive Python library for mineral prospectivity mapping and analysis. EIS Toolkit is developed as part of EIS Horizon EU project, which aims to aid EU's efforts in the green transition by securing critical raw materials. EIS Toolkit will serve both as a standalone library that brings together and implements relevant tools for mineral prospectivity mapping and as a computational backend for EIS QGIS Plugin.

Repository status

This repository is still in development. First release is planned for autumn 2023.

Current contents include

  • implementations for most of basic preprocessing tools
  • Jupyter notebooks showing usage and functionality of some of the implemented tools
  • basic tests for implemented features
  • instructions on how to contribute to the repository

To check the implementation status of the toolkit and planned tools, visit the wiki page of EIS Toolkit.

This repository contains source code related to eis_toolkit python package, not source code of EIS QGIS Plugin.

Contributing

If you are contributing by implementing new functionalities, read the For developers section. It will guide you to set up a local development environment. If you wish to just test the installation of eis_toolkit, follow the For users section (note that the currently documented installation process is by no means final).

For general contributing guidelines, see CONTRIBUTING.

For developers

All contributing developers need git, and a copy of the repository.

git clone https://github.com/GispoCoding/eis_toolkit.git

After this you have three options for setting up your local development environment.

  1. Docker - instructions
  2. Poetry - instructions
  3. Conda - instructions

Additonal instructions

Here are some additional instructions related to the development of EIS toolkit:

For users

TBD when first release is out.

License

Licensed under the EUPL-1.2 or later.

About

Python library for mineral prospectivity mapping

https://eis-he.eu/

License:European Union Public License 1.2


Languages

Language:Jupyter Notebook 92.8%Language:Python 7.2%Language:HTML 0.0%Language:Dockerfile 0.0%