Skip to content

SUPPORT.md

Latest commit

 

History

History
241 lines (157 loc) · 4.49 KB

SUPPORT.md

File metadata and controls

241 lines (157 loc) · 4.49 KB
Raw

Support

Thank you for your interest in the Ocean Infrastructure Intelligence Platform (OIIP).

This document explains how to get help, ask questions, report problems, and participate in project discussions.

Getting Help

If you need help using, understanding, or contributing to the project, please use the appropriate communication channel.

Questions and Discussions

For general questions, ideas, and discussions, please use:

  • GitHub Discussions
  • Project documentation
  • Existing Issues

Before creating a new discussion, please search existing topics to see if your question has already been answered.

Examples:

  • How does the OTEC scoring model work?
  • Which datasets are currently supported?
  • How is the AI Datacenter Suitability Index calculated?
  • How can I contribute oceanographic data?

Reporting Bugs

If you discover a bug, please create a GitHub Issue.

When reporting a bug, include:

  • Clear description of the problem
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Relevant logs or screenshots
  • Environment information

Example:

Operating System:
Python Version:
Database Version:
Project Version:

A well-documented bug report helps maintainers investigate and resolve issues more efficiently.

Feature Requests

Feature requests are welcome.

Before creating a request:

  • Search existing issues
  • Search discussions
  • Check the project roadmap

When proposing a feature, explain:

  • The problem being solved
  • The expected benefit
  • Possible implementation ideas

Examples:

  • New oceanographic data source
  • Additional GIS capabilities
  • New scoring methodology
  • Infrastructure analysis tools
  • AI agent functionality

Research Discussions

OIIP is both a software and research initiative.

Research-related discussions may include:

  • Oceanography
  • OTEC
  • Marine engineering
  • Climate technology
  • Offshore renewable energy
  • Maritime infrastructure
  • AI datacenter deployment

When sharing research:

  • Cite sources
  • Document assumptions
  • Explain methodology
  • Clearly distinguish facts from opinions

Documentation Improvements

Documentation contributions are highly appreciated.

You can help by:

  • Correcting errors
  • Improving explanations
  • Adding tutorials
  • Expanding technical documentation
  • Improving architecture diagrams

Documentation issues may be reported through GitHub Issues or Pull Requests.

Security Issues

Do not report security vulnerabilities through public GitHub Issues.

Please follow the process described in:

SECURITY.md

Security reports should be submitted privately to the project maintainers.

Contributing

If you would like to contribute code, documentation, datasets, or research, please read:

CONTRIBUTING.md

This document explains:

  • Development workflow
  • Coding standards
  • Contribution guidelines
  • Pull request process

Project Roadmap

To understand current priorities and planned work, see:

ROADMAP.md

The roadmap describes:

  • Current development goals
  • Planned milestones
  • Future expansion areas

Community Expectations

All participants are expected to follow:

CODE_OF_CONDUCT.md

We value:

  • Respectful communication
  • Scientific rigor
  • Open collaboration
  • Constructive feedback
  • Evidence-based discussion

Maintainer Response Expectations

As an open-source project, response times may vary depending on contributor availability.

Maintainers will make reasonable efforts to review:

  • Bug reports
  • Pull requests
  • Documentation improvements
  • Research contributions

Your patience and contributions are appreciated.

Areas Where Contributions Are Especially Welcome

We are particularly interested in contributions related to:

  • Oceanography
  • GIS and geospatial systems
  • PostGIS
  • Ocean energy
  • OTEC
  • Marine infrastructure
  • Data engineering
  • Scientific computing
  • Climate technology
  • AI agents
  • Technical documentation

Project Scope

The Ocean Infrastructure Intelligence Platform focuses on:

  • Ocean Infrastructure Intelligence
  • Ocean Thermal Energy Conversion (OTEC)
  • Offshore Renewable Energy
  • Marine Infrastructure Analytics
  • Oceanographic Data Integration
  • AI Datacenter Site Selection
  • Sustainable Ocean Development

Thank You

Every issue report, pull request, research contribution, documentation improvement, and discussion helps improve the Ocean Infrastructure Intelligence Platform.

Thank you for supporting open science, open data, and open-source ocean infrastructure intelligence.