Skip to content

Commit

Permalink
some reformatting in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierr committed Dec 18, 2024
1 parent 8050f33 commit d7c8e57
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
16 changes: 8 additions & 8 deletions Documentation/app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,17 @@ BattMoApp
###########

.. toctree::
:maxdepth: 2
:hidden:
:maxdepth: 2
:hidden:

Features <app_features>
Troubleshooting <app_troubleshooting>

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.
Accessing BattMoApp is as simple as navigating to `app.batterymodel.com <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.

Expand All @@ -39,3 +37,5 @@ It is also possible to install BattMoApp locally with Docker. On the `github <ht





11 changes: 8 additions & 3 deletions Documentation/app_troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
Troubleshooting
################

This sections gives some troubleshooting ideas.

.. toctree::
:maxdepth: 2
:hidden:

Unnatural artifacts <app_unnatural_artifacts>
Unsuccessful simulation <app_unsuccessful_simulation>

This sections gives some troubleshooting ideas.

.. grid:: 2

Expand All @@ -15,4 +20,4 @@ This sections gives some troubleshooting ideas.
.. grid-item-card::
:padding: 2

:ref:`Unsuccessful simulation <app_unsuccessful_simulation:Unsuccessful simulation>`
:ref:`Unsuccessful simulation <app_unsuccessful_simulation:Unsuccessful simulation>`

0 comments on commit d7c8e57

Please sign in to comment.