Initial commit

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Akhil Chhibber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,59 @@
+# EarthML - Geodata to Geohash
+
+EarthML is a Python library designed to convert geospatial datasets into a single geohash representing the smallest possible area that covers the entire dataset. It supports various formats, including `.shp`, `.geojson`, `.tif`, `.las`, `.png`, `.jpg`, and `.jpeg`.
+
+## Goal
+
+The goal of EarthML is to simplify the process of converting geospatial data into a geohash. It can handle different file formats and automatically calculate the geohash that fits the entire study area.
+
+## Features
+
+- **Support for Multiple Formats**: Easily convert geospatial data in Shapefile, GeoJSON, GeoTIFF, LAS, and image formats.
+- **Geohash Calculation**: Automatically calculates the geohash that best represents the geographical bounds of the dataset.
+- **Easy to Use**: Intuitive functions for loading and processing geospatial data.
+
+## Installation
+
+To install EarthML, you can use pip:
+
+```
+pip install earthml
+```
+
+
+
+
+
+# Usage
+
+```
+from earthml import geodata_to_geohash
+
+# Calculate geohash
+geohash = geodata_to_geohash.find_smallest_geohash('file1.shp')
+```
+
+
+
+
+
+# License
+This project is licensed under the MIT License. See the LICENSE file for details.
+
+
+
+
+
+# Author
+Akhil Chhibber
+
+
+
+
+
+
+# Note
+This README provides a brief overview of the library, explains its goal, highlights key features, and provides simple installation and usage instructions.
+
+Would you like me to make any modifications or provide additional details? Let me know how you'd like to proceed!
+

earthml/__init__.py

@@ -0,0 +1 @@
+from .geodata_to_geohash import *