Skip to content

README.md

Latest commit

 

History

History
138 lines (88 loc) · 3.24 KB

README.md

File metadata and controls

138 lines (88 loc) · 3.24 KB

OceanOSSE

Python toolbox for performing Observing System Simulation Experiments (OSSEs) in ocean general circulation models.

CI License

-- OceanOSSE is Under Active Development --

Overview

Installation

For Users

To get started using OceanOSSE create and activate a new Python virtual environment:

  • Using miniconda or miniforge:
# Creating a virtual environment:
conda create -n env_oceanosse python=3.13
# Activate virtual environment <env_oceanosse>
conda activate env_oceanosse
  • Using venv:
# Alternatively, creating a virtual environment using -> venv:
python -m venv env_oceanosse
# Activate virtual environment <env_oceanosse>
source /path/to/env_oceanosse/bin/activate

Next, install the package into the new virtual using pip:

# Install OceanOSSE using pip:
pip install .

For Developers

Clone the repository and set up the full development environment:

git clone https://github.com/AMOCcommunity/OceanOSSE/.git
cd OceanOSSE
pixi install

All development tasks (tests, linting, formatting, docs) are available as Pixi tasks:

# Show available tasks:
pixi task list

# Run pytest unit test suite:
pixi run tests

See CONTRIBUTING.md for full details on the development workflow.

Usage

Quick Start

ocean_osse run

Examples

Documentation

Full documentation, including the API reference and tutorials, is available at:

https://amoccommunity.github.io/OceanOSSE/

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on how to set up your environment, code style expectations, and the pull request process.

To report a bug or request a feature, please open an issue.

Changelog

A full history of changes between releases is maintained in CHANGELOG.md.

Citation

If you use this software in your research, please cite it. A citation helps sustain the project and gives credit to its contributors.

Citing the software:

@software{<your-repo>,
  author    = {Last, First and Last, First},
  title     = {{<Project Name>}: <short description>},
  year      = {YYYY},
  version   = {v0.1.0},
  publisher = {Zenodo},
  doi       = {10.5281/zenodo.XXXXXXX},
  url       = {https://doi.org/10.5281/zenodo.XXXXXXX}
}

Funding and Acknowledgements

The ongoing development of OceanOSSE is funded by:

License

This project is licensed under the Apache 2.0 License — see the LICENSE file for details.