Enhancement Proposals
This page serves to index Clawpack Enhancement Proposals (CEPs) to guide Clawpack development. Developers are encouraged to author CEPs for any development in Clawpack that the community needs to discuss before code is written. Currently, our protocol for CEPs is relatively simple.
The CEP author should:
- Create a new wiki page with the title "CEP N: Title" where "N" is the next consecutive CEP number and "Title" is an appropriate title for the CEP.
- Link to that wiki page from this page.
- Create a GitHub issue for the CEP. The issue can be in the clawpack/clawpack repo or a submodule, as appropriate.
- Notify claw-dev that you have created the CEP and inform them that discussion is taking place on this issue (provide links to the CEP and issue).
- Discussion should continue until consensus is reached.
- At that point, a pull request or issue should be opened to track the actual implementation.
- The CEP wiki page should be updated with information about the discussion and implementation.
Each CEP should have a table/area at the top with the following information:
Status | Active | Accepted | Rejected | Implemented |
Author | Full Name <full.name@gmail.com> |
Created | April 6, 2013 |
Updated | April 26, 2013 |
Discussion | link to the issue where the CEP is being discussed |
Implementation | link to the PR |
The status options mean:
-
Active: The proposal is being debated
-
Accepted: The proposal has been accepted but has not yet been implemented/merged
-
Rejected: The proposal will not be implemented
-
Implemented: A pull request implementing the proposal has been merged into the master branch
-
CEP #1: Develop pointwise Riemann solvers -- Implemented
-
CEP #2: Change Output File Naming Convention -- Accepted
-
CEP #3: Add
rp_data
derived type to Riemann solver function interface -- Active -
CEP #4: Place all Riemann solvers in Fortran 90 modules -- Active
-
CEP #5: Add
geometry
to Riemann solver function interface -- Active -
CEP #6: Install all Python code to site-packages -- Implemented
-
CEP #7: Run-Time and Compile-Time Option Handling for Fortran Code -- Accepted
-
CEP #8: Create a Controller to Manage I/O for All Packages -- Active
-
CEP #9: Create pure-Python library for geometry, state, I/O, and vis outside of Clawpack -- Accepted
-
CEP #10: Parallel VisClaw -- Active