https://github.com/silverousblack/geoseraphim

A centralized package for interfacing with geographical data.
https://github.com/silverousblack/geoseraphim

Last synced: 1 day ago
JSON representation

A centralized package for interfacing with geographical data.

• Host: GitHub
• URL: https://github.com/silverousblack/geoseraphim
• Owner: SilverousBlack
• License: mit
• Created: 2022-12-04T20:35:09.000Z (almost 2 years ago)
• Default Branch: seraph
• Last Pushed: 2022-12-21T16:26:35.000Z (almost 2 years ago)
• Last Synced: 2023-09-18T06:43:51.788Z (about 1 year ago)
• Language: Python
• Size: 38.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GeoSeraphim

> Angels descend and survey the Earth

A centralized package for interfacing with geographical data.

## GeoSeraphim is in Development!

> The following commands assume that the current working directory is the repository directory; kindly use `cd` to the path of the repository directory.

***WARING: VIRTUAL ENVIRONMENT IS RECOMMENDED*** 

This library relies on `GDAL` and `rasterio` libraries which cannot be directly installed through `pip`.

### Installing `GDAL` and `rasterio` Pre-Requisites

For ease, `GDAL` and `rasterio` can be installed through `conda` or `miniconda`.

If, however using `conda` or `miniconda` is not possible or desired, read the installation guide from `rasterio` found [here](https://rasterio.readthedocs.io/en/latest/installation.html).

### Installing Other Pre-Requisites

After which the other requirements can be installed through `pip` via the command:

* `pip install -U -r requirements.txt`; or

* `py -m pip install -U -r requirements.txt`

### Building and Installing the Library

To build the project and subsequently install the developement versions:

1. Install `build` through `pip` via the command `pip install -U build`.

2. Build the wheels for the project via the command `py -m build`.

3. Wait for the build process to finish.

4. Install the library through `pip` via the command `pip install dist/GeoSeraphim-*VERSION*-py3-none-any.whl`

### Further Reading

#### Configuration Files

Configuration files are automatically generated on the first run of GeoSeraphim; this would contain configurations for the entire system as well as recipe configurations for output files.

Customizing these files shall be made fully possible in future releases.

#### Seraphanda `.seraph` Files

This file output type is the default output type of `GeoSeraphim` and designed to contain and handle all information on a given map. Internally, a Seraphanda file contains all known information on a map in similar to a `ndarray` form, such that it can be easily plotted, rendered and converted to other types.

#### GeoCSV `.gcsv` Files

This file output type is a lightweight, easily readable table of entries of all known points in a map; it is good for retaining data integrity through multiple uses. Internally it similar to a CSV `.csv` file, which means it can be directly read by `pandas` and rendered as a `DataFrame`.