Docs bug (#66)

* bug * pydantic requirement * found bug
ergodicio · Sep 10, 2024 · b12ebe6 · b12ebe6
1 parent c04d4f5
commit b12ebe6
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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
@@ -16,4 +16,5 @@ pint
 mlflow_export_import
 plasmapy
 tabulate
-interpax
+interpax
+pydantic
diff --git a/requirements.txt b/requirements.txt
@@ -16,4 +16,5 @@ pint
 mlflow_export_import
 plasmapy
 tabulate
-interpax
+interpax
+pydantic