Skip to content

Commit

Permalink
Chore: pre-commit autoupdate
Browse files Browse the repository at this point in the history
  • Loading branch information
pre-commit-ci[bot] authored and DavisBroda committed Aug 22, 2024
1 parent 36ffab1 commit 2736d6a
Show file tree
Hide file tree
Showing 79 changed files with 29,666 additions and 566 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1 @@
*.sh text eol=LF
*.sh text eol=LF
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -192,4 +192,4 @@ output

src/temp*.py

demo
demo
2 changes: 1 addition & 1 deletion .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ MD013:

MD024: false

MD033: false
MD033: false
25 changes: 12 additions & 13 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ repos:
- id: check-json
- id: check-merge-conflict
- id: check-shebang-scripts-are-executable
# - id: check-symlinks
# - id: check-symlinks
- id: check-toml
# - id: detect-aws-credentials
- id: check-xml
Expand Down Expand Up @@ -79,7 +79,6 @@ repos:
"-d",
"{rules: {line-length: {max: 120}}, ignore-from-file: [.gitignore],}",
]

# - repo: https://github.com/astral-sh/ruff-pre-commit
# rev: v0.5.6
# hooks:
Expand Down Expand Up @@ -108,15 +107,15 @@ repos:
# args: ["--show-error-codes", "--install-types", "--non-interactive"]
# additional_dependencies: ["pytest", "types-requests"]

# Check for misspellings in documentation files
# - repo: https://github.com/codespell-project/codespell
# rev: v2.2.2
# hooks:
# - id: codespell
# Check for misspellings in documentation files
# - repo: https://github.com/codespell-project/codespell
# rev: v2.2.2
# hooks:
# - id: codespell

# Automatically upgrade Python syntax for newer versions
# - repo: https://github.com/asottile/pyupgrade
# rev: v3.15.0
# hooks:
# - id: pyupgrade
# args: ['--py37-plus']
# Automatically upgrade Python syntax for newer versions
# - repo: https://github.com/asottile/pyupgrade
# rev: v3.15.0
# hooks:
# - id: pyupgrade
# args: ['--py37-plus']
2 changes: 1 addition & 1 deletion LICENSES/MIT.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ 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.
SOFTWARE.
55 changes: 30 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ H3 (from Uber) cells to create a uniform mesh of regions
of varying resolutions for the globe.

Capabilities include:

- loading geospatial data
- interpolating latitude/longitude data to map into H3 cells
of varying resolution.
of varying resolution.
- managing shapefiles

The Ecosystem Platform was originally developed by Broda Group Software
with key contributions by:

- [Eric Broda](https://www.linkedin.com/in/ericbroda/)
- [Davis Broda](https://www.linkedin.com/in/davisbroda/)
- [Graeham Broda](https://www.linkedin.com/in/graeham-broda-3a2294b3/)
Expand All @@ -36,57 +38,60 @@ For more information see the [h3 website](https://h3geo.org/), or

Some environment variables are used by various code and scripts.
Set up your environment as follows (note that "source" is used)
~~~~bash

```bash
source ./bin/environment.sh
~~~~
```

It is recommended that a Python virtual environment be created.
Several convenience scripts are available to create and activate
a virtual environment.

To create a new virtual environment (it will create a directory
called "venv" in your current working directory):
~~~~bash

```bash
$PROJECT_DIR/bin/venv.sh
~~~~
```

Once your virtual enviornment has been created, it can be activated
as follows (note: you *must* activate the virtual environment
as follows (note: you _must_ activate the virtual environment
for it to be used, and the command requires "source" to ensure
environment variables to support venv are established correctly):
~~~~bash

```bash
source $PROJECT_DIR/bin/vactivate.sh
~~~~
```

Install the required libraries as follows:
~~~~bash
pip install -r requirements.txt
~~~~

```bash
pip install -r requirements.txt
```

## Getting started

For a brief overview of how to get started with this application, see
the [Getting Started Guide](/docs/getting-started.md).


## About the CLIs

To see more information about particular aspects of the geo server, see
the below documentation.

This repo offers a command language interface (CLI) to demonstrate
this functionality:
- [Geospatial](/docs/README-geospatial.md):
Query information in the Geospatial Data Mesh
- [Data Loading](/docs/README-loading.md):
Interpolate sparse data into H3 cell grid
- [Shapefile](/docs/README-shapefile.md):
Shapefile simplification, statistics, and viewing
- [Repository](/docs/README-repository.md):
Shapefile registration and inventory management
- [End-to-End Examples](/docs/README-example.md):
Examples of datasets taken from loading to visualization

- [Geospatial](/docs/README-geospatial.md):
Query information in the Geospatial Data Mesh
- [Data Loading](/docs/README-loading.md):
Interpolate sparse data into H3 cell grid
- [Shapefile](/docs/README-shapefile.md):
Shapefile simplification, statistics, and viewing
- [Repository](/docs/README-repository.md):
Shapefile registration and inventory management
- [End-to-End Examples](/docs/README-example.md):
Examples of datasets taken from loading to visualization

## Running tests

Expand All @@ -100,13 +105,13 @@ pytest ./test

Each branch should have an associated github issue. Branches should be named
as follows:
`<branch-type>/issue-<issue number>-<short description>`.
`<branch-type>/issue-<issue number>-<short description>`.
Where the branch type is one of:
[feature, bugfix, hotfix],
[feature, bugfix, hotfix],
the issue number is the number of the associated issue, and the
short description is a dash ('-') seperated description of the branch's purpose.
This to between one and three words if possibble.

## Roadmap

For information on planned features, see the [roadmap](/docs/roadmap.md)
For information on planned features, see the [roadmap](/docs/roadmap.md)
2 changes: 1 addition & 1 deletion docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ RUN pip install -r requirements.txt
# Copy the application files
COPY ./src /app/src

ENV PYTHONPATH="${PYTHONPATH}:/app/src"
ENV PYTHONPATH="${PYTHONPATH}:/app/src"
37 changes: 18 additions & 19 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,21 @@
version: '3.8'
version: "3.8"
services:

# Data Product
osc-geo-h3grid-srv:
image: ${DOCKERHUB_USERNAME}/${IMAGE_NAME}:latest
hostname: ${HOSTNAME}
# container_name: ${HOSTNAME}
ports:
# OUTSIDE:INSIDE
# curl http://localhost:${SERVER_PORT}/data
- ${PUBLIC_PORT}:${PRIVATE_PORT}
volumes:
- ${PROJECT_DIR}/config/:/app/config
- ${PROJECT_DIR}/databases:/app/databases
- ${PROJECT_DIR}/data:/app/data
networks:
- localnet
# Data Product
osc-geo-h3grid-srv:
image: ${DOCKERHUB_USERNAME}/${IMAGE_NAME}:latest
hostname: ${HOSTNAME}
# container_name: ${HOSTNAME}
ports:
# OUTSIDE:INSIDE
# curl http://localhost:${SERVER_PORT}/data
- ${PUBLIC_PORT}:${PRIVATE_PORT}
volumes:
- ${PROJECT_DIR}/config/:/app/config
- ${PROJECT_DIR}/databases:/app/databases
- ${PROJECT_DIR}/data:/app/data
networks:
- localnet

networks:
localnet:
external: true
localnet:
external: true
Loading

0 comments on commit 2736d6a

Please sign in to comment.