https://github.com/pmlmodelling/pyfvcom2
https://github.com/pmlmodelling/pyfvcom2
Last synced: 26 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pmlmodelling/pyfvcom2
- Owner: pmlmodelling
- License: mit
- Created: 2025-10-20T13:10:46.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-06-10T08:33:52.000Z (26 days ago)
- Last Synced: 2026-06-10T10:16:53.489Z (26 days ago)
- Language: Python
- Size: 14.3 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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
```bash
# Clone the repository
git clone
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
```python
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](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](https://pml.ac.uk/support-us/#how) 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.