Improvement of BattMoApp documentation

BattMoTeam · Dec 18, 2024 · 231d1a2 · 231d1a2
1 parent 7420c2e
commit 231d1a2
Show file tree

Hide file tree

Showing 9 changed files with 131 additions and 68 deletions.
diff --git a/Documentation/app.rst b/Documentation/app.rst
@@ -0,0 +1,41 @@
+
+BattMoApp
+###########
+
+.. toctree::
+ :maxdepth: 2
+ :hidden:
+
+BattMoApp is a user-friendly web application that leverages the powerful BattMo.jl simulation software to model battery cells with precision and speed. It offers a suite 
+of features designed to make battery simulations easy, intuitive, and accessible. For now it only utilizes BattMo's P2D model, but
+as BattMo.jl expands its models, BattMoApp will follow along with that development.
+
+
+
+Getting started 
+================
+
+Accessing BattMoApp is as simple as navigating to app.batterymodel.com. Once there, you'll find an intuitive interface guiding you through the simulation setup process.
+
+It is also possible to install BattMoApp locally with Docker. On the `github <https://github.com/BattMoTeam/BattMoApp>`_ page you can find detailed instructions on how to install the app using Docker.
+
+
+.. grid:: 1
+
+   .. grid-item-card::
+      :padding: 2
+
+      `Install using Docker <https://github.com/BattMoTeam/BattMoApp>`_
+
+   .. grid-item-card::
+      :padding: 2
+
+      :ref:`Features <app_features:Features>`
+
+   .. grid-item-card::
+      :padding: 2
+
+      :ref:`Troubleshooting <app_troubleshooting:Troubleshooting>`
+
+
+
diff --git a/Documentation/gui_calculations.rst → Documentation/app_calculations.rst b/Documentation/gui_calculations.rst → Documentation/app_calculations.rst
diff --git a/Documentation/app_features.rst b/Documentation/app_features.rst
@@ -0,0 +1,56 @@
+Features
+#########
+
+BattMoApp offers a multiple features designed to streamline and enhance the process of battery cell simulation. 
+Below is a detailed overview of the core features provided by BattMoApp.
+
+
+Utilize Default Materials
+--------------------------
+Kickstart your simulations using our curated library of default materials, 
+compiled from literature sources. 
+Explore the available materials on the `Materials and models <http://app.batterymodel.com/Materials_and_models>`_  page, 
+complete with references and dataset details.
+
+Customize with Your Own Materials
+----------------------------------
+Do you have specific material data from your research or literature? 
+BattMoApp allows you to input custom material parameters. 
+On the `Simulation <http://app.batterymodel.com/Simulation>`_ page, select 'User defined' from the material dropdown, 
+and input your parameters in the expanded section. 
+You can also reference default material values from the `Materials and models <http://app.batterymodel.com/Materials_and_models>`_ page.
+
+
+Visualize Your Battery Geometry
+-----------------------------------
+Curious about how your battery cell looks based on your input parameters? 
+Our geometry visualization tool on the `Simulation <http://app.batterymodel.com/Simulation>`_ page graphically represents your battery cell, 
+reflecting component thicknesses, porosities, length, and width.
+
+
+Download Input Data
+--------------------------
+After configuring your simulation parameters, download them in two formats:
+
+- JSON Linked Data Format: Structured data with metadata, adhering to `FAIR data principles <https://www.go-fair.org/fair-principles/>`_ and the `5 star open data guidelines <https://5stardata.info/en/>`_ .
+
+- BattMo JSON Input Format: Compatible with BattMo's input requirements.
+
+This feature ensures better data management and reproducibility.
+
+
+Upload Input Data
+--------------------------
+You can upload you previously downloaded input data on the `Simulation <http://app.batterymodel.com/Simulation>`_ page.
+When you do this, the parameter values on the page will automatically be adapted to your input file.
+This make it very easy to review and alter previous simulations.
+
+Visualize and Download Results
+------------------------------------
+Once your simulation is complete, delve into the results with our visualization tools. 
+Analyze performance metrics, observe trends, and download the data for further examination or reporting.
+
+Upload your previous results
+------------------------------------
+You can upload previously downloaded results and visualize them on the `Results <http://app.batterymodel.com/Results>`_ page.
+This makes it very easy to review previous results and compare them with new results.
diff --git a/Documentation/app_troubleshooting.rst b/Documentation/app_troubleshooting.rst
@@ -0,0 +1,18 @@
+Troubleshooting
+################
+
+This sections gives some troubleshooting ideas.
+
+
+
+.. grid:: 2
+
+   .. grid-item-card::
+      :padding: 2
+
+      :ref:`Unnatural artifacts in your results <app_unnatural_artifacts:Unnatural artifacts in your results>`
+
+   .. grid-item-card::
+      :padding: 2
+
+      :ref:`Unsuccessful simulation <app_unsuccessful_simulation:Unsuccessful simulation>`
diff --git a/Documentation/gui_troubleshooting.rst → Documentation/app_unnatural_artifacts.rst b/Documentation/gui_troubleshooting.rst → Documentation/app_unnatural_artifacts.rst
@@ -1,18 +1,12 @@
-===================
-Troubleshooting
-===================
-
-This sections gives some troubleshooting ideas.
-
 Unnatural artifacts in your results
-====================================
+####################################
 
 
+Discritization issues
+------------------------
+
 .. image:: img/discretization_issue_battmo_app.png
 
 A spike like this in your results indicates a discritization issue. In order to fix the issue you can increase the number of cells used in the simulation.
 As in the example, the artifact is visible in the results of the negative electrode, the number of electrode cells of the negative electrode should be increased until the issue is resolved.
-The 'number of cells' parameters can be found among the 'advanced' input parameters.
-
-.. Unsuccesful simulation
-.. ======================
+The 'number of cells' parameters can be found among the 'advanced' input parameters.
diff --git a/Documentation/app_unsuccessful_simulation.rst b/Documentation/app_unsuccessful_simulation.rst
@@ -0,0 +1,10 @@
+Unsuccessful simulation
+####################################
+Did your parameter values result in an unsuccessful simulation? See if one of the described cases below is similar to your case.
+It might help solving your problem.
+
+Using LiFePO4 datasets
+------------------------
+Do you obtain an unsuccessful simulation when using one of the default LiFePO4 datasets? 
+Make sure that you set the upper cutoff voltage (under Protocol) to a value that is realistic for a battery cell containing an LFP cathode. Try setting it 
+to 3.6 and see if it results in a successful simulation this time. 
diff --git a/Documentation/gui.rst b/Documentation/gui.rst
diff --git a/Documentation/gui_features.rst b/Documentation/gui_features.rst
diff --git a/Documentation/index.rst b/Documentation/index.rst
@@ -17,7 +17,7 @@
    Electrolyser simulation <publishedExamples/runElectrolyser>
    Protonic Membrane <publishedExamples/runProtonicMembrane>
    Gas Supply <publishedExamples/runGasSupply>
-   gui
+   app
    Computational Graph <computationalGraph/graphdoc>
    seealso
    References <bibliography>