Skip to content

Update documentation for neoclassical models, configuration, and registry - #2517

Open
copybara-service[bot] wants to merge 1 commit into
mainfrom
test_988565490
Open

copybara-service[bot] wants to merge 1 commit into
mainfrom
test_988565490

Conversation

@copybara-service

Copy link
Copy Markdown

Update documentation for neoclassical models, configuration, and registry

  • Document the composite analytical neoclassical model and its four
    sub-models (bootstrap_current, conductivity, transport,
    poloidal_velocity), including Redl conductivity, Angioni-Sauter +
    Shaing transport, and Kim poloidal velocity, in physics_models.rst,
    code_structure.rst, and overview.rst.
  • Document the neoclassical configuration options (model_name='analytical',
    conductivity: 'redl', transport Shaing parameters, and
    poloidal_velocity sub-config) in configuration.rst.
  • Document custom top-level neoclassical model registration
    (torax.neoclassical) in model_integration.rst.

…stry

- Document the composite `analytical` neoclassical model and its four
  sub-models (`bootstrap_current`, `conductivity`, `transport`,
  `poloidal_velocity`), including Redl conductivity, Angioni-Sauter +
  Shaing transport, and Kim poloidal velocity, in `physics_models.rst`,
  `code_structure.rst`, and `overview.rst`.
- Document the `neoclassical` configuration options (`model_name='analytical'`,
  `conductivity: 'redl'`, `transport` Shaing parameters, and
  `poloidal_velocity` sub-config) in `configuration.rst`.
- Document custom top-level neoclassical model registration
  (`torax.neoclassical`) in `model_integration.rst`.

PiperOrigin-RevId: 988565490
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant