From b12ebe6927f28c45422b0b3e630c3be6fe35fbc1 Mon Sep 17 00:00:00 2001 From: Archis Joglekar Date: Tue, 10 Sep 2024 10:33:32 -0700 Subject: [PATCH] Docs bug (#66) * bug * pydantic requirement * found bug --- adept/vlasov1d/datamodel.py | 2 +- docs/source/solvers/datamodels/vlasov1d.rst | 3 +++ docs/source/solvers/vlasov1d1v.rst | 4 ++-- requirements-cpu.txt | 3 ++- requirements.txt | 3 ++- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/adept/vlasov1d/datamodel.py b/adept/vlasov1d/datamodel.py index 9beb6c6..6004441 100644 --- a/adept/vlasov1d/datamodel.py +++ b/adept/vlasov1d/datamodel.py @@ -1,5 +1,5 @@ from pydantic import BaseModel -from typing import Optional, Dict, Union +from typing import Dict class SpaceProfileModel(BaseModel): diff --git a/docs/source/solvers/datamodels/vlasov1d.rst b/docs/source/solvers/datamodels/vlasov1d.rst index a4e189c..f2f909d 100644 --- a/docs/source/solvers/datamodels/vlasov1d.rst +++ b/docs/source/solvers/datamodels/vlasov1d.rst @@ -1,5 +1,8 @@ +Vlasov1D Configuration Options +============================== Each of these items is actually a dictionary. These dictionaries, once initialized, need to be compiled into a megadictionary that is passed to the solver. This is basically the contents of the ``yaml`` files that are in the repo. .. automodule:: adept.vlasov1d.datamodel :members: + diff --git a/docs/source/solvers/vlasov1d1v.rst b/docs/source/solvers/vlasov1d1v.rst index 47b1dd9..f6e739b 100644 --- a/docs/source/solvers/vlasov1d1v.rst +++ b/docs/source/solvers/vlasov1d1v.rst @@ -52,7 +52,7 @@ Collisions 3. ``daugherty`` - This solver uses the Daugherty collision operator to include collisions in the simulation. -Configuration Options +Configuration ====================== ``ADEPT`` needs a ``yaml`` file with the following datamodel to run the simulation. The datamodel is defined in the following class. @@ -64,4 +64,4 @@ Each of the objects used to initialize this datamodel are defined in the followi .. toctree:: datamodels/vlasov1d :maxdepth: 1 - :caption: Configuration Options: + :caption: Configuration Objects: diff --git a/requirements-cpu.txt b/requirements-cpu.txt index 36b3811..17131c6 100644 --- a/requirements-cpu.txt +++ b/requirements-cpu.txt @@ -16,4 +16,5 @@ pint mlflow_export_import plasmapy tabulate -interpax \ No newline at end of file +interpax +pydantic \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 8e5c5e7..53b0f07 100644 --- a/requirements.txt +++ b/requirements.txt @@ -16,4 +16,5 @@ pint mlflow_export_import plasmapy tabulate -interpax \ No newline at end of file +interpax +pydantic \ No newline at end of file