Metadata-Version: 2.4
Name: hycore
Version: 0.76
Summary: Data organisation and mosaics for hyperspectral drillcore
Home-page: https://github.com/samthiele/hycore
Author: Sam Thiele
Author-email: sam.thiele01@gmail.com
License: GPL-2.0
Project-URL: Documentation, https://samthiele.github.io/hycore/hycore.html
Project-URL: Source, https://github.com/samthiele/hycore
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: hylite
Requires-Dist: gfit
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<h1>
  <img src="hycore-icon.png" alt="hycore icon" height="40" align="absmiddle">
  <span>Hycore</span>
</h1>

### About

`hycore` provides a flexible data structure for creating, managing and analysing hyperspectral drillcore datasets using python and [`hylite`](https://github.com/hifexplo/hylite).

It provides a python interface for managing and querying hierarchical directory structures (called "sheds") containing a directory for each drillcore and, within this, a directory for each core box. `hycore` facilitates seamless loading (and, after processing, saving) of hyperspectral images from these box directories, as well as other common tasks like building drillcore mosaics.

----

<img src="HycoreStructure.png" width="400" />
<i><p>Outline of the directory structure used by `hycore` for simply managing hyperspectral drillcore databases.</p></i>
  
----
  
### Demonstration

For an introduction into the structure of `hycore` and how to use it to create and run customised workflows, please see the `demonstration.ipynb` file. 

### Documentation

Documentation for `hycore` can be found here:

[https://samthiele.github.io/hycore/hycore.html](https://samthiele.github.io/hycore/hycore.html)


### Citation

If `hycore` has been useful for your work, please cite:

> [Thiele, S., Kirsch, M., Lorenz, S., Saffi, H., El Alami, S., Contreras Acosta, I.C., Madriz, Y., and Gloaguen, R., 2024. 
> "Maximising the value of hyperspectral drill core scanning through real-time processing and analysis", Frontiers in Earth Science doi:10.3389/feart.2024.1433662](http://dx.doi.org/10.3389/feart.2024.1433662)
