Unverified Commit 88231d5e authored by Ann Almgren's avatar Ann Almgren Committed by GitHub
Browse files

Merge pull request #8 from onlyjus/master 

Re-org docs, add images, more info, paraview section
parents 4233147d 34066a49

README.md

+34 −9
Changes for README.md: 34 added lines, 9 removed lines.
Original line number Diff line number Diff line 
# MFIX-Exa

This is the public face of the MFiX-Exa project.

This is the public face of the MFiX-Exa project, hosting the documentation,

gallery of results, etc. The website is: https://amrex-codes.github.io/MFIX-Exa/



The code for now lives at NETL; instructions for how to get access to the code

will be given below.

## Editing



This repo is designed to host the documentation, gallery of results, etc.

The documentation source is in `docs/source/` and the html source for the cover

page is in `docs/webroot/`.



## Editing

:warning: **Do not push any edits to the `gh-pages` branch** as these will be

overwritten. Instead, commit your changes to the `master` branch, and the

`gh-pages` branch will be updated automatically a few minutes later.



### Documentation



The documentation is built using

[sphinx](https://www.sphinx-doc.org/en/master/). The `docs/source/config.py`

file contains the settings for building this documentation. The documentation

can be built locally by:



1. Install sphinx:



```shell

> pip install sphinx sphinx_rtd_theme

```



2. Build the documentation:



```shell

> mkdir build

> sphinx-build -b html docs/source/ build

```



The HTML pages will now be located in the `build` directory. Open the

`index.html` with your favorite browser:



Do not push any edits to the `gh-pages` branch as these will be overwritten.

Instead, commit your changes to the `master` branch, and the `gh-pages` branch

will be updated automatially a few minutes later. The documentation source is

in `docs/source/` and the html source for the cover page is in `docs/webroot/`.

```shell

> firefox build/index.html

```



### Doxygen

docs/source/EB.rst→docs/source/EB_Chapter.rst

+1 −1
Changes for docs/source/EB_Chapter.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -13,4 +13,4 @@ refining the computational meshes near walls. 
   :maxdepth: 1

   :caption: Contents:



   EBWalls
 
   eb/EBWalls

docs/source/Fluids_Chapter.rst

+2 −2
Changes for docs/source/Fluids_Chapter.rst: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -8,5 +8,5 @@ Solving the Fluid Equations 


.. toctree::



   FluidEquations

   FluidTimeDiscretization
 
   fluids/FluidEquations

   fluids/FluidTimeDiscretization

docs/source/GettingStarted.rst

deleted100644 → 0
+0 −13
Changes for docs/source/GettingStarted.rst: 0 added lines, 13 removed lines.
Original line number Diff line number Diff line 
.. _Chap:GettingStarted:



Getting Started

===============



.. toctree::

   :maxdepth: 1



   Structure

   BuildingCMake

   BuildingGMake

   RunningTestSuite

   RegressionTesting

docs/source/GettingStarted_Chapter.rst

0 → 100644
+32 −0
Changes for docs/source/GettingStarted_Chapter.rst: 32 added lines, 0 removed lines.
Original line number Diff line number Diff line 
.. _Chap:GettingStarted:



Getting Started

===============



The MFiX-Exa source code currently lives in NETL's

`gitlab repository <https://mfix.netl.doe.gov/gitlab/exa/mfix>`_. The repository

can be cloned by using git:



.. code-block:: shell



   > git clone https://mfix.netl.doe.gov/gitlab/exa/mfix.git

   > cd mfix





.. note::



   Access to the repository is currently restricted to project members. As the

   code matures, a distribution mechanism will be developed.



Once you have obtained the source code, the following sections describe the

source code contents, compiling, running a simple simulation, and visualizing

the simulations results.



.. toctree::

   :maxdepth: 1



   Source directory overview <getting_started/Structure>

   Compiling with CMake <getting_started/BuildingCMake>

   Compiling with GMake <getting_started/BuildingGMake>

   Running your first simulation <getting_started/FirstSimulation>

   Visualizing simulation results <getting_started/Visualization>