Skip to content

Commit

Permalink
Expand docs (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
tcmetzger authored Mar 27, 2024
1 parent ae1d0a1 commit a2bc909
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
16 changes: 16 additions & 0 deletions docs/source/contributor_guide/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# pyRTE-RRTMGP Roadmap

## Vision

pyRTE-RRTMGP is a Python package that provides a user-friendly interface to the algorithms implemented with the RTE-RRTMGP project.
It fits into the broader scientific Python ecosystem and is designed to be intuitive and easily extensible.

## Goals for Future Releases

- High-Level Python interface for all relevant RTE and RRTMGP functions
- Documentation for all functions, multiple usage examples
- Comprehensive test suite
- Continuous integration and deployment
- Support for Windows, macOS ARM and other platforms
- Package installable via PyPI
- Support for vertical (GPU) and horizontal (parallelization, e.g. with Dask) scaling
10 changes: 9 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Welcome to pyRTE-RRTMGP's documentation!
pyRTE-RRTMGP provides a **Python interface** to the
`RTE+RRTMGP <https://earth-system-radiation.github.io/rte-rrtmgp/>`_ Fortran software package.

This package uses [pybind11](https://github.com/pybind/pybind11) to create a Python interface to a subset of the RTE+RRTMGP functions available in Fortran.

The RTE+RRTMGP package is a set of libraries for for computing radiative fluxes
in planetary atmospheres. RTE+RRTMGP is described in a
`paper <https://doi.org/10.1029/2019MS001621>`_ in
Expand All @@ -20,11 +22,17 @@ in planetary atmospheres. RTE+RRTMGP is described in a

.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: Using pyRTE-RRTMGP:

user_guide/installation
user_guide/usage

.. toctree::
:maxdepth: 2
:caption: Contributing to pyRTE-RRTMGP:

contributor_guide/contribute
contributor_guide/roadmap



Expand Down

0 comments on commit a2bc909

Please sign in to comment.