PyFVCOM2
A Python package for processing FVCOM (Finite Volume Community Ocean Model) data.
Description
PyFVCOM2 is a Python library designed to work with FVCOM model output data, providing tools for data analysis, visualization, and processing of unstructured grid ocean model results. It is intended to be the successor of PyFVCOM.
Installation
# Clone the repository
git clone <repository-url>
cd pyfvcom2
# Create a virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install in development mode
pip install -e .
Usage
import pyfvcom2
# Your code here
Development
This project follows Python best practices:
Python 3.8+ compatibility
PEP 8 style guidelines
Type hints where appropriate
Comprehensive docstrings
Unit testing with pytest
License
This project is licensed under the MIT License - see the LICENSE.txt file for details.
Contributing
The team welcome contributions to the project! These include:
Reviewling pull requests.
Creating, commenting on and resolving issues.
Preparing documentation.
Financial donations to help support the work of the core team.
If you are planning a large change to the code, please contact the team to discuss this first.